{"openapi":"3.0.1","info":{"title":"NinjaOne Public API 2.0","description":"Ninja One Public API documentation. <br><br>\nSee also: <br> \n<a href=\"https://resources.ninjarmm.com/API/Ninja+RMM+Public+API+v2.0.5+Device+Filter+Syntax.pdf\">Device Filter syntax</a><br>\n<a href=\"https://app.ninjarmm.com/apidocs-beta/core-resources/articles/webhooks/overview\">Webhooks</a>","contact":{"email":"api@ninjarmm.com"},"version":"2.0.9-draft"},"security":[{"oauth2":["monitoring","management","control"]},{"sessionKey":["monitoring","management","control"]}],"tags":[{"name":"system","description":"Core system Entities and Resources"},{"name":"organization","description":"Organizations"},{"name":"devices","description":"Devices"},{"name":"groups","description":"Groups/Search"},{"name":"queries","description":"Queries"},{"name":"management","description":"Management"},{"name":"ticketing","description":"ticketing"},{"name":"webhooks","description":"Webhook Endpoints"},{"name":"Billing","description":"Billing"},{"name":"Users","description":"Users"},{"name":"Related Items","description":"Related Items"},{"name":"Location","description":"Location"},{"name":"Backup","description":"Backup"},{"name":"Knowledge Base Articles","description":"Knowledge Base Articles"},{"name":"Organization Documents","description":"Organization Documents"},{"name":"Document Templates","description":"Document Templates"},{"name":"Checklist Templates","description":"Checklist Templates"},{"name":"Custom Fields","description":"Custom Fields"},{"name":"Organization Checklists","description":"Organization Checklists"},{"name":"Vulnerability Management","description":"Vulnerability Management"},{"name":"Node Roles","description":"Node Roles"},{"name":"Custom Tabs","description":"Custom Tabs"},{"name":"Unmanaged Devices","description":"Unmanaged Devices"},{"name":"Software Licenses","description":"Software Licenses"},{"name":"Asset Tags","description":"Asset Tags"},{"name":"Asset Relationships","description":"Asset Relationships"},{"name":"Geolocation","description":"Device Geolocation"},{"name":"ServiceNow","description":"ServiceNow"},{"name":"Manifests","description":"Manifests"}],"paths":{"/v2/contacts":{"get":{"tags":["system"],"summary":"Contact list","description":"Get all contacts","operationId":"getContacts","responses":{"200":{"description":"List of contacts","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organizationId":{"type":"integer","format":"int32"},"uid":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"jobTitle":{"type":"string"}}}}}}},"403":{"description":"Forbidden"}}},"post":{"tags":["management"],"summary":"Create a contact","description":"Create a new contact","operationId":"createContact","requestBody":{"description":"Contact creation payload","content":{"application/json":{"schema":{"required":["email"],"type":"object","properties":{"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"firstName":{"maxLength":150,"minLength":1,"type":"string","description":"First name should be between 1 and 150 characters"},"lastName":{"maxLength":150,"minLength":1,"type":"string","description":"First name should be between 1 and 150 characters"},"email":{"type":"string","description":"Email address"},"phone":{"type":"string","description":"Contact Phone number"},"jobTitle":{"maxLength":150,"type":"string","description":"Job title should be between 0 and 150 characters"},"managerUuid":{"type":"string","description":"UUID of the manager","format":"uuid"}},"description":"Create contact request payload"}}},"required":true},"responses":{"200":{"description":"Contact created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organizationId":{"type":"integer","format":"int32"},"uid":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"jobTitle":{"type":"string"}}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/v2/contact/{id}":{"get":{"tags":["system"],"summary":"Contact details","description":"Get a contact by their ID","operationId":"getContactById","parameters":[{"name":"id","in":"path","description":"Contact identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Contact details","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organizationId":{"type":"integer","format":"int32"},"uid":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"jobTitle":{"type":"string"}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Contact not found"}}},"delete":{"tags":["management"],"summary":"Delete a contact","description":"Delete a contact by their ID","operationId":"deleteContact","parameters":[{"name":"id","in":"path","description":"Contact identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Contact deleted"},"400":{"description":"Several possible validation errors"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Contact not found"}}},"patch":{"tags":["management"],"summary":"Update a contact","description":"Update a contact by their ID","operationId":"updateContact","parameters":[{"name":"id","in":"path","description":"Contact identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Contact request payload","content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"maxLength":150,"type":"string","description":"First name should be between 0 and 150 characters"},"lastName":{"maxLength":150,"type":"string","description":"Last name should be between 0 and 150 characters"},"email":{"type":"string","description":"Email address"},"jobTitle":{"maxLength":150,"type":"string","description":"Job title should be between 0 and 150 characters"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"phone":{"type":"string","description":"Phone number"}},"description":"Patch contact request payload"}}},"required":true},"responses":{"200":{"description":"Contact updated","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organizationId":{"type":"integer","format":"int32"},"uid":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"jobTitle":{"type":"string"}}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Contact not found"}}}},"/v2/noderole":{"post":{"tags":["Node Roles"],"summary":"Create node roles","description":"Create multiple node roles","operationId":"createNodeRoles","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"nodeClass":{"type":"string","description":"Node Class of the Device Role. Should match Parent Device Role's Node Class.","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleParentName":{"type":"string","description":"Name of a Device Parent that will be created in this request that will act as the Parent Device Role for this Device Role. Should be null if nodeRoleParentId is assigned."},"nodeRoleParentId":{"type":"integer","description":"Id of an already existing Device Role to create this Node Role Under. Should be null if nodeRoleParentName is assigned.","format":"int32"},"name":{"type":"string","description":"Device Role Name. Must be unique."},"description":{"type":"string","description":"Device Role Description."},"chassisType":{"type":"string","description":"Chassis Type for the Managed Device Roles that utilize it such as Workstations. Should be null if unused.","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"icon":{"type":"string","description":"Icon Name of white-listed icon to be used for Unmanaged Device Roles. Should be null for all Managed Device Roles."}}}}}}},"responses":{"200":{"description":"Returns list of created node role","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"nodeClass":{"type":"string","description":"Node Class of the Device Role. Should match Parent Device Role's Node Class.","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleParentName":{"type":"string","description":"Name of a Device Parent that will be created in this request that will act as the Parent Device Role for this Device Role. Should be null if nodeRoleParentId is assigned."},"nodeRoleParentId":{"type":"integer","description":"Id of an already existing Device Role to create this Node Role Under. Should be null if nodeRoleParentName is assigned.","format":"int32"},"name":{"type":"string","description":"Device Role Name. Must be unique."},"description":{"type":"string","description":"Device Role Description."},"chassisType":{"type":"string","description":"Chassis Type for the Managed Device Roles that utilize it such as Workstations. Should be null if unused.","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"icon":{"type":"string","description":"Icon Name of white-listed icon to be used for Unmanaged Device Roles. Should be null for all Managed Device Roles."}}}}}}}}},"patch":{"tags":["Node Roles"],"summary":"Update node roles","description":"Update multiple node roles","operationId":"updateNodeRoles","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the Device Role to update.","format":"int32"},"name":{"type":"string","description":"Device Role Name. Must be unique."},"description":{"type":"string","description":"Device Role Description"},"icon":{"type":"string","description":"Icon Name of white-listed icon to be used for Unmanaged Device Roles. Should be null for all Managed Device Roles."}}}}}}},"responses":{"200":{"description":"Returns list of created node role","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the Device Role to update.","format":"int32"},"name":{"type":"string","description":"Device Role Name. Must be unique."},"description":{"type":"string","description":"Device Role Description"},"icon":{"type":"string","description":"Icon Name of white-listed icon to be used for Unmanaged Device Roles. Should be null for all Managed Device Roles."}}}}}}}}}},"/v2/noderole/delete":{"post":{"tags":["Node Roles"],"summary":"Delete node roles","description":"Delete node roles","operationId":"deleteNodeRoles","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ids":{"type":"array","description":"Ids of the Custom Device Roles to delete. System Default Device Roles can not be deleted.","items":{"type":"integer","description":"Ids of the Custom Device Roles to delete. System Default Device Roles can not be deleted.","format":"int32"}}}}}}},"responses":{"204":{"description":"No Content"}}}},"/v2/noderole/list":{"get":{"tags":["Node Roles"],"summary":"Get all node roles","description":"Get all node roles","operationId":"getNodeRoles","parameters":[{"name":"isAssignable","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returns list of all node roles"}}}},"/v2/policies/{policy_id}/condition/custom-fields":{"get":{"tags":["management"],"summary":"Get custom fields policy conditions","description":"Get all custom fields policy conditions for specified policy","operationId":"getCustomFieldsPolicyConditions","parameters":[{"name":"policy_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition id"},"conditionName":{"type":"string","description":"Policy condition name"},"displayName":{"type":"string","description":"Policy condition display name"},"enabled":{"type":"boolean","description":"Policy condition enabled"},"severity":{"type":"string","description":"Policy condition severity","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"]},"priority":{"type":"string","description":"Policy condition priority","enum":["NONE","LOW","MEDIUM","HIGH"]},"channels":{"uniqueItems":true,"type":"array","description":"Policy condition notification channels","items":{"type":"integer","description":"Policy condition notification channels","format":"int32"}},"scripts":{"type":"array","description":"Policy condition scripts","items":{"type":"object","properties":{"scriptId":{"type":"integer","description":"Policy condition script id","format":"int32"},"runAs":{"type":"string","description":"Policy condition script runAs","enum":["SYSTEM","LOGGED_ON_USER","LOCAL_ADMIN","DOMAIN_ADMIN","PREFERRED_CREDENTIAL_MAC","PREFERRED_CREDENTIAL_LINUX"],"default":"SYSTEM"},"scriptParam":{"type":"string","description":"Policy condition script parameter"},"scriptVariables":{"maxItems":20,"minItems":0,"type":"array","description":"Policy condition script variables","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition script variable Id"},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Policy condition script variable value"}},"description":"Policy condition script variable"}}},"description":"Policy condition script"}},"notificationAction":{"type":"string","description":"Policy condition notification action","enum":["NONE","SEND"]},"notifyOnReset":{"type":"boolean","description":"Policy condition notify on reset"},"resetThreshold":{"type":"integer","description":"Policy condition reset threshold (seconds)","format":"int32"},"inheritance":{"type":"object","properties":{"inherited":{"type":"boolean","description":"Is policy condition inherited"},"overridden":{"type":"boolean","description":"Is policy condition overridden"},"sourcePolicyId":{"type":"integer","description":"Id of the policy where the value originates; may be an ancestor above the immediate parent","format":"int32"}},"description":"Policy condition inheritance status"},"matchAll":{"type":"array","description":"Custom field value must meet all conditions","items":{"required":["fieldName","operator","value"],"type":"object","properties":{"fieldName":{"maxLength":250,"minLength":0,"type":"string","description":"Custom field name"},"operator":{"type":"string","description":"Custom field operator","enum":["EQUALS","NOT_EQUALS","LESS_THAN","LESS_OR_EQUAL_THAN","GREATER_THAN","GREATER_OR_EQUAL_THAN","IS_NOT_NULL","CONTAINS","CONTAINS_NONE","CONTAINS_ANY"]},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Custom field value"}},"description":"Policy condition custom field"}},"matchAny":{"type":"array","description":"Custom field value must meet any conditions","items":{"required":["fieldName","operator","value"],"type":"object","properties":{"fieldName":{"maxLength":250,"minLength":0,"type":"string","description":"Custom field name"},"operator":{"type":"string","description":"Custom field operator","enum":["EQUALS","NOT_EQUALS","LESS_THAN","LESS_OR_EQUAL_THAN","GREATER_THAN","GREATER_OR_EQUAL_THAN","IS_NOT_NULL","CONTAINS","CONTAINS_NONE","CONTAINS_ANY"]},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Custom field value"}},"description":"Policy condition custom field"}}},"description":"Custom fields policy condition response payload"}}}}}}},"post":{"tags":["management"],"summary":"Create custom fields policy condition","description":"Creates custom fields policy condition for specified policy","operationId":"createCustomFieldsPolicyCondition","parameters":[{"name":"policy_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Policy condition enabled","default":true},"displayName":{"maxLength":255,"minLength":0,"type":"string","description":"Policy condition display name"},"severity":{"type":"string","description":"Policy condition severity","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"],"default":"NONE"},"priority":{"type":"string","description":"Policy condition priority","enum":["NONE","LOW","MEDIUM","HIGH"],"default":"NONE"},"channels":{"maxItems":20,"minItems":0,"uniqueItems":true,"type":"array","description":"Policy condition notification channels","items":{"type":"integer","description":"Policy condition notification channels","format":"int32"}},"scripts":{"maxItems":20,"minItems":0,"type":"array","description":"Policy condition scripts","items":{"type":"object","properties":{"scriptId":{"type":"integer","description":"Policy condition script id","format":"int32"},"runAs":{"type":"string","description":"Policy condition script runAs","enum":["SYSTEM","LOGGED_ON_USER","LOCAL_ADMIN","DOMAIN_ADMIN","PREFERRED_CREDENTIAL_MAC","PREFERRED_CREDENTIAL_LINUX"],"default":"SYSTEM"},"scriptParam":{"type":"string","description":"Policy condition script parameter"},"scriptVariables":{"maxItems":20,"minItems":0,"type":"array","description":"Policy condition script variables","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition script variable Id"},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Policy condition script variable value"}},"description":"Policy condition script variable"}}},"description":"Policy condition script"}},"notificationAction":{"type":"string","description":"Policy condition notification action","enum":["NONE","SEND"],"default":"NONE"},"notifyOnReset":{"type":"boolean","description":"Policy condition notify on reset","default":false},"resetThreshold":{"type":"integer","description":"Policy condition reset threshold (seconds)","format":"int32","default":14400},"matchAll":{"maxItems":10,"minItems":0,"type":"array","description":"Custom field value must meet all conditions","items":{"required":["fieldName","operator","value"],"type":"object","properties":{"fieldName":{"maxLength":250,"minLength":0,"type":"string","description":"Custom field name"},"operator":{"type":"string","description":"Custom field operator","enum":["EQUALS","NOT_EQUALS","LESS_THAN","LESS_OR_EQUAL_THAN","GREATER_THAN","GREATER_OR_EQUAL_THAN","IS_NOT_NULL","CONTAINS","CONTAINS_NONE","CONTAINS_ANY"]},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Custom field value"}},"description":"Policy condition custom field"}},"matchAny":{"maxItems":10,"minItems":0,"type":"array","description":"Custom field value must meet any conditions","items":{"required":["fieldName","operator","value"],"type":"object","properties":{"fieldName":{"maxLength":250,"minLength":0,"type":"string","description":"Custom field name"},"operator":{"type":"string","description":"Custom field operator","enum":["EQUALS","NOT_EQUALS","LESS_THAN","LESS_OR_EQUAL_THAN","GREATER_THAN","GREATER_OR_EQUAL_THAN","IS_NOT_NULL","CONTAINS","CONTAINS_NONE","CONTAINS_ANY"]},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Custom field value"}},"description":"Policy condition custom field"}}},"description":"Custom fields policy condition create request payload"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition id"},"conditionName":{"type":"string","description":"Policy condition name"},"displayName":{"type":"string","description":"Policy condition display name"},"enabled":{"type":"boolean","description":"Policy condition enabled"},"severity":{"type":"string","description":"Policy condition severity","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"]},"priority":{"type":"string","description":"Policy condition priority","enum":["NONE","LOW","MEDIUM","HIGH"]},"channels":{"uniqueItems":true,"type":"array","description":"Policy condition notification channels","items":{"type":"integer","description":"Policy condition notification channels","format":"int32"}},"scripts":{"type":"array","description":"Policy condition scripts","items":{"type":"object","properties":{"scriptId":{"type":"integer","description":"Policy condition script id","format":"int32"},"runAs":{"type":"string","description":"Policy condition script runAs","enum":["SYSTEM","LOGGED_ON_USER","LOCAL_ADMIN","DOMAIN_ADMIN","PREFERRED_CREDENTIAL_MAC","PREFERRED_CREDENTIAL_LINUX"],"default":"SYSTEM"},"scriptParam":{"type":"string","description":"Policy condition script parameter"},"scriptVariables":{"maxItems":20,"minItems":0,"type":"array","description":"Policy condition script variables","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition script variable Id"},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Policy condition script variable value"}},"description":"Policy condition script variable"}}},"description":"Policy condition script"}},"notificationAction":{"type":"string","description":"Policy condition notification action","enum":["NONE","SEND"]},"notifyOnReset":{"type":"boolean","description":"Policy condition notify on reset"},"resetThreshold":{"type":"integer","description":"Policy condition reset threshold (seconds)","format":"int32"},"inheritance":{"type":"object","properties":{"inherited":{"type":"boolean","description":"Is policy condition inherited"},"overridden":{"type":"boolean","description":"Is policy condition overridden"},"sourcePolicyId":{"type":"integer","description":"Id of the policy where the value originates; may be an ancestor above the immediate parent","format":"int32"}},"description":"Policy condition inheritance status"},"matchAll":{"type":"array","description":"Custom field value must meet all conditions","items":{"required":["fieldName","operator","value"],"type":"object","properties":{"fieldName":{"maxLength":250,"minLength":0,"type":"string","description":"Custom field name"},"operator":{"type":"string","description":"Custom field operator","enum":["EQUALS","NOT_EQUALS","LESS_THAN","LESS_OR_EQUAL_THAN","GREATER_THAN","GREATER_OR_EQUAL_THAN","IS_NOT_NULL","CONTAINS","CONTAINS_NONE","CONTAINS_ANY"]},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Custom field value"}},"description":"Policy condition custom field"}},"matchAny":{"type":"array","description":"Custom field value must meet any conditions","items":{"required":["fieldName","operator","value"],"type":"object","properties":{"fieldName":{"maxLength":250,"minLength":0,"type":"string","description":"Custom field name"},"operator":{"type":"string","description":"Custom field operator","enum":["EQUALS","NOT_EQUALS","LESS_THAN","LESS_OR_EQUAL_THAN","GREATER_THAN","GREATER_OR_EQUAL_THAN","IS_NOT_NULL","CONTAINS","CONTAINS_NONE","CONTAINS_ANY"]},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Custom field value"}},"description":"Policy condition custom field"}}},"description":"Custom fields policy condition response payload"}}}}}}},"/v2/policies/{policy_id}/condition/windows-event":{"get":{"tags":["management"],"summary":"Get windows event conditions","description":"Get all windows event conditions for specified policy","operationId":"getWindowsEventPolicyConditions","parameters":[{"name":"policy_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition id"},"conditionName":{"type":"string","description":"Policy condition name"},"displayName":{"type":"string","description":"Policy condition display name"},"enabled":{"type":"boolean","description":"Policy condition enabled"},"severity":{"type":"string","description":"Policy condition severity","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"]},"priority":{"type":"string","description":"Policy condition priority","enum":["NONE","LOW","MEDIUM","HIGH"]},"channels":{"uniqueItems":true,"type":"array","description":"Policy condition notification channels","items":{"type":"integer","description":"Policy condition notification channels","format":"int32"}},"scripts":{"type":"array","description":"Policy condition scripts","items":{"type":"object","properties":{"scriptId":{"type":"integer","description":"Policy condition script id","format":"int32"},"runAs":{"type":"string","description":"Policy condition script runAs","enum":["SYSTEM","LOGGED_ON_USER","LOCAL_ADMIN","DOMAIN_ADMIN","PREFERRED_CREDENTIAL_MAC","PREFERRED_CREDENTIAL_LINUX"],"default":"SYSTEM"},"scriptParam":{"type":"string","description":"Policy condition script parameter"},"scriptVariables":{"maxItems":20,"minItems":0,"type":"array","description":"Policy condition script variables","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition script variable Id"},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Policy condition script variable value"}},"description":"Policy condition script variable"}}},"description":"Policy condition script"}},"notificationAction":{"type":"string","description":"Policy condition notification action","enum":["NONE","SEND"]},"notifyOnReset":{"type":"boolean","description":"Policy condition notify on reset"},"resetThreshold":{"type":"integer","description":"Policy condition reset threshold (seconds)","format":"int32"},"inheritance":{"type":"object","properties":{"inherited":{"type":"boolean","description":"Is policy condition inherited"},"overridden":{"type":"boolean","description":"Is policy condition overridden"},"sourcePolicyId":{"type":"integer","description":"Id of the policy where the value originates; may be an ancestor above the immediate parent","format":"int32"}},"description":"Policy condition inheritance status"},"source":{"type":"string","description":"Event Source"},"eventIds":{"uniqueItems":true,"type":"array","description":"Event IDs","items":{"type":"integer","description":"Event IDs","format":"int32"}},"text":{"type":"object","properties":{"values":{"maxItems":20,"minItems":0,"uniqueItems":true,"type":"array","description":"Text values","items":{"type":"string","description":"Text values"}},"condition":{"type":"string","description":"Text condition","enum":["CONTAINS","NOT_CONTAINS"],"default":"CONTAINS"},"include":{"type":"string","description":"Text include","enum":["ALL","ANY"],"default":"ALL"}},"description":"Windows event policy condition text"},"occurrence":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Occurrence enabled","default":false},"threshold":{"type":"integer","description":"Occurrence threshold","format":"int32","default":2},"duration":{"type":"integer","description":"Occurrence duration","format":"int32","default":5}},"description":"Windows event policy condition occurrence"}},"description":"Windows event policy condition response payload"}}}}}}},"post":{"tags":["management"],"summary":"Create windows event condition","description":"Creates windows event condition for specified policy","operationId":"createWindowsEventPolicyCondition","parameters":[{"name":"policy_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["eventIds","source"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Policy condition enabled","default":true},"displayName":{"maxLength":255,"minLength":0,"type":"string","description":"Policy condition display name"},"severity":{"type":"string","description":"Policy condition severity","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"],"default":"NONE"},"priority":{"type":"string","description":"Policy condition priority","enum":["NONE","LOW","MEDIUM","HIGH"],"default":"NONE"},"channels":{"maxItems":20,"minItems":0,"uniqueItems":true,"type":"array","description":"Policy condition notification channels","items":{"type":"integer","description":"Policy condition notification channels","format":"int32"}},"scripts":{"maxItems":20,"minItems":0,"type":"array","description":"Policy condition scripts","items":{"type":"object","properties":{"scriptId":{"type":"integer","description":"Policy condition script id","format":"int32"},"runAs":{"type":"string","description":"Policy condition script runAs","enum":["SYSTEM","LOGGED_ON_USER","LOCAL_ADMIN","DOMAIN_ADMIN","PREFERRED_CREDENTIAL_MAC","PREFERRED_CREDENTIAL_LINUX"],"default":"SYSTEM"},"scriptParam":{"type":"string","description":"Policy condition script parameter"},"scriptVariables":{"maxItems":20,"minItems":0,"type":"array","description":"Policy condition script variables","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition script variable Id"},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Policy condition script variable value"}},"description":"Policy condition script variable"}}},"description":"Policy condition script"}},"notificationAction":{"type":"string","description":"Policy condition notification action","enum":["NONE","SEND"],"default":"NONE"},"notifyOnReset":{"type":"boolean","description":"Policy condition notify on reset","default":false},"resetThreshold":{"type":"integer","description":"Policy condition reset threshold (seconds)","format":"int32","default":14400},"source":{"maxLength":255,"minLength":0,"type":"string","description":"Event Source"},"eventIds":{"maxItems":20,"minItems":0,"uniqueItems":true,"type":"array","description":"Event IDs","items":{"type":"integer","description":"Event IDs","format":"int32"}},"text":{"type":"object","properties":{"values":{"maxItems":20,"minItems":0,"uniqueItems":true,"type":"array","description":"Text values","items":{"type":"string","description":"Text values"}},"condition":{"type":"string","description":"Text condition","enum":["CONTAINS","NOT_CONTAINS"],"default":"CONTAINS"},"include":{"type":"string","description":"Text include","enum":["ALL","ANY"],"default":"ALL"}},"description":"Windows event policy condition text"},"occurrence":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Occurrence enabled","default":false},"threshold":{"type":"integer","description":"Occurrence threshold","format":"int32","default":2},"duration":{"type":"integer","description":"Occurrence duration","format":"int32","default":5}},"description":"Windows event policy condition occurrence"}},"description":"Windows event policy condition create request payload"}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition id"},"conditionName":{"type":"string","description":"Policy condition name"},"displayName":{"type":"string","description":"Policy condition display name"},"enabled":{"type":"boolean","description":"Policy condition enabled"},"severity":{"type":"string","description":"Policy condition severity","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"]},"priority":{"type":"string","description":"Policy condition priority","enum":["NONE","LOW","MEDIUM","HIGH"]},"channels":{"uniqueItems":true,"type":"array","description":"Policy condition notification channels","items":{"type":"integer","description":"Policy condition notification channels","format":"int32"}},"scripts":{"type":"array","description":"Policy condition scripts","items":{"type":"object","properties":{"scriptId":{"type":"integer","description":"Policy condition script id","format":"int32"},"runAs":{"type":"string","description":"Policy condition script runAs","enum":["SYSTEM","LOGGED_ON_USER","LOCAL_ADMIN","DOMAIN_ADMIN","PREFERRED_CREDENTIAL_MAC","PREFERRED_CREDENTIAL_LINUX"],"default":"SYSTEM"},"scriptParam":{"type":"string","description":"Policy condition script parameter"},"scriptVariables":{"maxItems":20,"minItems":0,"type":"array","description":"Policy condition script variables","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition script variable Id"},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Policy condition script variable value"}},"description":"Policy condition script variable"}}},"description":"Policy condition script"}},"notificationAction":{"type":"string","description":"Policy condition notification action","enum":["NONE","SEND"]},"notifyOnReset":{"type":"boolean","description":"Policy condition notify on reset"},"resetThreshold":{"type":"integer","description":"Policy condition reset threshold (seconds)","format":"int32"},"inheritance":{"type":"object","properties":{"inherited":{"type":"boolean","description":"Is policy condition inherited"},"overridden":{"type":"boolean","description":"Is policy condition overridden"},"sourcePolicyId":{"type":"integer","description":"Id of the policy where the value originates; may be an ancestor above the immediate parent","format":"int32"}},"description":"Policy condition inheritance status"},"source":{"type":"string","description":"Event Source"},"eventIds":{"uniqueItems":true,"type":"array","description":"Event IDs","items":{"type":"integer","description":"Event IDs","format":"int32"}},"text":{"type":"object","properties":{"values":{"maxItems":20,"minItems":0,"uniqueItems":true,"type":"array","description":"Text values","items":{"type":"string","description":"Text values"}},"condition":{"type":"string","description":"Text condition","enum":["CONTAINS","NOT_CONTAINS"],"default":"CONTAINS"},"include":{"type":"string","description":"Text include","enum":["ALL","ANY"],"default":"ALL"}},"description":"Windows event policy condition text"},"occurrence":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Occurrence enabled","default":false},"threshold":{"type":"integer","description":"Occurrence threshold","format":"int32","default":2},"duration":{"type":"integer","description":"Occurrence duration","format":"int32","default":5}},"description":"Windows event policy condition occurrence"}},"description":"Windows event policy condition response payload"}}}}}}},"/v2/policies/{policy_id}/condition/{condition_id}":{"delete":{"tags":["management"],"summary":"Delete policy condition","description":"Deletes specified policy condition from specified agent policy","operationId":"deletePolicyCondition","parameters":[{"name":"policy_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"condition_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/v2/policies/{policy_id}/condition/custom-fields/{condition_id}":{"get":{"tags":["management"],"summary":"Get custom fields policy condition","description":"Get specified custom fields condition for specified policy","operationId":"getCustomFieldsPolicyCondition","parameters":[{"name":"policy_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"condition_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition id"},"conditionName":{"type":"string","description":"Policy condition name"},"displayName":{"type":"string","description":"Policy condition display name"},"enabled":{"type":"boolean","description":"Policy condition enabled"},"severity":{"type":"string","description":"Policy condition severity","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"]},"priority":{"type":"string","description":"Policy condition priority","enum":["NONE","LOW","MEDIUM","HIGH"]},"channels":{"uniqueItems":true,"type":"array","description":"Policy condition notification channels","items":{"type":"integer","description":"Policy condition notification channels","format":"int32"}},"scripts":{"type":"array","description":"Policy condition scripts","items":{"type":"object","properties":{"scriptId":{"type":"integer","description":"Policy condition script id","format":"int32"},"runAs":{"type":"string","description":"Policy condition script runAs","enum":["SYSTEM","LOGGED_ON_USER","LOCAL_ADMIN","DOMAIN_ADMIN","PREFERRED_CREDENTIAL_MAC","PREFERRED_CREDENTIAL_LINUX"],"default":"SYSTEM"},"scriptParam":{"type":"string","description":"Policy condition script parameter"},"scriptVariables":{"maxItems":20,"minItems":0,"type":"array","description":"Policy condition script variables","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition script variable Id"},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Policy condition script variable value"}},"description":"Policy condition script variable"}}},"description":"Policy condition script"}},"notificationAction":{"type":"string","description":"Policy condition notification action","enum":["NONE","SEND"]},"notifyOnReset":{"type":"boolean","description":"Policy condition notify on reset"},"resetThreshold":{"type":"integer","description":"Policy condition reset threshold (seconds)","format":"int32"},"inheritance":{"type":"object","properties":{"inherited":{"type":"boolean","description":"Is policy condition inherited"},"overridden":{"type":"boolean","description":"Is policy condition overridden"},"sourcePolicyId":{"type":"integer","description":"Id of the policy where the value originates; may be an ancestor above the immediate parent","format":"int32"}},"description":"Policy condition inheritance status"},"matchAll":{"type":"array","description":"Custom field value must meet all conditions","items":{"required":["fieldName","operator","value"],"type":"object","properties":{"fieldName":{"maxLength":250,"minLength":0,"type":"string","description":"Custom field name"},"operator":{"type":"string","description":"Custom field operator","enum":["EQUALS","NOT_EQUALS","LESS_THAN","LESS_OR_EQUAL_THAN","GREATER_THAN","GREATER_OR_EQUAL_THAN","IS_NOT_NULL","CONTAINS","CONTAINS_NONE","CONTAINS_ANY"]},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Custom field value"}},"description":"Policy condition custom field"}},"matchAny":{"type":"array","description":"Custom field value must meet any conditions","items":{"required":["fieldName","operator","value"],"type":"object","properties":{"fieldName":{"maxLength":250,"minLength":0,"type":"string","description":"Custom field name"},"operator":{"type":"string","description":"Custom field operator","enum":["EQUALS","NOT_EQUALS","LESS_THAN","LESS_OR_EQUAL_THAN","GREATER_THAN","GREATER_OR_EQUAL_THAN","IS_NOT_NULL","CONTAINS","CONTAINS_NONE","CONTAINS_ANY"]},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Custom field value"}},"description":"Policy condition custom field"}}},"description":"Custom fields policy condition response payload"}}}}}}},"/v2/policies/{policy_id}/condition/windows-event/{condition_id}":{"get":{"tags":["management"],"summary":"Get windows event condition","description":"Get specified windows event condition for specified policy","operationId":"getWindowsEventPolicyCondition","parameters":[{"name":"policy_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"condition_id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition id"},"conditionName":{"type":"string","description":"Policy condition name"},"displayName":{"type":"string","description":"Policy condition display name"},"enabled":{"type":"boolean","description":"Policy condition enabled"},"severity":{"type":"string","description":"Policy condition severity","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"]},"priority":{"type":"string","description":"Policy condition priority","enum":["NONE","LOW","MEDIUM","HIGH"]},"channels":{"uniqueItems":true,"type":"array","description":"Policy condition notification channels","items":{"type":"integer","description":"Policy condition notification channels","format":"int32"}},"scripts":{"type":"array","description":"Policy condition scripts","items":{"type":"object","properties":{"scriptId":{"type":"integer","description":"Policy condition script id","format":"int32"},"runAs":{"type":"string","description":"Policy condition script runAs","enum":["SYSTEM","LOGGED_ON_USER","LOCAL_ADMIN","DOMAIN_ADMIN","PREFERRED_CREDENTIAL_MAC","PREFERRED_CREDENTIAL_LINUX"],"default":"SYSTEM"},"scriptParam":{"type":"string","description":"Policy condition script parameter"},"scriptVariables":{"maxItems":20,"minItems":0,"type":"array","description":"Policy condition script variables","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition script variable Id"},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Policy condition script variable value"}},"description":"Policy condition script variable"}}},"description":"Policy condition script"}},"notificationAction":{"type":"string","description":"Policy condition notification action","enum":["NONE","SEND"]},"notifyOnReset":{"type":"boolean","description":"Policy condition notify on reset"},"resetThreshold":{"type":"integer","description":"Policy condition reset threshold (seconds)","format":"int32"},"inheritance":{"type":"object","properties":{"inherited":{"type":"boolean","description":"Is policy condition inherited"},"overridden":{"type":"boolean","description":"Is policy condition overridden"},"sourcePolicyId":{"type":"integer","description":"Id of the policy where the value originates; may be an ancestor above the immediate parent","format":"int32"}},"description":"Policy condition inheritance status"},"source":{"type":"string","description":"Event Source"},"eventIds":{"uniqueItems":true,"type":"array","description":"Event IDs","items":{"type":"integer","description":"Event IDs","format":"int32"}},"text":{"type":"object","properties":{"values":{"maxItems":20,"minItems":0,"uniqueItems":true,"type":"array","description":"Text values","items":{"type":"string","description":"Text values"}},"condition":{"type":"string","description":"Text condition","enum":["CONTAINS","NOT_CONTAINS"],"default":"CONTAINS"},"include":{"type":"string","description":"Text include","enum":["ALL","ANY"],"default":"ALL"}},"description":"Windows event policy condition text"},"occurrence":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Occurrence enabled","default":false},"threshold":{"type":"integer","description":"Occurrence threshold","format":"int32","default":2},"duration":{"type":"integer","description":"Occurrence duration","format":"int32","default":5}},"description":"Windows event policy condition occurrence"}},"description":"Windows event policy condition response payload"}}}}}}},"/v2/webhook":{"put":{"tags":["webhooks"],"summary":"Update API Webhook configuration","description":"Creates or updates Webhook configuration for current application/client","operationId":"configureWebhook","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Callback (WebHook) URL for activity notifications"},"activities":{"type":"object","additionalProperties":{"type":"array","description":"Activity filter","items":{"type":"string","description":"Activity filter"}},"description":"Activity filter"},"expand":{"type":"array","description":"Which references to expand in payloads","items":{"type":"string","description":"Which references to expand in payloads"}},"headers":{"type":"array","description":"Custom HTTP Headers (i.e. Authorization)","items":{"type":"object","properties":{"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}},"description":"Custom HTTP Headers (i.e. Authorization)"}},"organizationIds":{"uniqueItems":true,"type":"array","description":"List of organization id to be filtered","items":{"type":"integer","description":"List of organization id to be filtered","format":"int32"}}}}}}},"responses":{"204":{"description":"No Content"},"403":{"description":"Only system administrators can configure webhooks"}}},"delete":{"tags":["webhooks"],"summary":"Remove Webhook API channel","description":"Disables Webhook configuration for current application/client","operationId":"disableWebhook","responses":{"204":{"description":"No Content"},"403":{"description":"Different PSA is already configured"},"500":{"description":"Failed to disable PSA"}}}},"/v2/organizations":{"get":{"tags":["system"],"summary":"List organizations","description":"Returns list of organizations (Brief mode)","operationId":"getOrganizations","parameters":[{"name":"pageSize","in":"query","description":"Limit number of organizations to return","schema":{"type":"integer","format":"int32"}},{"name":"after","in":"query","description":"Last Organization Identifier from previous page","schema":{"type":"integer","format":"int32"}},{"name":"of","in":"query","description":"Organization filter","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"}}}}}}},"post":{"tags":["management"],"summary":"Create new organization","description":"Creates new organization with optional list of locations and policy mappings.\nTemplate organization ID can be specified to copy various settings","operationId":"createOrganization","parameters":[{"name":"templateOrganizationId","in":"query","schema":{"type":"integer","description":"Model/Template organization to copy settings from","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"locations":{"type":"array","description":"List of locations","items":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"}}}},"policies":{"type":"array","description":"Node role policy assignments","items":{"type":"object","properties":{"nodeRoleId":{"type":"integer","description":"Node Role Identifier","format":"int32"},"policyId":{"type":"integer","description":"Policy Identifier","format":"int32"}},"description":"Node role policy assignments"}}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"},"locations":{"type":"array","description":"List of locations","items":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"}},"policies":{"type":"array","description":"Node role policy assignments","items":{"type":"object","properties":{"nodeRoleId":{"type":"integer","description":"Node Role Identifier","format":"int32"},"policyId":{"type":"integer","description":"Policy Identifier","format":"int32"}},"description":"Node role policy assignments"}},"settings":{"type":"object","properties":{"trayicon":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"splashtop":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"teamviewer":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"backup":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"psa":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"}},"description":"Organization settings"}}}}}}}}},"/v2/devices/approval/{mode}":{"post":{"tags":["management"],"summary":"Approve/Reject devices","description":"Approve or reject devices that are waiting for approval","operationId":"nodeApprovalOperation","parameters":[{"name":"mode","in":"path","required":true,"schema":{"type":"string","description":"Approval action to perform","enum":["APPROVE","REJECT"]}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"devices":{"type":"array","items":{"type":"integer","format":"int32"}}}}}}},"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/v2/alert/{uid}":{"delete":{"tags":["management"],"summary":"Reset alert/condition","description":"Resets alert/condition by UID","operationId":"resetAlert","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/v2/alert/{uid}/reset":{"post":{"tags":["management"],"summary":"Reset alert/condition and provide custom data for activity","description":"Resets alert/condition by UID","operationId":"resetAlertSetActivityData","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/v2/attachments/temp/upload":{"post":{"tags":["Knowledge Base Articles"],"summary":"Upload temporary attachments","description":"Upload temporary attachment","operationId":"uploadTempAttachments","parameters":[{"name":"entityType","in":"query","schema":{"type":"string","enum":["TICKET","NODE","DOCUMENT","KB_DOCUMENT","RELATED_ITEM","CHECKLIST","AUTOMATION","LOCATION","ORGANIZATION","TRIGGER","TECHNICIAN","FILE_TRANSFER_AUTOMATION","END_USER","EMAIL_TEMPLATE","POLICY","APPROVAL_INSTANCE","NINJA_BILLING_INVOICE","ANDROID_LIBRARY_APK","GLOBAL_CUSTOM_FIELD"]}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"files":{"type":"array","items":{"type":"object","properties":{"contentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"}}},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"}}},"messageBodyWorkers":{"type":"object"},"parent":{"type":"object","properties":{"contentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"}}},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"}}},"messageBodyWorkers":{"type":"object"},"parent":{"$ref":"#/components/schemas/MultiPart"},"providers":{"type":"object"},"bodyParts":{"type":"array","items":{"$ref":"#/components/schemas/BodyPart"}},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}}}}}}}},"providers":{"type":"object"},"formDataContentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"simple":{"type":"boolean"},"name":{"type":"string"},"value":{"type":"string"},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}}}}}}}}}}}}}},"responses":{"200":{"description":"Returns a list of uploaded attachments metadata","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"name"},"mimeType":{"type":"string","description":"Mime type"},"size":{"type":"string","description":"Size in bytes"},"extension":{"type":"string","description":"File extension"},"contentId":{"type":"string","description":"Content identifier"}}}}}}},"422":{"description":"An unsupported attachment entity type was used"}}}},"/v2/checklist/archive":{"post":{"tags":["Checklist Templates"],"summary":"Archive a checklist template","description":"Archive a checklist template by id","operationId":"archiveChecklistTemplate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"checklistTemplateIds":{"type":"array","items":{"type":"integer","format":"int32"}}}}}}},"responses":{"200":{"description":"Returns a list of archive checklist templates","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Checklist template name (must be unique)"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"tasks":{"type":"array","description":"Checklist template tasks","items":{"type":"object","properties":{"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"}},"description":"Checklist template tasks"}},"required":{"type":"boolean","description":"Indicates if the checklist completion is required"},"lastUpdatedOn":{"type":"number","description":"Last updated on","format":"double"},"lastUpdatedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archived":{"type":"boolean","description":"Indicates if the checklist template is archived"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archiveTime":{"type":"number","description":"Archive time","format":"double"}}}}}}}}}},"/v2/checklist/templates":{"get":{"tags":["Checklist Templates"],"summary":"List checklist templates","description":"List checklists templates with given criteria","operationId":"getChecklistTemplates","parameters":[{"name":"checklistTemplateIds","in":"query","schema":{"type":"string"}},{"name":"checklistTemplateName","in":"query","schema":{"type":"string"}},{"name":"required","in":"query","schema":{"type":"boolean"}},{"name":"includeArchived","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Returns a list of checklist templates with given criteria","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Checklist template name (must be unique)"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"tasks":{"type":"array","description":"Checklist template tasks","items":{"type":"object","properties":{"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"}},"description":"Checklist template tasks"}},"required":{"type":"boolean","description":"Indicates if the checklist completion is required"},"lastUpdatedOn":{"type":"number","description":"Last updated on","format":"double"},"lastUpdatedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archived":{"type":"boolean","description":"Indicates if the checklist template is archived"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archiveTime":{"type":"number","description":"Archive time","format":"double"}}}}}}}}},"put":{"tags":["Checklist Templates"],"summary":"Update checklist templates","description":"Updates multiple checklist templates","operationId":"updateChecklistTemplates","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"Checklist template identifier","format":"int32"},"name":{"type":"string","description":"Checklist template name (must be unique)"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"tasks":{"type":"array","description":"Checklist's tasks","items":{"type":"object","properties":{"position":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"}},"description":"Checklist's tasks"}},"required":{"type":"boolean","description":"Indicates if the checklist is required"}}}}}}},"responses":{"200":{"description":"Returns a list of updated checklist templates","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Checklist template name (must be unique)"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"tasks":{"type":"array","description":"Checklist template tasks","items":{"type":"object","properties":{"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"}},"description":"Checklist template tasks"}},"required":{"type":"boolean","description":"Indicates if the checklist completion is required"},"lastUpdatedOn":{"type":"number","description":"Last updated on","format":"double"},"lastUpdatedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archived":{"type":"boolean","description":"Indicates if the checklist template is archived"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archiveTime":{"type":"number","description":"Archive time","format":"double"}}}}}}}}},"post":{"tags":["Checklist Templates"],"summary":"Create checklist templates","description":"Creates multiple checklist templates","operationId":"createChecklistTemplates","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Checklist template name (must be unique)"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"tasks":{"type":"array","description":"Checklist's tasks","items":{"type":"object","properties":{"position":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"}},"description":"Checklist's tasks"}},"required":{"type":"boolean","description":"Checklist's tasks"}}}}}}},"responses":{"200":{"description":"Returns a list of created checklist templates","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Checklist template name (must be unique)"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"tasks":{"type":"array","description":"Checklist template tasks","items":{"type":"object","properties":{"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"}},"description":"Checklist template tasks"}},"required":{"type":"boolean","description":"Indicates if the checklist completion is required"},"lastUpdatedOn":{"type":"number","description":"Last updated on","format":"double"},"lastUpdatedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archived":{"type":"boolean","description":"Indicates if the checklist template is archived"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archiveTime":{"type":"number","description":"Archive time","format":"double"}}}}}}}}}},"/v2/checklist/template/{checklistTemplateId}":{"delete":{"tags":["Checklist Templates"],"summary":"Delete a checklist template","description":"Delete a checklist template by id","operationId":"deleteChecklistTemplate","parameters":[{"name":"checklistTemplateId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"}}}},"/v2/checklist/templates/delete":{"post":{"tags":["Checklist Templates"],"summary":"Delete checklist templates","description":"Deletes checklist templates by id","operationId":"deleteChecklistTemplates","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}}},"responses":{"204":{"description":"No Content"}}}},"/v2/checklist/restore":{"post":{"tags":["Checklist Templates"],"summary":"Restore a checklist template","description":"Restore a checklist template by id","operationId":"restoreChecklistTemplate","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"checklistTemplateIds":{"type":"array","items":{"type":"integer","format":"int32"}}}}}}},"responses":{"200":{"description":"Returns a list of restore checklist templates","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Checklist template name (must be unique)"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"tasks":{"type":"array","description":"Checklist template tasks","items":{"type":"object","properties":{"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"}},"description":"Checklist template tasks"}},"required":{"type":"boolean","description":"Indicates if the checklist completion is required"},"lastUpdatedOn":{"type":"number","description":"Last updated on","format":"double"},"lastUpdatedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archived":{"type":"boolean","description":"Indicates if the checklist template is archived"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archiveTime":{"type":"number","description":"Archive time","format":"double"}}}}}}}}}},"/v2/organization/archive":{"post":{"tags":["Organization Checklists"],"summary":"Archive organization checklists","description":"Archive multiple organization checklists","operationId":"archiveOrganizationChecklists","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"clientChecklistIds":{"type":"array","items":{"type":"integer","format":"int32"}}}}}}},"responses":{"200":{"description":"Returns a list of archive organization checklists","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Checklist name (must be unique)"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"required":{"type":"boolean","description":"Indicates if the checklist completion is required"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"},"completedOn":{"type":"number","description":"Date of completion","format":"double"},"assignedTo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"lastUpdatedOn":{"type":"number","description":"Last updated on","format":"double"},"lastUpdatedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"completedTaskCount":{"type":"integer","description":"Last updated by user","format":"int32"},"totalTaskCount":{"type":"integer","description":"Checklist's total tasks count","format":"int32"},"tasks":{"type":"array","description":"Checklist's tasks","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"assignedTo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"},"completedOn":{"type":"number","description":"Date of completion","format":"double"},"completedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"}},"description":"Checklist's tasks"}},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"clientName":{"type":"string","description":"Client name"},"archived":{"type":"boolean","description":"Indicates if the checklist is archived"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archiveTime":{"type":"number","description":"Archive time","format":"double"}}}}}}}}}},"/v2/organization/checklists":{"get":{"tags":["Organization Checklists"],"summary":"List client checklists","description":"List client checklists with given criteria","operationId":"getClientChecklists","parameters":[{"name":"checklistIds","in":"query","schema":{"type":"string"}},{"name":"organizationIds","in":"query","schema":{"type":"string"}},{"name":"checklistName","in":"query","schema":{"type":"string"}},{"name":"assignedToUserId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"completed","in":"query","schema":{"type":"boolean"}},{"name":"required","in":"query","schema":{"type":"boolean"}},{"name":"includeArchived","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Returns a list of client checklists with given criteria","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Checklist name (must be unique)"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"required":{"type":"boolean","description":"Indicates if the checklist completion is required"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"},"completedOn":{"type":"number","description":"Date of completion","format":"double"},"assignedTo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"lastUpdatedOn":{"type":"number","description":"Last updated on","format":"double"},"lastUpdatedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"completedTaskCount":{"type":"integer","description":"Last updated by user","format":"int32"},"totalTaskCount":{"type":"integer","description":"Checklist's total tasks count","format":"int32"},"tasks":{"type":"array","description":"Checklist's tasks","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"assignedTo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"},"completedOn":{"type":"number","description":"Date of completion","format":"double"},"completedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"}},"description":"Checklist's tasks"}},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"clientName":{"type":"string","description":"Client name"},"archived":{"type":"boolean","description":"Indicates if the checklist is archived"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archiveTime":{"type":"number","description":"Archive time","format":"double"}}}}}}}}},"put":{"tags":["Organization Checklists"],"summary":"Update organization checklists","description":"Updates multiple organization checklists","operationId":"updateOrganizationChecklists","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"checklistId":{"minimum":1,"type":"integer","description":"Checklist identifier","format":"int32"},"name":{"type":"string","description":"Checklist name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"required":{"type":"boolean","description":"Indicates if the checklist completion is required"},"dueDate":{"type":"number","description":"Due date","format":"double"},"assignedToUserId":{"minimum":1,"type":"integer","description":"User identifier assigned to the checklist","format":"int32"},"tasks":{"type":"array","description":"Checklist tasks","items":{"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"Identifier","format":"int32"},"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"assignedToUserId":{"minimum":1,"type":"integer","description":"User identifier assigned to the checklist task","format":"int32"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"}},"description":"Checklist tasks"}}}}}}}},"responses":{"200":{"description":"Returns a list of updated organization checklists","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Checklist name (must be unique)"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"required":{"type":"boolean","description":"Indicates if the checklist completion is required"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"},"completedOn":{"type":"number","description":"Date of completion","format":"double"},"assignedTo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"lastUpdatedOn":{"type":"number","description":"Last updated on","format":"double"},"lastUpdatedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"completedTaskCount":{"type":"integer","description":"Last updated by user","format":"int32"},"totalTaskCount":{"type":"integer","description":"Checklist's total tasks count","format":"int32"},"tasks":{"type":"array","description":"Checklist's tasks","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"assignedTo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"},"completedOn":{"type":"number","description":"Date of completion","format":"double"},"completedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"}},"description":"Checklist's tasks"}},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"clientName":{"type":"string","description":"Client name"},"archived":{"type":"boolean","description":"Indicates if the checklist is archived"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archiveTime":{"type":"number","description":"Archive time","format":"double"}}}}}}}}},"post":{"tags":["Organization Checklists"],"summary":"Create organization checklists","description":"Creates multiple organization checklists","operationId":"createOrganizationChecklists","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Checklist name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"required":{"type":"boolean","description":"Indicates if the checklist completion is required"},"dueDate":{"type":"number","description":"Due date","format":"double"},"assignedToUserId":{"minimum":1,"type":"integer","description":"User identifier assigned to the checklist","format":"int32"},"organizationId":{"minimum":1,"type":"integer","description":"Organization identifier","format":"int32"},"checklistTemplateId":{"minimum":1,"type":"integer","description":"Checklist template identifier","format":"int32"},"tasks":{"type":"array","description":"Checklist tasks","items":{"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"Identifier","format":"int32"},"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"assignedToUserId":{"minimum":1,"type":"integer","description":"User identifier assigned to the checklist task","format":"int32"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"}},"description":"Checklist tasks"}}}}}}}},"responses":{"200":{"description":"Returns a list of created organization checklists","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Checklist name (must be unique)"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"required":{"type":"boolean","description":"Indicates if the checklist completion is required"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"},"completedOn":{"type":"number","description":"Date of completion","format":"double"},"assignedTo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"lastUpdatedOn":{"type":"number","description":"Last updated on","format":"double"},"lastUpdatedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"completedTaskCount":{"type":"integer","description":"Last updated by user","format":"int32"},"totalTaskCount":{"type":"integer","description":"Checklist's total tasks count","format":"int32"},"tasks":{"type":"array","description":"Checklist's tasks","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"assignedTo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"},"completedOn":{"type":"number","description":"Date of completion","format":"double"},"completedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"}},"description":"Checklist's tasks"}},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"clientName":{"type":"string","description":"Client name"},"archived":{"type":"boolean","description":"Indicates if the checklist is archived"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archiveTime":{"type":"number","description":"Archive time","format":"double"}}}}}}}}}},"/v2/organization/{organizationId}/checklists-from-templates":{"post":{"tags":["Organization Checklists"],"summary":"Create organization checklists from templates","description":"Creates multiple organization checklists from templates","operationId":"createOrganizationChecklistsFromTemplates","parameters":[{"name":"organizationId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int32"}}}}},"responses":{"200":{"description":"Returns a list of created organization checklists","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Checklist name (must be unique)"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"required":{"type":"boolean","description":"Indicates if the checklist completion is required"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"},"completedOn":{"type":"number","description":"Date of completion","format":"double"},"assignedTo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"lastUpdatedOn":{"type":"number","description":"Last updated on","format":"double"},"lastUpdatedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"completedTaskCount":{"type":"integer","description":"Last updated by user","format":"int32"},"totalTaskCount":{"type":"integer","description":"Checklist's total tasks count","format":"int32"},"tasks":{"type":"array","description":"Checklist's tasks","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"assignedTo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"},"completedOn":{"type":"number","description":"Date of completion","format":"double"},"completedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"}},"description":"Checklist's tasks"}},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"clientName":{"type":"string","description":"Client name"},"archived":{"type":"boolean","description":"Indicates if the checklist is archived"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archiveTime":{"type":"number","description":"Archive time","format":"double"}}}}}}}}}},"/v2/organization/checklist/{checklistId}":{"get":{"tags":["Organization Checklists"],"summary":"Get client checklist","description":"Get a client checklist by id","operationId":"getClientChecklist","parameters":[{"name":"checklistId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns a client checklist with given id","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Checklist name (must be unique)"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"required":{"type":"boolean","description":"Indicates if the checklist completion is required"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"},"completedOn":{"type":"number","description":"Date of completion","format":"double"},"assignedTo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"lastUpdatedOn":{"type":"number","description":"Last updated on","format":"double"},"lastUpdatedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"completedTaskCount":{"type":"integer","description":"Last updated by user","format":"int32"},"totalTaskCount":{"type":"integer","description":"Checklist's total tasks count","format":"int32"},"tasks":{"type":"array","description":"Checklist's tasks","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"assignedTo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"},"completedOn":{"type":"number","description":"Date of completion","format":"double"},"completedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"}},"description":"Checklist's tasks"}},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"clientName":{"type":"string","description":"Client name"},"archived":{"type":"boolean","description":"Indicates if the checklist is archived"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archiveTime":{"type":"number","description":"Archive time","format":"double"}}}}}}}},"delete":{"tags":["Organization Checklists"],"summary":"Delete an organization checklist","description":"Deletes an organization checklist by id","operationId":"deleteClientChecklist","parameters":[{"name":"checklistId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"}}}},"/v2/organization/checklists/delete":{"post":{"tags":["Organization Checklists"],"summary":"Delete organization checklists","description":"Deletes organization checklists by id","operationId":"deleteClientChecklists","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}}},"responses":{"204":{"description":"No Content"}}}},"/v2/organization/checklist/{checklistId}/signed-urls":{"get":{"tags":["Organization Checklists"],"summary":"Get organization checklist signed urls","description":"Get organization checklist signed urls","operationId":"getClientChecklistSignedUrls","parameters":[{"name":"checklistId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns a map of content ids and their corresponding signed urls","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v2/organization/checklists/promote-with-name":{"post":{"tags":["Organization Checklists"],"summary":"Promote organization checklists","description":"Promote organization checklists by id","operationId":"promoteClientChecklists","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Checklist name"}}}}}}},"responses":{"204":{"description":"No Content"}}}},"/v2/organization/checklists/promote":{"post":{"tags":["Organization Checklists"],"summary":"Promote organization checklists","description":"Promote organization checklists by id","operationId":"promoteClientChecklists_1","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}}},"responses":{"204":{"description":"No Content"}}}},"/v2/organization/restore":{"post":{"tags":["Organization Checklists"],"summary":"Restore organization checklists","description":"Restore multiple organization checklists","operationId":"restoreOrganizationChecklists","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"clientChecklistIds":{"type":"array","items":{"type":"integer","format":"int32"}}}}}}},"responses":{"200":{"description":"Returns a list of restore organization checklists","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Checklist name (must be unique)"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"required":{"type":"boolean","description":"Indicates if the checklist completion is required"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"},"completedOn":{"type":"number","description":"Date of completion","format":"double"},"assignedTo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"lastUpdatedOn":{"type":"number","description":"Last updated on","format":"double"},"lastUpdatedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"completedTaskCount":{"type":"integer","description":"Last updated by user","format":"int32"},"totalTaskCount":{"type":"integer","description":"Checklist's total tasks count","format":"int32"},"tasks":{"type":"array","description":"Checklist's tasks","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"assignedTo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"},"completedOn":{"type":"number","description":"Date of completion","format":"double"},"completedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"}},"description":"Checklist's tasks"}},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"clientName":{"type":"string","description":"Client name"},"archived":{"type":"boolean","description":"Indicates if the checklist is archived"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archiveTime":{"type":"number","description":"Archive time","format":"double"}}}}}}}}}},"/v2/organization/document/{clientDocumentId}/archive":{"post":{"tags":["Organization Documents"],"summary":"Archive an organization document","description":"Archives an organization document by id","operationId":"archiveClientDocument","parameters":[{"name":"clientDocumentId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the organization document archived","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"integer","description":"Document Identifier","format":"int32"},"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"documentUpdateTime":{"type":"number","description":"Document Last Updated","format":"double"},"fields":{"type":"array","description":"Fields","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"value":{"type":"object","description":"Value"},"valueUpdateTime":{"type":"number","description":"Value Last Updated","format":"double"}},"description":"Updated Fields"}},"documentTemplateId":{"type":"integer","description":"Document Template Identifier","format":"int32"},"documentTemplateName":{"type":"string","description":"Document Template Name"},"organizationId":{"type":"integer","description":"Organization Identifier","format":"int32"}}}}}}}}},"/v2/organization/documents/archive":{"post":{"tags":["Organization Documents"],"summary":"Archives organization documents","description":"Archives multiple organization documents by id","operationId":"archiveMultiPageClientDocuments","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}}},"responses":{"200":{"description":"Returns a list of archived organization documents","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"integer","description":"Document Identifier","format":"int32"},"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"documentUpdateTime":{"type":"number","description":"Document Last Updated","format":"double"},"fields":{"type":"array","description":"Fields","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"value":{"type":"object","description":"Value"},"valueUpdateTime":{"type":"number","description":"Value Last Updated","format":"double"}},"description":"Updated Fields"}},"documentTemplateId":{"type":"integer","description":"Document Template Identifier","format":"int32"},"documentTemplateName":{"type":"string","description":"Document Template Name"},"organizationId":{"type":"integer","description":"Organization Identifier","format":"int32"}}}}}}}}}},"/v2/organization/{organizationId}/template/{documentTemplateId}/document":{"post":{"tags":["Organization Documents"],"summary":"Create organization document","description":"Creates an organization document and returns the document created.\n\n**Note:** setting or clearing TEXT_ENCRYPTED and TOTP fields requires an authorization_code access token from a signed-in user. With client_credentials tokens, a masked value sent back as read keeps the stored value, and any other value receives 403.","operationId":"createOrganizationDocument","parameters":[{"name":"organizationId","in":"path","description":"Organization identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"documentTemplateId","in":"path","description":"Document template identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"fields":{"type":"object","additionalProperties":{"type":"object","description":"Fields"},"description":"Fields"}}}}}},"responses":{"200":{"description":"Returns the organization document created","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"integer","description":"Document Identifier","format":"int32"},"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"documentUpdateTime":{"type":"number","description":"Document Last Updated","format":"double"},"fields":{"type":"array","description":"Fields","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"value":{"type":"object","description":"Value"},"valueUpdateTime":{"type":"number","description":"Value Last Updated","format":"double"}},"description":"Updated Fields"}},"documentTemplateId":{"type":"integer","description":"Document Template Identifier","format":"int32"},"documentTemplateName":{"type":"string","description":"Document Template Name"},"organizationId":{"type":"integer","description":"Organization Identifier","format":"int32"}}}}}}}}},"/v2/organization/documents":{"get":{"tags":["Organization Documents"],"summary":"List all organization documents with field values","description":"List all organization documents with field values","operationId":"getClientDocumentsWithAttributeValues","parameters":[{"name":"groupBy","in":"query","schema":{"type":"string","enum":["TEMPLATE","ORGANIZATION"]}},{"name":"organizationIds","in":"query","schema":{"type":"string"}},{"name":"templateIds","in":"query","schema":{"type":"string"}},{"name":"templateName","in":"query","schema":{"type":"string"}},{"name":"documentName","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a list of all organization documents with field values grouped by organization identifier","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"integer","description":"Document Identifier","format":"int32"},"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"documentUpdateTime":{"type":"number","description":"Document Last Updated","format":"double"},"fields":{"type":"array","description":"Fields","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"value":{"type":"object","description":"Value"},"valueUpdateTime":{"type":"number","description":"Value Last Updated","format":"double"}},"description":"Updated Fields"}},"documentTemplateId":{"type":"integer","description":"Document Template Identifier","format":"int32"},"documentTemplateName":{"type":"string","description":"Document Template Name"},"organizationId":{"type":"integer","description":"Organization Identifier","format":"int32"}}}}}}}}},"post":{"tags":["Organization Documents"],"summary":"Create organization documents","description":"Creates organization documents and returns the documents created.\n\n**Note:** setting or clearing TEXT_ENCRYPTED and TOTP fields requires an authorization_code access token from a signed-in user. With client_credentials tokens, a masked value sent back as read keeps the stored value, and any other value receives 403.","operationId":"createOrganizationDocuments","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"fields":{"type":"object","additionalProperties":{"type":"object","description":"Fields"},"description":"Fields"},"documentTemplateId":{"type":"integer","description":"Document Template Identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization Identifier","format":"int32"}}}}}}},"responses":{"200":{"description":"Returns a list of created organization documents with field values","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"integer","description":"Document Identifier","format":"int32"},"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"documentUpdateTime":{"type":"number","description":"Document Last Updated","format":"double"},"fields":{"type":"array","description":"Fields","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"value":{"type":"object","description":"Value"},"valueUpdateTime":{"type":"number","description":"Value Last Updated","format":"double"}},"description":"Updated Fields"}},"documentTemplateId":{"type":"integer","description":"Document Template Identifier","format":"int32"},"documentTemplateName":{"type":"string","description":"Document Template Name"},"organizationId":{"type":"integer","description":"Organization Identifier","format":"int32"}}}}}}}}},"patch":{"tags":["Organization Documents"],"summary":"Update organization documents","description":"Updates organization documents and returns the documents updated.\n\n**Note:** setting or clearing TEXT_ENCRYPTED and TOTP fields requires an authorization_code access token from a signed-in user. With client_credentials tokens, a masked value sent back as read keeps the stored value, and any other value receives 403.","operationId":"updateOrganizationDocuments","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"integer","description":"Document Identifier","format":"int32"},"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"fields":{"type":"object","additionalProperties":{"type":"object","description":"Fields"},"description":"Fields"}}}}}}},"responses":{"200":{"description":"Returns a list of updated organization documents with field values","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"integer","description":"Document Identifier","format":"int32"},"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"documentUpdateTime":{"type":"number","description":"Document Last Updated","format":"double"},"updatedFields":{"type":"array","description":"Updated Fields","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"value":{"type":"object","description":"Value"},"valueUpdateTime":{"type":"number","description":"Value Last Updated","format":"double"}},"description":"Updated Fields"}},"documentTemplateId":{"type":"integer","description":"Document Template Identifier","format":"int32"},"documentTemplateName":{"type":"string","description":"Document Template Name"},"organizationId":{"type":"integer","description":"Organization Identifier","format":"int32"}}}}}}}}}},"/v2/organization/document/{clientDocumentId}":{"delete":{"tags":["Organization Documents"],"summary":"Delete an archived organization document","description":"Deletes an archived organization document by id","operationId":"deleteClientDocument","parameters":[{"name":"clientDocumentId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"}}}},"/v2/organization/document/{clientDocumentId}/signed-urls":{"get":{"tags":["Organization Documents"],"summary":"Get organization document signed urls","description":"Get organization document signed urls","operationId":"getClientDocumentSignedUrls","parameters":[{"name":"clientDocumentId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns a map of content ids and their corresponding signed urls","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v2/organization/{organizationId}/documents":{"get":{"tags":["Organization Documents"],"summary":"List organization documents with field values","description":"List organization documents with field values","operationId":"getOrganizationDocuments","parameters":[{"name":"organizationId","in":"path","description":"Organization identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns a list of organization documents with field values","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"integer","description":"Document Identifier","format":"int32"},"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"documentUpdateTime":{"type":"number","description":"Document Last Updated","format":"double"},"fields":{"type":"array","description":"Fields","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"value":{"type":"object","description":"Value"},"valueUpdateTime":{"type":"number","description":"Value Last Updated","format":"double"}},"description":"Updated Fields"}},"documentTemplateId":{"type":"integer","description":"Document Template Identifier","format":"int32"},"documentTemplateName":{"type":"string","description":"Document Template Name"},"organizationId":{"type":"integer","description":"Organization Identifier","format":"int32"}}}}}}}}}},"/v2/organization/document/{clientDocumentId}/restore":{"post":{"tags":["Organization Documents"],"summary":"Restore an organization document","description":"Restores an organization document by id","operationId":"restoreClientDocument","parameters":[{"name":"clientDocumentId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the organization document restored","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"integer","description":"Document Identifier","format":"int32"},"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"documentUpdateTime":{"type":"number","description":"Document Last Updated","format":"double"},"fields":{"type":"array","description":"Fields","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"value":{"type":"object","description":"Value"},"valueUpdateTime":{"type":"number","description":"Value Last Updated","format":"double"}},"description":"Updated Fields"}},"documentTemplateId":{"type":"integer","description":"Document Template Identifier","format":"int32"},"documentTemplateName":{"type":"string","description":"Document Template Name"},"organizationId":{"type":"integer","description":"Organization Identifier","format":"int32"}}}}}}}}},"/v2/organization/documents/restore":{"post":{"tags":["Organization Documents"],"summary":"Restore multiple multi page organization documents","description":"Restores multiple organization documents by id","operationId":"restoreMultiPageClientDocuments","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}}},"responses":{"200":{"description":"Returns a list of restored organization documents","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"documentId":{"type":"integer","description":"Document Identifier","format":"int32"},"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"documentUpdateTime":{"type":"number","description":"Document Last Updated","format":"double"},"fields":{"type":"array","description":"Fields","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"value":{"type":"object","description":"Value"},"valueUpdateTime":{"type":"number","description":"Value Last Updated","format":"double"}},"description":"Updated Fields"}},"documentTemplateId":{"type":"integer","description":"Document Template Identifier","format":"int32"},"documentTemplateName":{"type":"string","description":"Document Template Name"},"organizationId":{"type":"integer","description":"Organization Identifier","format":"int32"}}}}}}}}}},"/v2/organization/{organizationId}/document/{clientDocumentId}":{"post":{"tags":["Organization Documents"],"summary":"Update organization document","description":"Updates an organization document and returns the updated version.\n\n**Note:** setting or clearing TEXT_ENCRYPTED and TOTP fields requires an authorization_code access token from a signed-in user. With client_credentials tokens, a masked value sent back as read keeps the stored value, and any other value receives 403.","operationId":"updateOrganizationDocument","parameters":[{"name":"organizationId","in":"path","description":"Organization identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"clientDocumentId","in":"path","description":"Organization document identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"fields":{"type":"object","additionalProperties":{"type":"object","description":"Fields"},"description":"Fields"}}}}}},"responses":{"200":{"description":"Returns the organization document updated","content":{"application/json":{"schema":{"type":"object","properties":{"documentId":{"type":"integer","description":"Document Identifier","format":"int32"},"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"documentUpdateTime":{"type":"number","description":"Document Last Updated","format":"double"},"updatedFields":{"type":"array","description":"Updated Fields","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"value":{"type":"object","description":"Value"},"valueUpdateTime":{"type":"number","description":"Value Last Updated","format":"double"}},"description":"Updated Fields"}},"documentTemplateId":{"type":"integer","description":"Document Template Identifier","format":"int32"},"documentTemplateName":{"type":"string","description":"Document Template Name"},"organizationId":{"type":"integer","description":"Organization Identifier","format":"int32"}}}}}}}}},"/v2/document-templates/{documentTemplateId}/archive":{"post":{"tags":["Document Templates"],"summary":"Archive a document template","description":"Archives a document template by id","operationId":"archiveDocumentTemplate","parameters":[{"name":"documentTemplateId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"}}}},"/v2/document-templates/archive":{"post":{"tags":["Document Templates"],"summary":"Archive multiple document templates","description":"Archives multiple document template by ids","operationId":"archiveDocumentTemplates","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}}},"responses":{"204":{"description":"No Content"}}}},"/v2/document-templates":{"get":{"tags":["Document Templates"],"summary":"List document templates with fields","description":"List document templates with fields","operationId":"getDocumentTemplatesWithAttributes","parameters":[{"name":"templateName","in":"query","schema":{"type":"string"}},{"name":"includeTechnicianRoles","in":"query","description":"Includes allowed technician roles.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returns a list of all document templates with fields","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Name of the template (must be unique)"},"description":{"type":"string","description":"Description of the template"},"allowMultiple":{"type":"boolean","description":"Indicates if multiple instances of the document template is allowed"},"mandatory":{"type":"boolean","description":"Indicates if the document template is mandatory"},"createTime":{"type":"number","description":"Creation time","format":"double"},"updateTime":{"type":"number","description":"Last updated time","format":"double"},"fields":{"type":"array","description":"Document template fields","items":{"type":"object","properties":{"fieldId":{"type":"integer","description":"Field identifier","format":"int32"},"fieldLabel":{"type":"string","description":"Field or UI element name"},"fieldName":{"type":"string","description":"Field name"},"fieldDescription":{"type":"string","description":"Field description"},"fieldType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"fieldTechnicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"fieldScriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldApiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldDefaultValue":{"type":"string","description":"Default value"},"fieldContent":{"type":"object","properties":{"values":{"type":"array","description":"Used for dropdown options","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Dropdown option name"},"active":{"type":"boolean","description":"Indicates if a dropdown option is active"}},"description":"Used for dropdown options"}},"required":{"type":"boolean","description":"Indicates if the field is required"},"footerText":{"type":"string","description":"Footer text"},"tooltipText":{"type":"string","description":"Tooltip text"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Field content"},"uiElementUid":{"type":"string","description":"UI element identifier","format":"uuid"},"uiElementName":{"type":"string","description":"UI element name"},"uiElementType":{"type":"string","description":"UI element type","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"UI element value"},"createdTime":{"type":"number","description":"Creation time","format":"double"},"updatedTime":{"type":"number","description":"Last updated time","format":"double"}},"description":"Document template fields"}},"availableToAllTechnicians":{"type":"boolean","description":"Indicates if the document template is available to all technicians"},"allowedTechnicianRoles":{"type":"array","description":"List of allowed technician role ids","items":{"type":"integer","description":"List of allowed technician role ids","format":"int32"}},"archived":{"type":"boolean","description":"Indicates if the document template is archived"},"archivedTime":{"type":"number","description":"Indicates the time the template was archived","format":"double"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"displayName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Indicates who archived the template"}}}}}}}}},"post":{"tags":["Document Templates"],"summary":"Create document template","description":"Create document template","operationId":"createDocumentTemplate","requestBody":{"content":{"application/json":{"schema":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the template (must be unique)"},"description":{"type":"string","description":"Description of the template"},"allowMultiple":{"type":"boolean","description":"States if multiple instances of the document template is allowed"},"mandatory":{"type":"boolean","description":"Indicates if the document template is mandatory"},"fields":{"type":"array","description":"List of fields and ui elements","items":{"required":["fieldLabel","fieldName"],"type":"object","properties":{"fieldLabel":{"type":"string","description":"Field label"},"fieldName":{"type":"string","description":"Field name (Immutable value)"},"fieldDescription":{"type":"string","description":"Field description"},"fieldType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"fieldTechnicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"fieldScriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldApiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldDefaultValue":{"type":"string","description":"Default value"},"fieldContent":{"type":"object","properties":{"values":{"type":"array","description":"Used for dropdown options","items":{"type":"object","properties":{"name":{"type":"string","description":"Dropdown option name"}},"description":"Used for dropdown options"}},"required":{"type":"boolean","description":"Indicates if the field is required"},"footerText":{"type":"string","description":"Footer text"},"tooltipText":{"type":"string","description":"Tooltip text"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Field content"},"uiElementName":{"type":"string","description":"UI element name"},"uiElementType":{"type":"string","description":"UI element type","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"UI element value"}},"description":"List of fields and ui elements"}},"availableToAllTechnicians":{"type":"boolean","description":"States if the document template is available to all technicians"},"allowedTechnicianRoles":{"type":"array","description":"List of allowed technician role ids","items":{"type":"integer","description":"List of allowed technician role ids","format":"int32"}}}}}}},"responses":{"200":{"description":"Returns the document template created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Name of the template (must be unique)"},"description":{"type":"string","description":"Description of the template"},"allowMultiple":{"type":"boolean","description":"Indicates if multiple instances of the document template is allowed"},"mandatory":{"type":"boolean","description":"Indicates if the document template is mandatory"},"createTime":{"type":"number","description":"Creation time","format":"double"},"updateTime":{"type":"number","description":"Last updated time","format":"double"},"fields":{"type":"array","description":"Document template fields","items":{"type":"object","properties":{"fieldId":{"type":"integer","description":"Field identifier","format":"int32"},"fieldLabel":{"type":"string","description":"Field or UI element name"},"fieldName":{"type":"string","description":"Field name"},"fieldDescription":{"type":"string","description":"Field description"},"fieldType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"fieldTechnicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"fieldScriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldApiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldDefaultValue":{"type":"string","description":"Default value"},"fieldContent":{"type":"object","properties":{"values":{"type":"array","description":"Used for dropdown options","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Dropdown option name"},"active":{"type":"boolean","description":"Indicates if a dropdown option is active"}},"description":"Used for dropdown options"}},"required":{"type":"boolean","description":"Indicates if the field is required"},"footerText":{"type":"string","description":"Footer text"},"tooltipText":{"type":"string","description":"Tooltip text"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Field content"},"uiElementUid":{"type":"string","description":"UI element identifier","format":"uuid"},"uiElementName":{"type":"string","description":"UI element name"},"uiElementType":{"type":"string","description":"UI element type","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"UI element value"},"createdTime":{"type":"number","description":"Creation time","format":"double"},"updatedTime":{"type":"number","description":"Last updated time","format":"double"}},"description":"Document template fields"}},"availableToAllTechnicians":{"type":"boolean","description":"Indicates if the document template is available to all technicians"},"allowedTechnicianRoles":{"type":"array","description":"List of allowed technician role ids","items":{"type":"integer","description":"List of allowed technician role ids","format":"int32"}},"archived":{"type":"boolean","description":"Indicates if the document template is archived"},"archivedTime":{"type":"number","description":"Indicates the time the template was archived","format":"double"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"displayName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Indicates who archived the template"}}}}}}}}},"/v2/document-templates/{documentTemplateId}":{"get":{"tags":["Document Templates"],"summary":"Get document template","description":"Get document template","operationId":"getDocumentTemplate","parameters":[{"name":"documentTemplateId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"includeTechnicianRoles","in":"query","description":"Includes allowed technician roles.","schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Returns a document template","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Name of the template (must be unique)"},"description":{"type":"string","description":"Description of the template"},"allowMultiple":{"type":"boolean","description":"Indicates if multiple instances of the document template is allowed"},"mandatory":{"type":"boolean","description":"Indicates if the document template is mandatory"},"createTime":{"type":"number","description":"Creation time","format":"double"},"updateTime":{"type":"number","description":"Last updated time","format":"double"},"fields":{"type":"array","description":"Document template fields","items":{"type":"object","properties":{"fieldId":{"type":"integer","description":"Field identifier","format":"int32"},"fieldLabel":{"type":"string","description":"Field or UI element name"},"fieldName":{"type":"string","description":"Field name"},"fieldDescription":{"type":"string","description":"Field description"},"fieldType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"fieldTechnicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"fieldScriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldApiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldDefaultValue":{"type":"string","description":"Default value"},"fieldContent":{"type":"object","properties":{"values":{"type":"array","description":"Used for dropdown options","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Dropdown option name"},"active":{"type":"boolean","description":"Indicates if a dropdown option is active"}},"description":"Used for dropdown options"}},"required":{"type":"boolean","description":"Indicates if the field is required"},"footerText":{"type":"string","description":"Footer text"},"tooltipText":{"type":"string","description":"Tooltip text"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Field content"},"uiElementUid":{"type":"string","description":"UI element identifier","format":"uuid"},"uiElementName":{"type":"string","description":"UI element name"},"uiElementType":{"type":"string","description":"UI element type","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"UI element value"},"createdTime":{"type":"number","description":"Creation time","format":"double"},"updatedTime":{"type":"number","description":"Last updated time","format":"double"}},"description":"Document template fields"}},"availableToAllTechnicians":{"type":"boolean","description":"Indicates if the document template is available to all technicians"},"allowedTechnicianRoles":{"type":"array","description":"List of allowed technician role ids","items":{"type":"integer","description":"List of allowed technician role ids","format":"int32"}},"archived":{"type":"boolean","description":"Indicates if the document template is archived"},"archivedTime":{"type":"number","description":"Indicates the time the template was archived","format":"double"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"displayName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Indicates who archived the template"}}}}}}}},"put":{"tags":["Document Templates"],"summary":"Update document template","description":"Updates a document template by id","operationId":"updateDocumentTemplate","parameters":[{"name":"documentTemplateId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the template (must be unique)"},"description":{"type":"string","description":"Description of the template"},"mandatory":{"type":"boolean","description":"Indicates if the document template is mandatory"},"fields":{"type":"array","description":"List of fields and ui elements","items":{"type":"object","properties":{"fieldId":{"type":"integer","description":"Field identifier (Used to identify existing fields)","format":"int32"},"fieldLabel":{"type":"string","description":"Field or UI element name"},"fieldName":{"type":"string","description":"Field name (Immutable except for new fields)"},"fieldDescription":{"type":"string","description":"Field description"},"fieldType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"fieldTechnicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"fieldScriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldApiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldDefaultValue":{"type":"string","description":"Default value"},"fieldContent":{"type":"object","properties":{"values":{"type":"array","description":"Used for dropdown options","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Dropdown option name"},"active":{"type":"boolean","description":"Indicates if a dropdown option is active"}},"description":"Used for dropdown options"}},"required":{"type":"boolean","description":"Indicates if the field is required"},"footerText":{"type":"string","description":"Footer text"},"tooltipText":{"type":"string","description":"Tooltip text"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Field content"},"uiElementUid":{"type":"string","description":"UI element identifier","format":"uuid"},"uiElementName":{"type":"string","description":"UI element name"},"uiElementType":{"type":"string","description":"UI element type","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"UI element value"}},"description":"List of fields and ui elements"}},"availableToAllTechnicians":{"type":"boolean","description":"States if the document template is available to all technicians"},"allowedTechnicianRoles":{"type":"array","description":"List of allowed technician role ids","items":{"type":"integer","description":"List of allowed technician role ids","format":"int32"}}}}}}},"responses":{"200":{"description":"Returns the document template updated","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Name of the template (must be unique)"},"description":{"type":"string","description":"Description of the template"},"allowMultiple":{"type":"boolean","description":"Indicates if multiple instances of the document template is allowed"},"mandatory":{"type":"boolean","description":"Indicates if the document template is mandatory"},"createTime":{"type":"number","description":"Creation time","format":"double"},"updateTime":{"type":"number","description":"Last updated time","format":"double"},"fields":{"type":"array","description":"Document template fields","items":{"type":"object","properties":{"fieldId":{"type":"integer","description":"Field identifier","format":"int32"},"fieldLabel":{"type":"string","description":"Field or UI element name"},"fieldName":{"type":"string","description":"Field name"},"fieldDescription":{"type":"string","description":"Field description"},"fieldType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"fieldTechnicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"fieldScriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldApiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldDefaultValue":{"type":"string","description":"Default value"},"fieldContent":{"type":"object","properties":{"values":{"type":"array","description":"Used for dropdown options","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Dropdown option name"},"active":{"type":"boolean","description":"Indicates if a dropdown option is active"}},"description":"Used for dropdown options"}},"required":{"type":"boolean","description":"Indicates if the field is required"},"footerText":{"type":"string","description":"Footer text"},"tooltipText":{"type":"string","description":"Tooltip text"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Field content"},"uiElementUid":{"type":"string","description":"UI element identifier","format":"uuid"},"uiElementName":{"type":"string","description":"UI element name"},"uiElementType":{"type":"string","description":"UI element type","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"UI element value"},"createdTime":{"type":"number","description":"Creation time","format":"double"},"updatedTime":{"type":"number","description":"Last updated time","format":"double"}},"description":"Document template fields"}},"availableToAllTechnicians":{"type":"boolean","description":"Indicates if the document template is available to all technicians"},"allowedTechnicianRoles":{"type":"array","description":"List of allowed technician role ids","items":{"type":"integer","description":"List of allowed technician role ids","format":"int32"}},"archived":{"type":"boolean","description":"Indicates if the document template is archived"},"archivedTime":{"type":"number","description":"Indicates the time the template was archived","format":"double"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"displayName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Indicates who archived the template"}}}}}}}},"delete":{"tags":["Document Templates"],"summary":"Delete a document template","description":"Deletes a document template by id","operationId":"deleteDocumentTemplate","parameters":[{"name":"documentTemplateId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"}}}},"/v2/document-templates/{documentTemplateId}/restore":{"post":{"tags":["Document Templates"],"summary":"Restore a document template","description":"Restores a document template by id","operationId":"restoreDocumentTemplate","parameters":[{"name":"documentTemplateId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the document template restored","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Name of the template (must be unique)"},"description":{"type":"string","description":"Description of the template"},"allowMultiple":{"type":"boolean","description":"Indicates if multiple instances of the document template is allowed"},"mandatory":{"type":"boolean","description":"Indicates if the document template is mandatory"},"createTime":{"type":"number","description":"Creation time","format":"double"},"updateTime":{"type":"number","description":"Last updated time","format":"double"},"fields":{"type":"array","description":"Document template fields","items":{"type":"object","properties":{"fieldId":{"type":"integer","description":"Field identifier","format":"int32"},"fieldLabel":{"type":"string","description":"Field or UI element name"},"fieldName":{"type":"string","description":"Field name"},"fieldDescription":{"type":"string","description":"Field description"},"fieldType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"fieldTechnicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"fieldScriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldApiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldDefaultValue":{"type":"string","description":"Default value"},"fieldContent":{"type":"object","properties":{"values":{"type":"array","description":"Used for dropdown options","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Dropdown option name"},"active":{"type":"boolean","description":"Indicates if a dropdown option is active"}},"description":"Used for dropdown options"}},"required":{"type":"boolean","description":"Indicates if the field is required"},"footerText":{"type":"string","description":"Footer text"},"tooltipText":{"type":"string","description":"Tooltip text"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Field content"},"uiElementUid":{"type":"string","description":"UI element identifier","format":"uuid"},"uiElementName":{"type":"string","description":"UI element name"},"uiElementType":{"type":"string","description":"UI element type","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"UI element value"},"createdTime":{"type":"number","description":"Creation time","format":"double"},"updatedTime":{"type":"number","description":"Last updated time","format":"double"}},"description":"Document template fields"}},"availableToAllTechnicians":{"type":"boolean","description":"Indicates if the document template is available to all technicians"},"allowedTechnicianRoles":{"type":"array","description":"List of allowed technician role ids","items":{"type":"integer","description":"List of allowed technician role ids","format":"int32"}},"archived":{"type":"boolean","description":"Indicates if the document template is archived"},"archivedTime":{"type":"number","description":"Indicates the time the template was archived","format":"double"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"displayName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Indicates who archived the template"}}}}}}}}},"/v2/document-templates/restore":{"post":{"tags":["Document Templates"],"summary":"Restore a document template","description":"Restores a document template by id","operationId":"restoreDocumentTemplates","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}}},"responses":{"200":{"description":"Returns the document template restored","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Name of the template (must be unique)"},"description":{"type":"string","description":"Description of the template"},"allowMultiple":{"type":"boolean","description":"Indicates if multiple instances of the document template is allowed"},"mandatory":{"type":"boolean","description":"Indicates if the document template is mandatory"},"createTime":{"type":"number","description":"Creation time","format":"double"},"updateTime":{"type":"number","description":"Last updated time","format":"double"},"fields":{"type":"array","description":"Document template fields","items":{"type":"object","properties":{"fieldId":{"type":"integer","description":"Field identifier","format":"int32"},"fieldLabel":{"type":"string","description":"Field or UI element name"},"fieldName":{"type":"string","description":"Field name"},"fieldDescription":{"type":"string","description":"Field description"},"fieldType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"fieldTechnicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"fieldScriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldApiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldDefaultValue":{"type":"string","description":"Default value"},"fieldContent":{"type":"object","properties":{"values":{"type":"array","description":"Used for dropdown options","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Dropdown option name"},"active":{"type":"boolean","description":"Indicates if a dropdown option is active"}},"description":"Used for dropdown options"}},"required":{"type":"boolean","description":"Indicates if the field is required"},"footerText":{"type":"string","description":"Footer text"},"tooltipText":{"type":"string","description":"Tooltip text"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Field content"},"uiElementUid":{"type":"string","description":"UI element identifier","format":"uuid"},"uiElementName":{"type":"string","description":"UI element name"},"uiElementType":{"type":"string","description":"UI element type","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"UI element value"},"createdTime":{"type":"number","description":"Creation time","format":"double"},"updatedTime":{"type":"number","description":"Last updated time","format":"double"}},"description":"Document template fields"}},"availableToAllTechnicians":{"type":"boolean","description":"Indicates if the document template is available to all technicians"},"allowedTechnicianRoles":{"type":"array","description":"List of allowed technician role ids","items":{"type":"integer","description":"List of allowed technician role ids","format":"int32"}},"archived":{"type":"boolean","description":"Indicates if the document template is archived"},"archivedTime":{"type":"number","description":"Indicates the time the template was archived","format":"double"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"displayName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Indicates who archived the template"}}}}}}}}},"/v2/tag/{assetType}":{"post":{"tags":["Asset Tags"],"summary":"Batch tag assets","description":"Update tags for the supplied assetIds. Tags will be added and removed as specified","operationId":"batchUpdateTags","parameters":[{"name":"assetType","in":"path","required":true,"schema":{"type":"string","enum":["device"]}}],"requestBody":{"description":"Payload supplying the asset ids to modify, as well as tags to add/remove from those assets","content":{"application/json":{"schema":{"type":"object","properties":{"assetIds":{"uniqueItems":true,"type":"array","description":"Array of asset IDs to perform bulk operations on (provide the type of asset with the URL)","items":{"type":"integer","description":"Array of asset IDs to perform bulk operations on (provide the type of asset with the URL)","format":"int32"}},"tagIdsToAdd":{"uniqueItems":true,"type":"array","description":"Array of tag IDs to add to the supplied assets","items":{"type":"integer","description":"Array of tag IDs to add to the supplied assets","format":"int32"}},"tagIdsToRemove":{"uniqueItems":true,"type":"array","description":"Array of tag IDs to remove from the supplied assets","items":{"type":"integer","description":"Array of tag IDs to remove from the supplied assets","format":"int32"}}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/v2/tag":{"get":{"tags":["Asset Tags"],"summary":"Get Asset Tags","description":"Get a list of created Asset Tags","operationId":"getTags","responses":{"200":{"description":"Returns a list of tags","content":{"application/json":{"schema":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"},"createdByUserId":{"type":"integer","format":"int32"},"updatedByUserId":{"type":"integer","format":"int32"},"targetsCount":{"type":"integer","format":"int32"},"createdBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"email":{"type":"string"}}},"updatedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"email":{"type":"string"}}}}}}}}}}}}},"post":{"tags":["Asset Tags"],"summary":"Create an Asset Tag","description":"Create an Asset Tag with the provided name and description","operationId":"createTag","requestBody":{"description":"The Asset Tag to be created","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":40,"minLength":1,"type":"string"},"description":{"maxLength":250,"minLength":0,"type":"string"}}}}}},"responses":{"200":{"description":"The Asset Tag that was created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID","format":"int32"},"name":{"type":"string","description":"Tag name"},"description":{"type":"string","description":"Description of the tag"},"createTime":{"type":"number","description":"Creation time for the tag in seconds since unix epoch","format":"double"},"updateTime":{"type":"number","description":"Last update time for the tag in seconds since unix epoch","format":"double"},"createdByUserId":{"type":"integer","description":"Id of the user that created the tag","format":"int32"},"updatedByUserId":{"type":"integer","description":"Id of the user that last updated the the tag","format":"int32"}}}}}}}}},"/v2/tag/{tagId}":{"put":{"tags":["Asset Tags"],"summary":"Update an Asset Tag","description":"Update an Asset Tag with the provided metadata","operationId":"updateTag","parameters":[{"name":"tagId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Updated Asset Tag data","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"maxLength":40,"minLength":0,"type":"string"},"description":{"maxLength":250,"minLength":0,"type":"string"}}}}}},"responses":{"200":{"description":"The Asset Tag that was updated","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID","format":"int32"},"name":{"type":"string","description":"Tag name"},"description":{"type":"string","description":"Description of the tag"},"createTime":{"type":"number","description":"Creation time for the tag in seconds since unix epoch","format":"double"},"updateTime":{"type":"number","description":"Last update time for the tag in seconds since unix epoch","format":"double"},"createdByUserId":{"type":"integer","description":"Id of the user that created the tag","format":"int32"},"updatedByUserId":{"type":"integer","description":"Id of the user that last updated the the tag","format":"int32"}}}}}}}},"delete":{"tags":["Asset Tags"],"summary":"Delete an Asset Tag","description":"Delete the Asset Tag with the provided id","operationId":"deleteTag","parameters":[{"name":"tagId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/v2/tag/delete":{"post":{"tags":["Asset Tags"],"summary":"Delete several Asset Tags","description":"Delete Asset Tags having the provided ids","operationId":"deleteTags","requestBody":{"description":"Array of Asset Tag Ids to delete","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int32"}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/v2/tag/merge":{"post":{"tags":["Asset Tags"],"summary":"Merge existing tags","description":"Merges tags. Can merge into an existing or new tag depending on the input parameters","operationId":"mergeTags","requestBody":{"description":"Payload specifying the tags to merge, as well as whether they should be merge to a new or existing tag","content":{"application/json":{"schema":{"type":"object","properties":{"tagIds":{"uniqueItems":true,"type":"array","description":"Array of tag ids to merge","items":{"type":"integer","description":"Array of tag ids to merge","format":"int32"}},"mergeMethod":{"type":"string","description":"Method to use - merge into an existing tag or create a new one","enum":["MERGE_INTO_EXISTING_TAG","MERGE_INTO_NEW_TAG"]},"mergeIntoTagId":{"type":"integer","description":"If merging into an existing tag, you must provide the target tag id here","format":"int32","nullable":true},"name":{"maxLength":40,"minLength":0,"type":"string","description":"If creating a new tag, you must supply the new tag name here","nullable":true},"description":{"maxLength":250,"minLength":0,"type":"string","description":"If creating a new tag, you can supply the new tag description here","nullable":true}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID","format":"int32"},"name":{"type":"string","description":"Tag name"},"description":{"type":"string","description":"Description of the tag"},"createTime":{"type":"number","description":"Creation time for the tag in seconds since unix epoch","format":"double"},"updateTime":{"type":"number","description":"Last update time for the tag in seconds since unix epoch","format":"double"},"createdByUserId":{"type":"integer","description":"Id of the user that created the tag","format":"int32"},"updatedByUserId":{"type":"integer","description":"Id of the user that last updated the the tag","format":"int32"}}}}}}}}},"/v2/tag/{assetType}/{assetId}":{"put":{"tags":["Asset Tags"],"summary":"Set tags for an asset","description":"Set the tags for an asset to exactly the supplied values","operationId":"setTagsForAsset","parameters":[{"name":"assetType","in":"path","required":true,"schema":{"type":"string","enum":["device"]}},{"name":"assetId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Array of Asset Tags to assign to the asset. Existing tags on the asset will be removed.","content":{"application/json":{"schema":{"type":"object","properties":{"tagIds":{"uniqueItems":true,"type":"array","description":"Array of tag IDS to assign to asset from URL. The tags on the asset will be set to exactly these tags, removing existing tags if necessary","items":{"type":"integer","description":"Array of tag IDS to assign to asset from URL. The tags on the asset will be set to exactly these tags, removing existing tags if necessary","format":"int32"}}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/v2/knowledgebase/articles/archive":{"post":{"tags":["Knowledge Base Articles"],"summary":"Archive knowledge base articles","description":"Archive knowledge base articles","operationId":"archiveKnowledgeBaseArticles","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}}},"responses":{"204":{"description":"No Content"}}}},"/v2/knowledgebase/folders/archive":{"post":{"tags":["Knowledge Base Articles"],"summary":"Archive knowledge base folders","description":"Archive knowledge base folders","operationId":"archiveKnowledgeBaseFolders","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}}},"responses":{"204":{"description":"No Content"}}}},"/v2/knowledgebase/articles":{"post":{"tags":["Knowledge Base Articles"],"summary":"Create knowledge base articles","description":"Create knowledge base articles","operationId":"createKnowledgeBaseArticles","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Article name"},"organizationId":{"type":"integer","description":"Organization Identifier","format":"int32"},"destinationFolderId":{"type":"integer","description":"Destination folder identifier","format":"int32"},"destinationFolderPath":{"type":"string","description":"Folder path, each folder name separated by '|'","example":"Folder 1|Folder 2|Folder 3|Folder 4"},"content":{"type":"object","properties":{"html":{"type":"string","description":"Article content html"},"text":{"type":"string","description":"Article content text"}},"description":"Article content"}}}}}}},"responses":{"200":{"description":"Returns a list of created knowledge base articles","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"parentFolderId":{"type":"integer","description":"Parent folder identifier","format":"int32"},"name":{"type":"string","description":"Article name"},"isNinjaArticle":{"type":"boolean","description":"Indicates if the article was created in ninja"},"isArchived":{"type":"boolean","description":"Indicates if the article is archived"},"attachments":{"type":"array","description":"Lists the files associated with the article","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"uploadStatus":{"type":"string","description":"Upload status","enum":["PROCESSING","SUCCESS","FAILURE","SUSPICIOUS"]},"metadata":{"type":"object","properties":{"name":{"type":"string"},"mimeType":{"type":"string"},"size":{"type":"string"},"extension":{"type":"string"},"contentId":{"type":"string"},"inline":{"type":"boolean"}},"description":"Attachment metadata"}},"description":"Lists the files associated with the article"}},"content":{"type":"object","properties":{"html":{"type":"string","description":"Article content html"},"text":{"type":"string","description":"Article content text"}},"description":"Article content"},"createTime":{"type":"number","description":"Article created time","format":"double"},"updateTime":{"type":"number","description":"Article last updated time","format":"double"},"archivedTime":{"type":"number","description":"Article archived time","format":"double"},"path":{"type":"string","description":"Article path"}}}}}}}}},"patch":{"tags":["Knowledge Base Articles"],"summary":"Update knowledge base articles","description":"Update knowledge base articles","operationId":"updateKnowledgeBaseArticles","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Article identifier","format":"int32"},"name":{"type":"string","description":"Article name"},"content":{"type":"object","properties":{"html":{"type":"string","description":"Article content html"},"text":{"type":"string","description":"Article content text"}},"description":"Article content"}}}}}}},"responses":{"200":{"description":"Returns a list of updated knowledge base articles","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"parentFolderId":{"type":"integer","description":"Parent folder identifier","format":"int32"},"name":{"type":"string","description":"Article name"},"isNinjaArticle":{"type":"boolean","description":"Indicates if the article was created in ninja"},"isArchived":{"type":"boolean","description":"Indicates if the article is archived"},"attachments":{"type":"array","description":"Lists the files associated with the article","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"uploadStatus":{"type":"string","description":"Upload status","enum":["PROCESSING","SUCCESS","FAILURE","SUSPICIOUS"]},"metadata":{"type":"object","properties":{"name":{"type":"string"},"mimeType":{"type":"string"},"size":{"type":"string"},"extension":{"type":"string"},"contentId":{"type":"string"},"inline":{"type":"boolean"}},"description":"Attachment metadata"}},"description":"Lists the files associated with the article"}},"content":{"type":"object","properties":{"html":{"type":"string","description":"Article content html"},"text":{"type":"string","description":"Article content text"}},"description":"Article content"},"createTime":{"type":"number","description":"Article created time","format":"double"},"updateTime":{"type":"number","description":"Article last updated time","format":"double"},"archivedTime":{"type":"number","description":"Article archived time","format":"double"},"path":{"type":"string","description":"Article path"}}}}}}}}}},"/v2/knowledgebase/articles/delete":{"post":{"tags":["Knowledge Base Articles"],"summary":"Delete knowledge base articles","description":"Delete knowledge base articles","operationId":"deleteKnowledgeBaseArticles","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}}},"responses":{"204":{"description":"No Content"}}}},"/v2/knowledgebase/folders/delete":{"post":{"tags":["Knowledge Base Articles"],"summary":"Delete knowledge base folders","description":"Delete knowledge base folders","operationId":"deleteKnowledgeBaseFolders","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}}},"responses":{"204":{"description":"No Content"}}}},"/v2/knowledgebase/article/{articleId}/download":{"get":{"tags":["Knowledge Base Articles"],"summary":"Download knowledge base article","description":"Download knowledge base article","operationId":"downloadKnowledgeBaseArticle","parameters":[{"name":"articleId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"}}}},"/v2/knowledgebase/article/{articleId}":{"get":{"tags":["Knowledge Base Articles"],"summary":"Get knowledge base article","description":"Retrieves a specific knowledge base article by id","operationId":"getClientKnowledgeBaseArticleById","parameters":[{"name":"articleId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Knowledge base article found by id","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"parentFolderId":{"type":"integer","description":"Parent folder identifier","format":"int32"},"name":{"type":"string","description":"Article name"},"isNinjaArticle":{"type":"boolean","description":"Indicates if the article was created in ninja"},"isArchived":{"type":"boolean","description":"Indicates if the article is archived"},"attachments":{"type":"array","description":"Lists the files associated with the article","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"uploadStatus":{"type":"string","description":"Upload status","enum":["PROCESSING","SUCCESS","FAILURE","SUSPICIOUS"]},"metadata":{"type":"object","properties":{"name":{"type":"string"},"mimeType":{"type":"string"},"size":{"type":"string"},"extension":{"type":"string"},"contentId":{"type":"string"},"inline":{"type":"boolean"}},"description":"Attachment metadata"}},"description":"Lists the files associated with the article"}},"content":{"type":"object","properties":{"html":{"type":"string","description":"Article content html"},"text":{"type":"string","description":"Article content text"}},"description":"Article content"},"createTime":{"type":"number","description":"Article created time","format":"double"},"updateTime":{"type":"number","description":"Article last updated time","format":"double"},"archivedTime":{"type":"number","description":"Article archived time","format":"double"},"path":{"type":"string","description":"Article path"}}}}}},"404":{"description":"Knowledge base article not found"}}}},"/v2/knowledgebase/organization/articles":{"get":{"tags":["Knowledge Base Articles"],"summary":"Lists organization knowledge base articles","description":"Lists organization knowledge base articles","operationId":"getClientKnowledgeBaseArticles","parameters":[{"name":"organizationIds","in":"query","schema":{"type":"string"}},{"name":"articleName","in":"query","schema":{"type":"string"}},{"name":"includeArchived","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Returns a list of organization knowledge base articles","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"parentFolderId":{"type":"integer","description":"Parent folder identifier","format":"int32"},"name":{"type":"string","description":"Article name"},"isNinjaArticle":{"type":"boolean","description":"Indicates if the article was created in ninja"},"isArchived":{"type":"boolean","description":"Indicates if the article is archived"},"attachments":{"type":"array","description":"Lists the files associated with the article","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"uploadStatus":{"type":"string","description":"Upload status","enum":["PROCESSING","SUCCESS","FAILURE","SUSPICIOUS"]},"metadata":{"type":"object","properties":{"name":{"type":"string"},"mimeType":{"type":"string"},"size":{"type":"string"},"extension":{"type":"string"},"contentId":{"type":"string"},"inline":{"type":"boolean"}},"description":"Attachment metadata"}},"description":"Lists the files associated with the article"}},"content":{"type":"object","properties":{"html":{"type":"string","description":"Article content html"},"text":{"type":"string","description":"Article content text"}},"description":"Article content"},"createTime":{"type":"number","description":"Article created time","format":"double"},"updateTime":{"type":"number","description":"Article last updated time","format":"double"},"archivedTime":{"type":"number","description":"Article archived time","format":"double"},"path":{"type":"string","description":"Article path"}}}}}}}}}},"/v2/knowledgebase/global/article/{articleId}":{"get":{"tags":["Knowledge Base Articles"],"summary":"Get global knowledge base article","description":"Retrieves a specific global knowledge base article by id","operationId":"getGlobalKnowledgeBaseArticleById","parameters":[{"name":"articleId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Global knowledge base article found by id","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"parentFolderId":{"type":"integer","description":"Parent folder identifier","format":"int32"},"name":{"type":"string","description":"Article name"},"isNinjaArticle":{"type":"boolean","description":"Indicates if the article was created in ninja"},"isArchived":{"type":"boolean","description":"Indicates if the article is archived"},"attachments":{"type":"array","description":"Lists the files associated with the article","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"uploadStatus":{"type":"string","description":"Upload status","enum":["PROCESSING","SUCCESS","FAILURE","SUSPICIOUS"]},"metadata":{"type":"object","properties":{"name":{"type":"string"},"mimeType":{"type":"string"},"size":{"type":"string"},"extension":{"type":"string"},"contentId":{"type":"string"},"inline":{"type":"boolean"}},"description":"Attachment metadata"}},"description":"Lists the files associated with the article"}},"content":{"type":"object","properties":{"html":{"type":"string","description":"Article content html"},"text":{"type":"string","description":"Article content text"}},"description":"Article content"},"createTime":{"type":"number","description":"Article created time","format":"double"},"updateTime":{"type":"number","description":"Article last updated time","format":"double"},"archivedTime":{"type":"number","description":"Article archived time","format":"double"},"path":{"type":"string","description":"Article path"}}}}}},"404":{"description":"Global knowledge base article not found"}}}},"/v2/knowledgebase/global/articles":{"get":{"tags":["Knowledge Base Articles"],"summary":"Lists global knowledge base articles","description":"Lists global knowledge base articles","operationId":"getGlobalKnowledgeBaseArticles","parameters":[{"name":"articleName","in":"query","schema":{"type":"string"}},{"name":"includeArchived","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Returns a list of global knowledge base articles","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"parentFolderId":{"type":"integer","description":"Parent folder identifier","format":"int32"},"name":{"type":"string","description":"Article name"},"isNinjaArticle":{"type":"boolean","description":"Indicates if the article was created in ninja"},"isArchived":{"type":"boolean","description":"Indicates if the article is archived"},"attachments":{"type":"array","description":"Lists the files associated with the article","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"uploadStatus":{"type":"string","description":"Upload status","enum":["PROCESSING","SUCCESS","FAILURE","SUSPICIOUS"]},"metadata":{"type":"object","properties":{"name":{"type":"string"},"mimeType":{"type":"string"},"size":{"type":"string"},"extension":{"type":"string"},"contentId":{"type":"string"},"inline":{"type":"boolean"}},"description":"Attachment metadata"}},"description":"Lists the files associated with the article"}},"content":{"type":"object","properties":{"html":{"type":"string","description":"Article content html"},"text":{"type":"string","description":"Article content text"}},"description":"Article content"},"createTime":{"type":"number","description":"Article created time","format":"double"},"updateTime":{"type":"number","description":"Article last updated time","format":"double"},"archivedTime":{"type":"number","description":"Article archived time","format":"double"},"path":{"type":"string","description":"Article path"}}}}}}}}}},"/v2/knowledgebase/article/{articleId}/signed-urls":{"get":{"tags":["Knowledge Base Articles"],"summary":"Get knowledge base article signed urls","description":"Get knowledge base article signed urls","operationId":"getKnowledgeBaseArticleSignedUrls","parameters":[{"name":"articleId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns a map of content ids and their corresponding signed urls","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v2/knowledgebase/folder/{folderId}":{"get":{"tags":["Knowledge Base Articles"],"summary":"Returns knowledge base folder","description":"Returns knowledge base folder and its content","operationId":"getKnowledgeBaseFolderContent","parameters":[{"name":"folderId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"includeArchived","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Returns knowledge base folder and its content","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"parentFolderId":{"type":"integer","description":"Parent folder identifier","format":"int32"},"name":{"type":"string","description":"Article name"},"isArchived":{"type":"boolean","description":"Indicates if the article is archived"},"createTime":{"type":"number","description":"Folder created time","format":"double"},"updateTime":{"type":"number","description":"Folder last updated time","format":"double"},"archivedTime":{"type":"number","description":"Folder archived time","format":"double"},"content":{"type":"array","description":"Folder content","items":{"type":"object","properties":{"archived":{"type":"boolean"},"folder":{"type":"boolean"},"id":{"type":"integer","description":"Identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"parentFolderId":{"type":"integer","description":"Parent folder identifier","format":"int32"},"isFolder":{"type":"boolean","description":"Indicates if this item is a folder"},"isArchived":{"type":"boolean","description":"Indicates if this item is archived"},"name":{"type":"string","description":"Article name (In the case of uploaded articles this will be the file name)"},"fileSize":{"type":"string","description":"Article file size (Only for uploaded knowledge base articles)"},"fileExtension":{"type":"string","description":"Article file extension (For native kb articles the extension will be 'ninja')"},"fileUploadStatus":{"type":"string","description":"Article file upload status (Only for uploaded knowledge base articles)","enum":["PROCESSING","SUCCESS","FAILURE","SUSPICIOUS"]},"createTime":{"type":"number","description":"Item created time","format":"double"},"updateTime":{"type":"number","description":"Item last updated time","format":"double"}},"description":"Folder content"}}}}}}}}}},"/v2/knowledgebase/folder":{"get":{"tags":["Knowledge Base Articles"],"summary":"Returns knowledge base folder","description":"Returns knowledge base folder and its content","operationId":"getKnowledgeBaseFolderPathContent","parameters":[{"name":"folderPath","in":"query","schema":{"type":"string"}},{"name":"folderId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"organizationId","in":"query","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns knowledge base folder and its content","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"parentFolderId":{"type":"integer","description":"Parent folder identifier","format":"int32"},"name":{"type":"string","description":"Article name"},"isArchived":{"type":"boolean","description":"Indicates if the article is archived"},"createTime":{"type":"number","description":"Folder created time","format":"double"},"updateTime":{"type":"number","description":"Folder last updated time","format":"double"},"archivedTime":{"type":"number","description":"Folder archived time","format":"double"},"content":{"type":"array","description":"Folder content","items":{"type":"object","properties":{"archived":{"type":"boolean"},"folder":{"type":"boolean"},"id":{"type":"integer","description":"Identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"parentFolderId":{"type":"integer","description":"Parent folder identifier","format":"int32"},"isFolder":{"type":"boolean","description":"Indicates if this item is a folder"},"isArchived":{"type":"boolean","description":"Indicates if this item is archived"},"name":{"type":"string","description":"Article name (In the case of uploaded articles this will be the file name)"},"fileSize":{"type":"string","description":"Article file size (Only for uploaded knowledge base articles)"},"fileExtension":{"type":"string","description":"Article file extension (For native kb articles the extension will be 'ninja')"},"fileUploadStatus":{"type":"string","description":"Article file upload status (Only for uploaded knowledge base articles)","enum":["PROCESSING","SUCCESS","FAILURE","SUSPICIOUS"]},"createTime":{"type":"number","description":"Item created time","format":"double"},"updateTime":{"type":"number","description":"Item last updated time","format":"double"}},"description":"Folder content"}}}}}}}}}},"/v2/knowledgebase/folders/move":{"patch":{"tags":["Knowledge Base Articles"],"summary":"Move knowledge base items","description":"Move knowledge base folders and documents to another knowledge base folder","operationId":"move","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"folderIds":{"type":"array","description":"Folders to move","items":{"type":"integer","description":"Folders to move","format":"int32"}},"documentIds":{"type":"array","description":"Documents to move","items":{"type":"integer","description":"Documents to move","format":"int32"}},"destinationFolderId":{"type":"integer","description":"Destination folder","format":"int32"},"destinationOrganizationId":{"type":"integer","description":"Destination client. Use when the root folder of the client does not exist.","format":"int32"}}}}}},"responses":{"204":{"description":"No content"}}}},"/v2/knowledgebase/articles/restore":{"post":{"tags":["Knowledge Base Articles"],"summary":"Restore archive knowledge base articles","description":"Restore archived knowledge base articles","operationId":"restoreKnowledgeBaseArticles","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}}},"responses":{"204":{"description":"No Content"}}}},"/v2/knowledgebase/folders/restore":{"post":{"tags":["Knowledge Base Articles"],"summary":"Restore archived knowledge base folders","description":"Restore archived knowledge base folders","operationId":"restoreKnowledgeBaseFolders","requestBody":{"content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}}},"responses":{"204":{"description":"No Content"}}}},"/v2/knowledgebase/articles/upload":{"post":{"tags":["Knowledge Base Articles"],"summary":"Upload knowledge base articles","description":"Upload knowledge base articles","operationId":"uploadKnowledgeBaseArticles","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"organizationId":{"type":"integer","format":"int32"},"folderId":{"type":"integer","format":"int32"},"folderPath":{"type":"string"},"files":{"type":"array","items":{"type":"object","properties":{"contentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"}}},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"}}},"messageBodyWorkers":{"type":"object"},"parent":{"type":"object","properties":{"contentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"}}},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"}}},"messageBodyWorkers":{"type":"object"},"parent":{"$ref":"#/components/schemas/MultiPart"},"providers":{"type":"object"},"bodyParts":{"type":"array","items":{"$ref":"#/components/schemas/BodyPart"}},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}}}}}}}},"providers":{"type":"object"},"formDataContentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"simple":{"type":"boolean"},"name":{"type":"string"},"value":{"type":"string"},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}}}}}}}}}}}}}},"responses":{"200":{"description":"Returns a list of created knowledge base articles","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"parentFolderId":{"type":"integer","description":"Parent folder identifier","format":"int32"},"name":{"type":"string","description":"Article name"},"isNinjaArticle":{"type":"boolean","description":"Indicates if the article was created in ninja"},"isArchived":{"type":"boolean","description":"Indicates if the article is archived"},"attachments":{"type":"array","description":"Lists the files associated with the article","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"uploadStatus":{"type":"string","description":"Upload status","enum":["PROCESSING","SUCCESS","FAILURE","SUSPICIOUS"]},"metadata":{"type":"object","properties":{"name":{"type":"string"},"mimeType":{"type":"string"},"size":{"type":"string"},"extension":{"type":"string"},"contentId":{"type":"string"},"inline":{"type":"boolean"}},"description":"Attachment metadata"}},"description":"Lists the files associated with the article"}},"content":{"type":"object","properties":{"html":{"type":"string","description":"Article content html"},"text":{"type":"string","description":"Article content text"}},"description":"Article content"},"createTime":{"type":"number","description":"Article created time","format":"double"},"updateTime":{"type":"number","description":"Article last updated time","format":"double"},"archivedTime":{"type":"number","description":"Article archived time","format":"double"},"path":{"type":"string","description":"Article path"}}}}}}}}}},"/v2/custom-fields/bulk":{"put":{"tags":["Custom Fields"],"summary":"Bulk update custom fields","description":"Updates multiple custom fields in a single request. All operations succeed or all fail.","operationId":"bulkUpdateNodeAttributes","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customFields":{"type":"array","description":"List of custom fields to update","items":{"type":"object","properties":{"label":{"type":"string","description":"Display label for the custom field"},"fieldName":{"type":"string","description":"Unique field name for API access (recommended for programmatic access)"},"description":{"type":"string","description":"Description of the custom field"},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"defaultValue":{"type":"string","description":"Default value for the custom field"},"content":{"type":"object","properties":{"values":{"type":"array","description":"List of predefined values for dropdown/radio types","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the existing option (null for new options)","format":"uuid"},"name":{"type":"string","description":"Display name for the option"},"active":{"type":"boolean","description":"Whether the option is active"},"system":{"type":"boolean","description":"Whether the option is a system option"}},"description":"List of predefined values for dropdown/radio types"}},"required":{"type":"boolean","description":"Whether the field is required"},"footerText":{"type":"string","description":"Footer text displayed below the field"},"tooltipText":{"type":"string","description":"Tooltip text for the field"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Content configuration for the custom field"},"active":{"type":"boolean","description":"Whether the custom field is active"},"scope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition scope for the custom field","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"groupId":{"type":"integer","description":"Group ID for organizing custom fields","format":"int32"}}}}}}}}},"responses":{"200":{"description":"All custom fields updated successfully","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"entityType":{"type":"string","description":"Entity type that this custom field or operation applies to","enum":["USER","NODE","TICKET","DOCUMENT","INPUT_FIELD_FORM"]},"scope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition Scope","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"label":{"type":"string","description":"Label"},"description":{"type":"string","description":"Description"},"name":{"type":"string","description":"Name"},"defaultValue":{"type":"string","description":"Default Value"},"endUserPermission":{"type":"string","description":"End user access level for custom fields in the UI","enum":["HIDDEN","EDITABLE_OPTIONAL","EDITABLE_REQUIRED","READ_ONLY"]},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"content":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean"},"footerText":{"type":"string"},"tooltipText":{"type":"string"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}}},"system":{"type":"boolean","description":"System"},"active":{"type":"boolean","description":"Active"},"createTime":{"type":"number","description":"Create Time","format":"double"},"updateTime":{"type":"number","description":"Update Time","format":"double"}}}}}}},"400":{"description":"Invalid request data - no fields updated"},"404":{"description":"One or more fields not found - no fields updated"}}},"post":{"tags":["Custom Fields"],"summary":"Bulk create custom fields","description":"Creates multiple custom fields in a single request. All operations succeed or all fail.","operationId":"bulkCreateNodeAttributes","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customFields":{"type":"array","description":"List of custom fields to create","items":{"required":["fieldName","label"],"type":"object","properties":{"label":{"type":"string","description":"Display label for the custom field"},"fieldName":{"type":"string","description":"Unique field name for API access (used when accessing the value programmatically)"},"description":{"type":"string","description":"Description of the custom field"},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"defaultValue":{"type":"string","description":"Default value for the custom field. This only has an effect for DROPDOWN and MULTI_SELECT attributes"},"content":{"type":"object","properties":{"values":{"type":"array","description":"List of predefined values for dropdown/radio types","items":{"type":"object","properties":{"name":{"type":"string","description":"Display name for the option"}},"description":"List of predefined values for dropdown/radio types"}},"required":{"type":"boolean","description":"Whether the field is required"},"footerText":{"type":"string","description":"Footer text displayed below the field"},"tooltipText":{"type":"string","description":"Tooltip text for the field"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Content configuration for the custom field"},"scope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition scope for the custom field","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"groupId":{"type":"integer","description":"Group ID for organizing custom fields","format":"int32"},"addToDefaultTab":{"type":"boolean","description":"Whether to add to the default tab"}}}}}}}}},"responses":{"200":{"description":"All custom fields created successfully","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"entityType":{"type":"string","description":"Entity type that this custom field or operation applies to","enum":["USER","NODE","TICKET","DOCUMENT","INPUT_FIELD_FORM"]},"scope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition Scope","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"label":{"type":"string","description":"Label"},"description":{"type":"string","description":"Description"},"name":{"type":"string","description":"Name"},"defaultValue":{"type":"string","description":"Default Value"},"endUserPermission":{"type":"string","description":"End user access level for custom fields in the UI","enum":["HIDDEN","EDITABLE_OPTIONAL","EDITABLE_REQUIRED","READ_ONLY"]},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"content":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean"},"footerText":{"type":"string"},"tooltipText":{"type":"string"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}}},"system":{"type":"boolean","description":"System"},"active":{"type":"boolean","description":"Active"},"createTime":{"type":"number","description":"Create Time","format":"double"},"updateTime":{"type":"number","description":"Update Time","format":"double"}}}}}}},"400":{"description":"Invalid request data - no fields created"}}},"delete":{"tags":["Custom Fields"],"summary":"Bulk delete custom fields","description":"Deletes multiple custom fields in a single request. All operations succeed or all fail.","operationId":"bulkDeleteNodeAttributes","parameters":[{"name":"fieldNames","in":"query","description":"Comma-separated list of field names to delete","schema":{"type":"string"}}],"responses":{"200":{"description":"All custom fields deleted successfully","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}},"400":{"description":"Invalid request data - no fields deleted"},"404":{"description":"One or more fields not found - no fields deleted"}}}},"/v2/custom-fields":{"get":{"tags":["Custom Fields"],"summary":"Get custom fields with pagination","description":"Retrieves custom fields (node attributes) with pagination support. Maximum 500 items per page.","operationId":"getAllNodeAttributes","parameters":[{"name":"cursorName","in":"query","description":"Pagination Cursor - Cursor provided by previous query. Used to fetch the next page of results","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Number of items per page (default: 50, min: 5, max: 500)","schema":{"maximum":500,"minimum":5,"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"Paginated list of custom fields","content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"results":{"type":"array","items":{"type":"object"}}}}}}},"400":{"description":"Invalid pagination parameters"}}},"post":{"tags":["Custom Fields"],"summary":"Create a new custom field","description":"Creates a new custom field (node attribute) with the specified configuration","operationId":"createNodeAttribute","requestBody":{"content":{"application/json":{"schema":{"required":["fieldName","label"],"type":"object","properties":{"label":{"type":"string","description":"Display label for the custom field"},"fieldName":{"type":"string","description":"Unique field name for API access (used when accessing the value programmatically)"},"description":{"type":"string","description":"Description of the custom field"},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"defaultValue":{"type":"string","description":"Default value for the custom field. This only has an effect for DROPDOWN and MULTI_SELECT attributes"},"content":{"type":"object","properties":{"values":{"type":"array","description":"List of predefined values for dropdown/radio types","items":{"type":"object","properties":{"name":{"type":"string","description":"Display name for the option"}},"description":"List of predefined values for dropdown/radio types"}},"required":{"type":"boolean","description":"Whether the field is required"},"footerText":{"type":"string","description":"Footer text displayed below the field"},"tooltipText":{"type":"string","description":"Tooltip text for the field"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Content configuration for the custom field"},"scope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition scope for the custom field","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"groupId":{"type":"integer","description":"Group ID for organizing custom fields","format":"int32"},"addToDefaultTab":{"type":"boolean","description":"Whether to add to the default tab"}}}}}},"responses":{"200":{"description":"Custom field created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"entityType":{"type":"string","description":"Entity type that this custom field or operation applies to","enum":["USER","NODE","TICKET","DOCUMENT","INPUT_FIELD_FORM"]},"scope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition Scope","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"label":{"type":"string","description":"Label"},"description":{"type":"string","description":"Description"},"name":{"type":"string","description":"Name"},"defaultValue":{"type":"string","description":"Default Value"},"endUserPermission":{"type":"string","description":"End user access level for custom fields in the UI","enum":["HIDDEN","EDITABLE_OPTIONAL","EDITABLE_REQUIRED","READ_ONLY"]},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"content":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean"},"footerText":{"type":"string"},"tooltipText":{"type":"string"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}}},"system":{"type":"boolean","description":"System"},"active":{"type":"boolean","description":"Active"},"createTime":{"type":"number","description":"Create Time","format":"double"},"updateTime":{"type":"number","description":"Update Time","format":"double"}}}}}},"400":{"description":"Invalid request data"}}}},"/v2/custom-fields/field-name/{fieldName}":{"get":{"tags":["Custom Fields"],"summary":"Get custom field by field name","description":"Retrieves a specific custom field by its unique field name","operationId":"getNodeAttributeByFieldName","parameters":[{"name":"fieldName","in":"path","description":"The unique field name of the custom field","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Custom field found","content":{"application/json":{"schema":{"type":"object","properties":{"entityType":{"type":"string","description":"Entity type that this custom field or operation applies to","enum":["USER","NODE","TICKET","DOCUMENT","INPUT_FIELD_FORM"]},"scope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition Scope","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"label":{"type":"string","description":"Label"},"description":{"type":"string","description":"Description"},"name":{"type":"string","description":"Name"},"defaultValue":{"type":"string","description":"Default Value"},"endUserPermission":{"type":"string","description":"End user access level for custom fields in the UI","enum":["HIDDEN","EDITABLE_OPTIONAL","EDITABLE_REQUIRED","READ_ONLY"]},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"content":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean"},"footerText":{"type":"string"},"tooltipText":{"type":"string"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}}},"system":{"type":"boolean","description":"System"},"active":{"type":"boolean","description":"Active"},"createTime":{"type":"number","description":"Create Time","format":"double"},"updateTime":{"type":"number","description":"Update Time","format":"double"}}}}}},"404":{"description":"Custom field not found"}}},"put":{"tags":["Custom Fields"],"summary":"Update custom field by field name","description":"Updates an existing custom field identified by its unique field name","operationId":"updateNodeAttributeByFieldName","parameters":[{"name":"fieldName","in":"path","description":"The unique field name of the custom field to update","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label":{"type":"string","description":"Display label for the custom field"},"fieldName":{"type":"string","description":"Unique field name for API access (recommended for programmatic access)"},"description":{"type":"string","description":"Description of the custom field"},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"defaultValue":{"type":"string","description":"Default value for the custom field"},"content":{"type":"object","properties":{"values":{"type":"array","description":"List of predefined values for dropdown/radio types","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the existing option (null for new options)","format":"uuid"},"name":{"type":"string","description":"Display name for the option"},"active":{"type":"boolean","description":"Whether the option is active"},"system":{"type":"boolean","description":"Whether the option is a system option"}},"description":"List of predefined values for dropdown/radio types"}},"required":{"type":"boolean","description":"Whether the field is required"},"footerText":{"type":"string","description":"Footer text displayed below the field"},"tooltipText":{"type":"string","description":"Tooltip text for the field"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Content configuration for the custom field"},"active":{"type":"boolean","description":"Whether the custom field is active"},"scope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition scope for the custom field","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"groupId":{"type":"integer","description":"Group ID for organizing custom fields","format":"int32"}}}}}},"responses":{"200":{"description":"Custom field updated successfully","content":{"application/json":{"schema":{"type":"object","properties":{"entityType":{"type":"string","description":"Entity type that this custom field or operation applies to","enum":["USER","NODE","TICKET","DOCUMENT","INPUT_FIELD_FORM"]},"scope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition Scope","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"label":{"type":"string","description":"Label"},"description":{"type":"string","description":"Description"},"name":{"type":"string","description":"Name"},"defaultValue":{"type":"string","description":"Default Value"},"endUserPermission":{"type":"string","description":"End user access level for custom fields in the UI","enum":["HIDDEN","EDITABLE_OPTIONAL","EDITABLE_REQUIRED","READ_ONLY"]},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"content":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean"},"footerText":{"type":"string"},"tooltipText":{"type":"string"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}}},"system":{"type":"boolean","description":"System"},"active":{"type":"boolean","description":"Active"},"createTime":{"type":"number","description":"Create Time","format":"double"},"updateTime":{"type":"number","description":"Update Time","format":"double"}}}}}},"400":{"description":"Invalid request data"},"404":{"description":"Custom field not found"}}},"delete":{"tags":["Custom Fields"],"summary":"Delete custom field by field name","description":"Deletes an existing custom field identified by its unique field name","operationId":"deleteNodeAttributeByFieldName","parameters":[{"name":"fieldName","in":"path","description":"The unique field name of the custom field to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Custom field deleted successfully"},"404":{"description":"Custom field not found"}}}},"/v2/custom-fields/entity-type/{entityType}/{entityId}/signed-urls":{"get":{"tags":["Custom Fields"],"summary":"Get custom field signed urls","description":"Get custom field signed urls","operationId":"getNodeAttributeSignedUrls","parameters":[{"name":"entityType","in":"path","required":true,"schema":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},{"name":"entityId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns a map of content ids and their corresponding signed urls","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v2/related-items/entity/{entityType}/{entityId}/attachment":{"post":{"tags":["Related Items"],"summary":"Create Attachment Relation","description":"Relate an attachment to an entity","operationId":"createRelatedItem","parameters":[{"name":"entityType","in":"path","required":true,"schema":{"type":"string","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","CHECKLIST","KB_DOCUMENT","END_USER","SOFTWARE_LICENSE"]}},{"name":"entityId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"object","properties":{"contentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"}}},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"}}},"messageBodyWorkers":{"type":"object"},"parent":{"type":"object","properties":{"contentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"}}},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"}}},"messageBodyWorkers":{"type":"object"},"parent":{"$ref":"#/components/schemas/MultiPart"},"providers":{"type":"object"},"bodyParts":{"type":"array","items":{"$ref":"#/components/schemas/BodyPart"}},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}}}}}}}},"providers":{"type":"object"},"formDataContentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"simple":{"type":"boolean"},"name":{"type":"string"},"value":{"type":"string"},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}}}}}}}}}}}}},"responses":{"200":{"description":"Returns the attachment related item created for an entity","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"type":{"type":"string","description":"Type of Relation","enum":["VALUE","ENTITY"]},"entity":{"type":"object","description":"Entity"},"entityId":{"type":"integer","description":"Entity Identifier","format":"int32"},"entityType":{"type":"string","description":"Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","CHECKLIST","KB_DOCUMENT","END_USER","SOFTWARE_LICENSE"]},"relEntity":{"type":"object","description":"Related Entity"},"relEntityId":{"type":"integer","description":"Related Entity Identifier","format":"int32"},"relEntityType":{"type":"string","description":"Related Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","ATTACHMENT","TECHNICIAN","CREDENTIAL","CHECKLIST","END_USER","CONTACT","KB_DOCUMENT","SOFTWARE_LICENSE","SECURE"]},"value":{"type":"object","description":"Related item value (Attachment meta data / Secure information)"},"createTime":{"type":"number","description":"Creation time","format":"double"},"updateTime":{"type":"number","description":"Last update time","format":"double"},"createdByAppUserId":{"type":"integer","description":"The identifier of the user who created the related item","format":"int32"},"updatedByAppUserId":{"type":"integer","description":"The identifier of the last user to update the related item","format":"int32"}}}}}}}}},"/v2/related-items/entity/{entityType}/{entityId}/relation":{"post":{"tags":["Related Items"],"summary":"Create entity relation","description":"Create a relation between two entities","operationId":"createRelatedItemForEntity","parameters":[{"name":"entityType","in":"path","required":true,"schema":{"type":"string","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","CHECKLIST","KB_DOCUMENT","END_USER","SOFTWARE_LICENSE"]}},{"name":"entityId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"relEntityType":{"type":"string","description":"Related Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","ATTACHMENT","TECHNICIAN","CREDENTIAL","CHECKLIST","END_USER","CONTACT","KB_DOCUMENT","SOFTWARE_LICENSE"]},"relEntityId":{"type":"integer","description":"Related Entity Identifier","format":"int32"}}}}}},"responses":{"200":{"description":"Returns the relation created for an entity","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"type":{"type":"string","description":"Type of Relation","enum":["VALUE","ENTITY"]},"entity":{"type":"object","description":"Entity"},"entityId":{"type":"integer","description":"Entity Identifier","format":"int32"},"entityType":{"type":"string","description":"Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","CHECKLIST","KB_DOCUMENT","END_USER","SOFTWARE_LICENSE"]},"relEntity":{"type":"object","description":"Related Entity"},"relEntityId":{"type":"integer","description":"Related Entity Identifier","format":"int32"},"relEntityType":{"type":"string","description":"Related Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","ATTACHMENT","TECHNICIAN","CREDENTIAL","CHECKLIST","END_USER","CONTACT","KB_DOCUMENT","SOFTWARE_LICENSE","SECURE"]},"value":{"type":"object","description":"Related item value (Attachment meta data / Secure information)"},"createTime":{"type":"number","description":"Creation time","format":"double"},"updateTime":{"type":"number","description":"Last update time","format":"double"},"createdByAppUserId":{"type":"integer","description":"The identifier of the user who created the related item","format":"int32"},"updatedByAppUserId":{"type":"integer","description":"The identifier of the last user to update the related item","format":"int32"}}}}}}}}},"/v2/related-items/entity/{entityType}/{entityId}/relations":{"post":{"tags":["Related Items"],"summary":"Create entity relations","description":"Create multiple relations between two entities","operationId":"createRelatedItemForEntity_1","parameters":[{"name":"entityType","in":"path","required":true,"schema":{"type":"string","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","CHECKLIST","KB_DOCUMENT","END_USER","SOFTWARE_LICENSE"]}},{"name":"entityId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"relEntityType":{"type":"string","description":"Related Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","ATTACHMENT","TECHNICIAN","CREDENTIAL","CHECKLIST","END_USER","CONTACT","KB_DOCUMENT","SOFTWARE_LICENSE"]},"relEntityId":{"type":"integer","description":"Related Entity Identifier","format":"int32"}}}}}}},"responses":{"200":{"description":"Returns list of relations created for an entity","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"type":{"type":"string","description":"Type of Relation","enum":["VALUE","ENTITY"]},"entity":{"type":"object","description":"Entity"},"entityId":{"type":"integer","description":"Entity Identifier","format":"int32"},"entityType":{"type":"string","description":"Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","CHECKLIST","KB_DOCUMENT","END_USER","SOFTWARE_LICENSE"]},"relEntity":{"type":"object","description":"Related Entity"},"relEntityId":{"type":"integer","description":"Related Entity Identifier","format":"int32"},"relEntityType":{"type":"string","description":"Related Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","ATTACHMENT","TECHNICIAN","CREDENTIAL","CHECKLIST","END_USER","CONTACT","KB_DOCUMENT","SOFTWARE_LICENSE","SECURE"]},"value":{"type":"object","description":"Related item value (Attachment meta data / Secure information)"},"createTime":{"type":"number","description":"Creation time","format":"double"},"updateTime":{"type":"number","description":"Last update time","format":"double"},"createdByAppUserId":{"type":"integer","description":"The identifier of the user who created the related item","format":"int32"},"updatedByAppUserId":{"type":"integer","description":"The identifier of the last user to update the related item","format":"int32"}}}}}}}}}},"/v2/related-items/entity/{entityType}/{entityId}/secure":{"post":{"tags":["Related Items"],"summary":"Create Secure Relation","description":"Create a relation to a secure value.\n\n**Note:** creating or deleting a secure related item requires an authorization_code access token from a signed-in user. With client_credentials tokens, the request receives 403.","operationId":"createSecureRelatedItemForEntity","parameters":[{"name":"entityType","in":"path","required":true,"schema":{"type":"string","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","CHECKLIST","KB_DOCUMENT","END_USER","SOFTWARE_LICENSE"]}},{"name":"entityId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"url":{"type":"string","description":"URL"},"notes":{"type":"string","description":"Notes"},"username":{"type":"string","description":"Username"},"password":{"type":"string","description":"Password"},"totpSecret":{"type":"string","description":"TOTP Secret"}}}}}},"responses":{"200":{"description":"Returns the secure related item created for an entity","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"type":{"type":"string","description":"Type of Relation","enum":["VALUE","ENTITY"]},"entity":{"type":"object","description":"Entity"},"entityId":{"type":"integer","description":"Entity Identifier","format":"int32"},"entityType":{"type":"string","description":"Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","CHECKLIST","KB_DOCUMENT","END_USER","SOFTWARE_LICENSE"]},"relEntity":{"type":"object","description":"Related Entity"},"relEntityId":{"type":"integer","description":"Related Entity Identifier","format":"int32"},"relEntityType":{"type":"string","description":"Related Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","ATTACHMENT","TECHNICIAN","CREDENTIAL","CHECKLIST","END_USER","CONTACT","KB_DOCUMENT","SOFTWARE_LICENSE","SECURE"]},"value":{"type":"object","description":"Related item value (Attachment meta data / Secure information)"},"createTime":{"type":"number","description":"Creation time","format":"double"},"updateTime":{"type":"number","description":"Last update time","format":"double"},"createdByAppUserId":{"type":"integer","description":"The identifier of the user who created the related item","format":"int32"},"updatedByAppUserId":{"type":"integer","description":"The identifier of the last user to update the related item","format":"int32"}}}}}}}}},"/v2/related-items/{relatedItemId}":{"delete":{"tags":["Related Items"],"summary":"Delete related item","description":"Deletes related item.\n\n**Note:** creating or deleting a secure related item requires an authorization_code access token from a signed-in user. With client_credentials tokens, the request receives 403.","operationId":"deleteRelatedItem","parameters":[{"name":"relatedItemId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"}}}},"/v2/related-items/{entityType}/{entityId}":{"delete":{"tags":["Related Items"],"summary":"Delete related items","description":"Deletes related items associated with an entity","operationId":"deleteRelatedItems","parameters":[{"name":"entityType","in":"path","required":true,"schema":{"type":"string","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","ATTACHMENT","TECHNICIAN","CREDENTIAL","CHECKLIST","END_USER","CONTACT","KB_DOCUMENT","SOFTWARE_LICENSE"]}},{"name":"entityId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"}}}},"/v2/related-items/{relatedItemId}/attachment/download":{"get":{"tags":["Knowledge Base Articles"],"summary":"Download related item attachment","description":"Download related item attachment","operationId":"downloadRelatedItemAttachment","parameters":[{"name":"relatedItemId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"}}}},"/v2/related-items":{"get":{"tags":["Related Items"],"summary":"List all related items","description":"List all related items","operationId":"getAllRelatedItems","responses":{"200":{"description":"Returns a list of all related items","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"type":{"type":"string","description":"Type of Relation","enum":["VALUE","ENTITY"]},"entity":{"type":"object","description":"Entity"},"entityId":{"type":"integer","description":"Entity Identifier","format":"int32"},"entityType":{"type":"string","description":"Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","CHECKLIST","KB_DOCUMENT","END_USER","SOFTWARE_LICENSE"]},"relEntity":{"type":"object","description":"Related Entity"},"relEntityId":{"type":"integer","description":"Related Entity Identifier","format":"int32"},"relEntityType":{"type":"string","description":"Related Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","ATTACHMENT","TECHNICIAN","CREDENTIAL","CHECKLIST","END_USER","CONTACT","KB_DOCUMENT","SOFTWARE_LICENSE","SECURE"]},"value":{"type":"object","description":"Related item value (Attachment meta data / Secure information)"},"createTime":{"type":"number","description":"Creation time","format":"double"},"updateTime":{"type":"number","description":"Last update time","format":"double"},"createdByAppUserId":{"type":"integer","description":"The identifier of the user who created the related item","format":"int32"},"updatedByAppUserId":{"type":"integer","description":"The identifier of the last user to update the related item","format":"int32"}}}}}}}}}},"/v2/related-items/with-entity/{entityType}/{entityId}/attachments/signed-urls":{"get":{"tags":["Knowledge Base Articles"],"summary":"Get related item attachments signed urls","description":"Get related item attachments signed urls for an entity","operationId":"getRelatedItemAttachmentsSignedUrls","parameters":[{"name":"entityType","in":"path","required":true,"schema":{"type":"string","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","CHECKLIST","KB_DOCUMENT","END_USER","SOFTWARE_LICENSE"]}},{"name":"entityId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns a map of content ids and their corresponding signed urls","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v2/related-items/with-entity/{entityType}/{entityId}":{"get":{"tags":["Related Items"],"summary":"List host entity related items by scope","description":"List related items for a specific host entity filterable by scope","operationId":"getRelatedItemsForHostEntity","parameters":[{"name":"entityType","in":"path","required":true,"schema":{"type":"string","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","CHECKLIST","KB_DOCUMENT","END_USER","SOFTWARE_LICENSE"]}},{"name":"entityId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"scope","in":"query","schema":{"type":"string","enum":["ALL","HOSTING","HOSTED_BY"]}}],"responses":{"200":{"description":"Returns list of the related items for an entity filterable by scope","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"type":{"type":"string","description":"Type of Relation","enum":["VALUE","ENTITY"]},"entity":{"type":"object","description":"Entity"},"entityId":{"type":"integer","description":"Entity Identifier","format":"int32"},"entityType":{"type":"string","description":"Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","CHECKLIST","KB_DOCUMENT","END_USER","SOFTWARE_LICENSE"]},"relEntity":{"type":"object","description":"Related Entity"},"relEntityId":{"type":"integer","description":"Related Entity Identifier","format":"int32"},"relEntityType":{"type":"string","description":"Related Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","ATTACHMENT","TECHNICIAN","CREDENTIAL","CHECKLIST","END_USER","CONTACT","KB_DOCUMENT","SOFTWARE_LICENSE","SECURE"]},"value":{"type":"object","description":"Related item value (Attachment meta data / Secure information)"},"createTime":{"type":"number","description":"Creation time","format":"double"},"updateTime":{"type":"number","description":"Last update time","format":"double"},"createdByAppUserId":{"type":"integer","description":"The identifier of the user who created the related item","format":"int32"},"updatedByAppUserId":{"type":"integer","description":"The identifier of the last user to update the related item","format":"int32"}}}}}}}}}},"/v2/related-items/with-related-entity/{relEntityType}/{relEntityId}":{"get":{"tags":["Related Items"],"summary":"List related entity related items","description":"List related items for a specific related entity","operationId":"getRelatedItemsWithEntity","parameters":[{"name":"relEntityType","in":"path","required":true,"schema":{"type":"string","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","ATTACHMENT","TECHNICIAN","CREDENTIAL","CHECKLIST","END_USER","CONTACT","KB_DOCUMENT","SOFTWARE_LICENSE"]}},{"name":"relEntityId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns list of the related items for a specific related entity","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"type":{"type":"string","description":"Type of Relation","enum":["VALUE","ENTITY"]},"entity":{"type":"object","description":"Entity"},"entityId":{"type":"integer","description":"Entity Identifier","format":"int32"},"entityType":{"type":"string","description":"Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","CHECKLIST","KB_DOCUMENT","END_USER","SOFTWARE_LICENSE"]},"relEntity":{"type":"object","description":"Related Entity"},"relEntityId":{"type":"integer","description":"Related Entity Identifier","format":"int32"},"relEntityType":{"type":"string","description":"Related Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","ATTACHMENT","TECHNICIAN","CREDENTIAL","CHECKLIST","END_USER","CONTACT","KB_DOCUMENT","SOFTWARE_LICENSE","SECURE"]},"value":{"type":"object","description":"Related item value (Attachment meta data / Secure information)"},"createTime":{"type":"number","description":"Creation time","format":"double"},"updateTime":{"type":"number","description":"Last update time","format":"double"},"createdByAppUserId":{"type":"integer","description":"The identifier of the user who created the related item","format":"int32"},"updatedByAppUserId":{"type":"integer","description":"The identifier of the last user to update the related item","format":"int32"}}}}}}}}}},"/v2/related-items/with-related-entity-type/{relatedEntityType}":{"get":{"tags":["Related Items"],"summary":"List related entity type related items","description":"List related entities for a related entity type","operationId":"getRelatedItemsWithEntityType","parameters":[{"name":"relatedEntityType","in":"path","required":true,"schema":{"type":"string","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","ATTACHMENT","TECHNICIAN","CREDENTIAL","CHECKLIST","END_USER","CONTACT","KB_DOCUMENT","SOFTWARE_LICENSE"]}}],"responses":{"200":{"description":"Returns list of references for a related entity type","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"type":{"type":"string","description":"Type of Relation","enum":["VALUE","ENTITY"]},"entity":{"type":"object","description":"Entity"},"entityId":{"type":"integer","description":"Entity Identifier","format":"int32"},"entityType":{"type":"string","description":"Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","CHECKLIST","KB_DOCUMENT","END_USER","SOFTWARE_LICENSE"]},"relEntity":{"type":"object","description":"Related Entity"},"relEntityId":{"type":"integer","description":"Related Entity Identifier","format":"int32"},"relEntityType":{"type":"string","description":"Related Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","ATTACHMENT","TECHNICIAN","CREDENTIAL","CHECKLIST","END_USER","CONTACT","KB_DOCUMENT","SOFTWARE_LICENSE","SECURE"]},"value":{"type":"object","description":"Related item value (Attachment meta data / Secure information)"},"createTime":{"type":"number","description":"Creation time","format":"double"},"updateTime":{"type":"number","description":"Last update time","format":"double"},"createdByAppUserId":{"type":"integer","description":"The identifier of the user who created the related item","format":"int32"},"updatedByAppUserId":{"type":"integer","description":"The identifier of the last user to update the related item","format":"int32"}}}}}}}}}},"/v2/related-items/with-entity-type/{entityType}":{"get":{"tags":["Related Items"],"summary":"List host entity type related items","description":"List relations and references for a host entity type","operationId":"getRelatedItemsWithHostEntityType","parameters":[{"name":"entityType","in":"path","required":true,"schema":{"type":"string","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","CHECKLIST","KB_DOCUMENT","END_USER","SOFTWARE_LICENSE"]}}],"responses":{"200":{"description":"Returns a list of relations and references for an entity type","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"type":{"type":"string","description":"Type of Relation","enum":["VALUE","ENTITY"]},"entity":{"type":"object","description":"Entity"},"entityId":{"type":"integer","description":"Entity Identifier","format":"int32"},"entityType":{"type":"string","description":"Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","CHECKLIST","KB_DOCUMENT","END_USER","SOFTWARE_LICENSE"]},"relEntity":{"type":"object","description":"Related Entity"},"relEntityId":{"type":"integer","description":"Related Entity Identifier","format":"int32"},"relEntityType":{"type":"string","description":"Related Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","ATTACHMENT","TECHNICIAN","CREDENTIAL","CHECKLIST","END_USER","CONTACT","KB_DOCUMENT","SOFTWARE_LICENSE","SECURE"]},"value":{"type":"object","description":"Related item value (Attachment meta data / Secure information)"},"createTime":{"type":"number","description":"Creation time","format":"double"},"updateTime":{"type":"number","description":"Last update time","format":"double"},"createdByAppUserId":{"type":"integer","description":"The identifier of the user who created the related item","format":"int32"},"updatedByAppUserId":{"type":"integer","description":"The identifier of the last user to update the related item","format":"int32"}}}}}}}}}},"/v2/itam/asset-relationship":{"post":{"tags":["Asset Relationships"],"summary":"Create multiple asset relationships","description":"Creates one or more relationships between assets. Returns both successful creations and any failures.","operationId":"createAssetRelationship","requestBody":{"description":"Array of relationship creation requests","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"sourceId":{"type":"integer","description":"Unique identifier of the source entity","format":"int32"},"sourceType":{"type":"string","description":"Type of the source entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"targetId":{"type":"integer","description":"Unique identifier of the target entity","format":"int32"},"targetType":{"type":"string","description":"Type of the target entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"relationshipTypeId":{"type":"integer","description":"Unique identifier of the relationship type","format":"int32"}}}}}},"required":true},"responses":{"200":{"description":"Partial or full success - returns successfully created relationships and any errors","content":{"application/json":{"schema":{"type":"object","properties":{"successfulRelationships":{"type":"array","description":"List of successfully created relationships","items":{"type":"object","properties":{"relationId":{"type":"integer","description":"Unique identifier of the relationship","format":"int32"},"source":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the asset","format":"int32"},"entityType":{"type":"string","description":"Type of the entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"name":{"type":"string","description":"Name of the asset"},"clientId":{"type":"integer","description":"Client identifier, if applicable","format":"int32"}},"description":"Target asset in the relationship"},"target":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the asset","format":"int32"},"entityType":{"type":"string","description":"Type of the entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"name":{"type":"string","description":"Name of the asset"},"clientId":{"type":"integer","description":"Client identifier, if applicable","format":"int32"}},"description":"Target asset in the relationship"},"relation":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the relation type","format":"int32"},"forwardLabel":{"type":"string","description":"Label for the forward direction"},"reverseLabel":{"type":"string","description":"Label for the reverse direction"},"systemDefault":{"type":"boolean","description":"Whether this is a system default relation"}},"description":"Type of the relationship"}},"description":"List of asset relationships"}},"errors":{"type":"array","description":"List of failed relationship creation attempts","items":{"type":"object","properties":{"requestIndex":{"type":"integer","description":"Index of the failed request in the original array (zero-based)","format":"int32"},"request":{"type":"object","properties":{"sourceId":{"type":"integer","description":"Unique identifier of the source entity","format":"int32"},"sourceType":{"type":"string","description":"Type of the source entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"targetId":{"type":"integer","description":"Unique identifier of the target entity","format":"int32"},"targetType":{"type":"string","description":"Type of the target entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"relationshipTypeId":{"type":"integer","description":"Unique identifier of the relationship type","format":"int32"}}},"errorCode":{"type":"string","description":"Error code indicating the failure reason"},"errorMessage":{"type":"string","description":"Human-readable error message"}},"description":"List of failed relationship creation attempts"}}}}}}},"400":{"description":"Bad request - All requests failed, invalid input, batch size exceeded, or duplicates found"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - Missing required permissions"}}},"delete":{"tags":["Asset Relationships"],"summary":"Delete multiple asset relationships","description":"Deletes one or more relationships between assets by their unique identifiers. Maximum of 100 relationships can be deleted per request.","operationId":"deleteAssetRelationships","parameters":[{"name":"id","in":"query","schema":{"type":"array","description":"IDs of relationships to delete (maximum 100)","items":{"type":"integer","description":"IDs of relationships to delete (maximum 100)","format":"int32"}}}],"responses":{"204":{"description":"Relationships successfully deleted"},"400":{"description":"Bad request - Batch size exceeded or invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - Missing required permissions"},"404":{"description":"One or more relationships not found"}}}},"/v2/itam/asset-relationship/types":{"get":{"tags":["Asset Relationships"],"summary":"Get all relationship types","description":"Returns a paginated list of all relationship types, including both system default and user created types, available for creating asset relationships.","operationId":"getAllRelationshipTypes","parameters":[{"name":"after","in":"query","schema":{"type":"string","description":"Cursor for forward pagination. Use nextCursor from previous response."}},{"name":"before","in":"query","schema":{"type":"string","description":"Cursor for backward pagination. Use previousCursor from previous response."}},{"name":"pageSize","in":"query","schema":{"maximum":500,"minimum":1,"type":"integer","description":"Number of results per page. Defaults to 100, minimum 1, maximum 500.","format":"int32","default":100}}],"responses":{"200":{"description":"A paginated list of relationship types","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","description":"List of relationship types","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the relation type","format":"int32"},"forwardLabel":{"type":"string","description":"Label for the forward direction"},"reverseLabel":{"type":"string","description":"Label for the reverse direction"},"systemDefault":{"type":"boolean","description":"Whether this is a system default relation"}},"description":"Type of the relationship"}},"pageInfo":{"type":"object","properties":{"count":{"type":"integer","description":"Total count of results in this page","format":"int32"},"nextCursor":{"type":"string","description":"Cursor for the next page. Use with 'after' parameter."},"previousCursor":{"type":"string","description":"Cursor for the previous page. Use with 'before' parameter."},"hasMore":{"type":"boolean","description":"Indicates if there are more results after this page"},"hasPrevious":{"type":"boolean","description":"Indicates if there are results before this page"}},"description":"Pagination information for paginated responses"}},"description":"Paginated response containing relationship types"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - Missing required permissions"}}},"post":{"tags":["Asset Relationships"],"summary":"Create a relationship type","description":"Creates a new relationship type to be used when creating relationships between assets.","operationId":"createRelationshipType","requestBody":{"description":"Payload to create a new relationship type","content":{"application/json":{"schema":{"required":["forwardLabel","reverseLabel"],"type":"object","properties":{"forwardLabel":{"type":"string","description":"Label for the forward direction"},"reverseLabel":{"type":"string","description":"Label for the reverse direction"},"description":{"type":"string","description":"Description of the relation type"}}}}},"required":true},"responses":{"201":{"description":"The created relationship type","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"relationshipName":{"type":"string"},"secondaryRelationshipName":{"type":"string"},"system":{"type":"boolean"},"active":{"type":"boolean"},"description":{"type":"string"}}}}}},"400":{"description":"Bad request - Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - Missing required permissions"}}}},"/v2/itam/asset-relationship/relations":{"get":{"tags":["Asset Relationships"],"summary":"Get all asset relationships","description":"Returns a paginated list of all asset relationships, optionally filtered by relationship type.","operationId":"getAllRelationships","parameters":[{"name":"type","in":"query","schema":{"type":"string","description":"The relation type used to filter relationships. By default all relation types are returned."}},{"name":"after","in":"query","schema":{"type":"string","description":"Cursor for forward pagination. Use nextCursor from previous response."}},{"name":"before","in":"query","schema":{"type":"string","description":"Cursor for backward pagination. Use previousCursor from previous response."}},{"name":"pageSize","in":"query","schema":{"maximum":500,"minimum":1,"type":"integer","description":"Number of results per page. Defaults to 100, minimum 1, maximum 500.","format":"int32","default":100}}],"responses":{"200":{"description":"A paginated list of asset relationships","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","description":"List of asset relationships","items":{"type":"object","properties":{"relationId":{"type":"integer","description":"Unique identifier of the relationship","format":"int32"},"source":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the asset","format":"int32"},"entityType":{"type":"string","description":"Type of the entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"name":{"type":"string","description":"Name of the asset"},"clientId":{"type":"integer","description":"Client identifier, if applicable","format":"int32"}},"description":"Target asset in the relationship"},"target":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the asset","format":"int32"},"entityType":{"type":"string","description":"Type of the entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"name":{"type":"string","description":"Name of the asset"},"clientId":{"type":"integer","description":"Client identifier, if applicable","format":"int32"}},"description":"Target asset in the relationship"},"relation":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the relation type","format":"int32"},"forwardLabel":{"type":"string","description":"Label for the forward direction"},"reverseLabel":{"type":"string","description":"Label for the reverse direction"},"systemDefault":{"type":"boolean","description":"Whether this is a system default relation"}},"description":"Type of the relationship"}},"description":"List of asset relationships"}},"pageInfo":{"type":"object","properties":{"count":{"type":"integer","description":"Total count of results in this page","format":"int32"},"nextCursor":{"type":"string","description":"Cursor for the next page. Use with 'after' parameter."},"previousCursor":{"type":"string","description":"Cursor for the previous page. Use with 'before' parameter."},"hasMore":{"type":"boolean","description":"Indicates if there are more results after this page"},"hasPrevious":{"type":"boolean","description":"Indicates if there are results before this page"}},"description":"Pagination information for paginated responses"}},"description":"Paginated response containing asset relationships"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - Missing required permissions"}}}},"/v2/itam/asset-relationship/{entityType}/{entityId}/relations":{"get":{"tags":["Asset Relationships"],"summary":"Get all asset relationships for an entity","description":"Returns a paginated list of all asset relationships for a specific entity, optionally filtered by relationship type and relation side.","operationId":"getEntityRelations","parameters":[{"name":"entityType","in":"path","required":true,"schema":{"type":"string","description":"The entity type of the asset","example":"DEVICE","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]}},{"name":"entityId","in":"path","required":true,"schema":{"type":"integer","description":"Unique identifier of the entity for which to retrieve relationships.","format":"int32"}},{"name":"type","in":"query","schema":{"type":"string","description":"The relation type used to filter relationships. By default all relation types are returned."}},{"name":"side","in":"query","schema":{"type":"string","description":"Whether to get ingoing or outgoing relationships. By default, both sides are returned.","enum":["SOURCE","TARGET"]}},{"name":"after","in":"query","schema":{"type":"string","description":"Cursor for forward pagination. Use nextCursor from previous response."}},{"name":"before","in":"query","schema":{"type":"string","description":"Cursor for backward pagination. Use previousCursor from previous response."}},{"name":"pageSize","in":"query","schema":{"maximum":500,"minimum":1,"type":"integer","description":"Number of results per page. Defaults to 100, minimum 1, maximum 500.","format":"int32","default":100}}],"responses":{"200":{"description":"A paginated list of asset relationships","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","description":"List of asset relationships","items":{"type":"object","properties":{"relationId":{"type":"integer","description":"Unique identifier of the relationship","format":"int32"},"source":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the asset","format":"int32"},"entityType":{"type":"string","description":"Type of the entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"name":{"type":"string","description":"Name of the asset"},"clientId":{"type":"integer","description":"Client identifier, if applicable","format":"int32"}},"description":"Target asset in the relationship"},"target":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the asset","format":"int32"},"entityType":{"type":"string","description":"Type of the entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"name":{"type":"string","description":"Name of the asset"},"clientId":{"type":"integer","description":"Client identifier, if applicable","format":"int32"}},"description":"Target asset in the relationship"},"relation":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the relation type","format":"int32"},"forwardLabel":{"type":"string","description":"Label for the forward direction"},"reverseLabel":{"type":"string","description":"Label for the reverse direction"},"systemDefault":{"type":"boolean","description":"Whether this is a system default relation"}},"description":"Type of the relationship"}},"description":"List of asset relationships"}},"pageInfo":{"type":"object","properties":{"count":{"type":"integer","description":"Total count of results in this page","format":"int32"},"nextCursor":{"type":"string","description":"Cursor for the next page. Use with 'after' parameter."},"previousCursor":{"type":"string","description":"Cursor for the previous page. Use with 'before' parameter."},"hasMore":{"type":"boolean","description":"Indicates if there are more results after this page"},"hasPrevious":{"type":"boolean","description":"Indicates if there are results before this page"}},"description":"Pagination information for paginated responses"}},"description":"Paginated response containing asset relationships"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - Missing required permissions"},"404":{"description":"Entity not found"}}}},"/v2/software-license":{"post":{"tags":["Software Licenses"],"summary":"Create a Software License","description":"Create a Software License with the provided name and description","operationId":"create","requestBody":{"description":"The Software License to be created","content":{"application/json":{"schema":{"required":["currentUsage","description","name","notificationChannelInfo","publisherId","purchaseDate","quantity","scope","term","type","vendorId"],"type":"object","properties":{"name":{"type":"string","description":"Indicates of the name of the software license"},"description":{"maxLength":250,"minLength":0,"type":"string","description":"Indicates a description for the software license"},"type":{"type":"string","description":"Indicates the type of the software license","example":"PER_DEVICE","enum":["PER_DEVICE","PER_USER","CUSTOM"]},"purchaseDate":{"type":"integer","description":"Indicates the purchase date of the software license in unix epoch milliseconds","format":"int64","example":1672531199000},"publisherId":{"type":"integer","description":"Identifier of the publisher","format":"int32"},"vendorId":{"type":"integer","description":"Identifier of the vendor","format":"int32"},"scope":{"type":"object","properties":{"global":{"type":"boolean"},"organizationIds":{"type":"array","items":{"type":"integer","format":"int32"}},"locationIds":{"type":"array","items":{"type":"integer","format":"int32"}}},"description":"Indicates the scope of the software license"},"quantity":{"type":"integer","description":"Indicates the quantity of the software license","format":"int32"},"currentUsage":{"type":"integer","description":"Indicates the current usage of the software license","format":"int32"},"term":{"type":"object","properties":{"renewalUnit":{"type":"string","enum":["MONTH","YEAR"]},"value":{"type":"integer","format":"int32"},"expirationDate":{"type":"number","format":"double"},"autoRenewal":{"type":"boolean"},"generateActivityAlert":{"type":"boolean"},"daysBeforeExpiration":{"type":"integer","format":"int32"},"hasNotifiedExpirationDate":{"type":"boolean"},"hasNotifiedUpToRenewal":{"type":"boolean"}},"description":"Indicates the term of the software license"},"notificationChannelInfo":{"type":"object","properties":{"email":{"type":"string"},"sms":{"type":"string"},"pushNotification":{"type":"string"}}},"assigmentAutomationSettings":{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"assignedLicenses":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Indicates the ids of the assigned licensees","nullable":true,"items":{"type":"integer","description":"Indicates the ids of the assigned licensees","format":"int32","nullable":true}},"description":"Indicates the ids of the assigned licensees","nullable":true},"unassignedLicenses":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Indicates the ids of the unassigned licensees","nullable":true,"items":{"type":"integer","description":"Indicates the ids of the unassigned licensees","format":"int32","nullable":true}},"description":"Indicates the ids of the unassigned licensees","nullable":true},"note":{"type":"string","description":"Indicates a note about the software license","nullable":true},"costMode":{"type":"string","description":"Indicates the cost mode of the software license","nullable":true,"enum":["TOTAL","PER_LICENSE"]},"cost":{"type":"number","description":"Indicates the cost of the software license","nullable":true},"usageMonitoring":{"type":"object","properties":{"binaries":{"type":"array","description":"List of OS-specific binary configurations for usage monitoring","items":{"type":"object","properties":{"osType":{"type":"string","description":"Operating system type","example":"WINDOWS","enum":["WINDOWS","LINUX","MAC"]},"binaryNames":{"type":"array","description":"List of binary/process names to monitor","example":["chrome.exe","firefox.exe"],"items":{"type":"string","description":"List of binary/process names to monitor","example":"[\"chrome.exe\",\"firefox.exe\"]"}},"nonMatches":{"type":"boolean","description":"Flag indicating whether configured binaries don't match detected binaries"}},"description":"List of OS-specific binary configurations for usage monitoring"}}},"description":"Indicates the binary usage monitoring configuration for the software license","nullable":true}}}}}},"responses":{"200":{"description":"The Software License that was created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["PER_DEVICE","PER_USER","CUSTOM"]},"automated":{"type":"boolean"},"purchaseDate":{"type":"integer","format":"int64"},"publisherId":{"type":"integer","format":"int32"},"vendorId":{"type":"integer","format":"int32"},"publisher":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"vendor":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"scope":{"type":"object","properties":{"global":{"type":"boolean"},"organizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"organizationId":{"type":"integer","format":"int32"}}}}}},"quantity":{"type":"integer","format":"int32"},"term":{"type":"object","properties":{"renewalUnit":{"type":"string","enum":["MONTH","YEAR"]},"value":{"type":"integer","format":"int32"},"expirationDate":{"type":"integer","format":"int64"},"autoRenewal":{"type":"boolean"},"generateActivityAlert":{"type":"boolean"},"daysBeforeExpiration":{"type":"integer","format":"int32"},"hasNotifiedExpirationDate":{"type":"boolean"},"hasNotifiedUpToRenewal":{"type":"boolean"}}},"notificationChannelInfo":{"type":"object","properties":{"email":{"type":"string"},"sms":{"type":"string"},"pushNotification":{"type":"string"}}},"assigmentAutomationSettings":{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"licenseAssignmentList":{"type":"array","items":{"type":"object","properties":{"licenseeId":{"type":"integer","format":"int32"},"licenseeName":{"type":"string"},"licenseeType":{"type":"string","enum":["NODE","APP_USER","CONTACT"]},"licenseeUserType":{"type":"string","enum":["TECHNICIAN","END_USER","CONTACT"]},"licenseeOrganizationName":{"type":"string"},"licenseeOrganizationId":{"type":"integer","format":"int32"},"licenseeEmail":{"type":"string"},"firstFoundAt":{"type":"integer","format":"int64"},"lastUsedAt":{"type":"integer","format":"int64"},"hasViewAccess":{"type":"boolean"}}}},"currentUsage":{"type":"integer","format":"int32"},"expired":{"type":"boolean"},"daysToExpire":{"type":"integer","format":"int32"},"note":{"type":"string"},"perLicenseCost":{"type":"number"},"totalCost":{"type":"number"},"costMode":{"type":"string","enum":["TOTAL","PER_LICENSE"]},"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]},"usageMonitoring":{"type":"array","items":{"type":"object","properties":{"osType":{"type":"string","enum":["WINDOWS","LINUX","MAC"]},"binaryNames":{"type":"array","items":{"type":"string"}},"nonMatches":{"type":"boolean"}}}},"firstFoundAt":{"type":"integer","format":"int64"},"lastUsageAt":{"type":"integer","format":"int64"}}}}}}}}},"/v2/software-license/{licenseId}":{"get":{"tags":["Software Licenses"],"summary":"Get Software License","description":"Get a Software License by Id","operationId":"getById","parameters":[{"name":"licenseId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns a Software License","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["PER_DEVICE","PER_USER","CUSTOM"]},"automated":{"type":"boolean"},"purchaseDate":{"type":"integer","format":"int64"},"publisher":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"vendor":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"scope":{"type":"object","properties":{"global":{"type":"boolean"},"organizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"organizationId":{"type":"integer","format":"int32"}}}}}},"quantity":{"type":"integer","format":"int32"},"term":{"type":"object","properties":{"renewalUnit":{"type":"string","enum":["MONTH","YEAR"]},"value":{"type":"integer","format":"int32"},"expirationDate":{"type":"integer","format":"int64"},"autoRenewal":{"type":"boolean"},"generateActivityAlert":{"type":"boolean"},"daysBeforeExpiration":{"type":"integer","format":"int32"},"hasNotifiedExpirationDate":{"type":"boolean"},"hasNotifiedUpToRenewal":{"type":"boolean"}}},"notificationChannelInfo":{"type":"object","properties":{"email":{"type":"string"},"sms":{"type":"string"},"pushNotification":{"type":"string"}}},"assigmentAutomationSettings":{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"licenseAssignmentList":{"type":"array","items":{"type":"object","properties":{"licenseeId":{"type":"integer","format":"int32"},"licenseeName":{"type":"string"},"licenseeType":{"type":"string","enum":["NODE","APP_USER","CONTACT"]},"licenseeUserType":{"type":"string","enum":["TECHNICIAN","END_USER","CONTACT"]},"licenseeOrganizationName":{"type":"string"},"licenseeOrganizationId":{"type":"integer","format":"int32"},"licenseeEmail":{"type":"string"},"firstFoundAt":{"type":"integer","format":"int64"},"lastUsedAt":{"type":"integer","format":"int64"},"hasViewAccess":{"type":"boolean"}}}},"currentUsage":{"type":"integer","format":"int32"},"expired":{"type":"boolean"},"daysToExpire":{"type":"integer","format":"int32"},"note":{"type":"string"},"perLicenseCost":{"type":"number"},"totalCost":{"type":"number"},"costMode":{"type":"string","enum":["TOTAL","PER_LICENSE"]},"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]},"automation":{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"usageMonitoring":{"type":"array","items":{"type":"object","properties":{"osType":{"type":"string","enum":["WINDOWS","LINUX","MAC"]},"binaryNames":{"type":"array","items":{"type":"string"}},"nonMatches":{"type":"boolean"}}}}}}}}}}},"put":{"tags":["Software Licenses"],"summary":"Update a Software License","description":"Update a Software License with the provided metadata","operationId":"update","parameters":[{"name":"licenseId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Updated Software License data","content":{"application/json":{"schema":{"required":["currentUsage","description","name","notificationChannelInfo","publisherId","purchaseDate","quantity","scope","term","type","vendorId"],"type":"object","properties":{"name":{"type":"string","description":"Indicates of the name of the software license"},"description":{"maxLength":250,"minLength":0,"type":"string","description":"Indicates a description for the software license"},"type":{"type":"string","description":"Indicates the type of the software license","example":"PER_DEVICE","enum":["PER_DEVICE","PER_USER","CUSTOM"]},"purchaseDate":{"type":"integer","description":"Indicates the purchase date of the software license in unix epoch milliseconds","format":"int64","example":1672531199000},"publisherId":{"type":"integer","description":"Identifier of the publisher","format":"int32"},"vendorId":{"type":"integer","description":"Identifier of the vendor","format":"int32"},"scope":{"type":"object","properties":{"global":{"type":"boolean"},"organizationIds":{"type":"array","items":{"type":"integer","format":"int32"}},"locationIds":{"type":"array","items":{"type":"integer","format":"int32"}}},"description":"Indicates the scope of the software license"},"quantity":{"type":"integer","description":"Indicates the quantity of the software license","format":"int32"},"currentUsage":{"type":"integer","description":"Indicates the current usage of the software license","format":"int32"},"term":{"type":"object","properties":{"renewalUnit":{"type":"string","enum":["MONTH","YEAR"]},"value":{"type":"integer","format":"int32"},"expirationDate":{"type":"number","format":"double"},"autoRenewal":{"type":"boolean"},"generateActivityAlert":{"type":"boolean"},"daysBeforeExpiration":{"type":"integer","format":"int32"},"hasNotifiedExpirationDate":{"type":"boolean"},"hasNotifiedUpToRenewal":{"type":"boolean"}},"description":"Indicates the term of the software license"},"notificationChannelInfo":{"type":"object","properties":{"email":{"type":"string"},"sms":{"type":"string"},"pushNotification":{"type":"string"}}},"assigmentAutomationSettings":{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"assignedLicenses":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Indicates the ids of the assigned licensees","nullable":true,"items":{"type":"integer","description":"Indicates the ids of the assigned licensees","format":"int32","nullable":true}},"description":"Indicates the ids of the assigned licensees","nullable":true},"unassignedLicenses":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Indicates the ids of the unassigned licensees","nullable":true,"items":{"type":"integer","description":"Indicates the ids of the unassigned licensees","format":"int32","nullable":true}},"description":"Indicates the ids of the unassigned licensees","nullable":true},"note":{"type":"string","description":"Indicates a note about the software license","nullable":true},"costMode":{"type":"string","description":"Indicates the cost mode of the software license","nullable":true,"enum":["TOTAL","PER_LICENSE"]},"cost":{"type":"number","description":"Indicates the cost of the software license","nullable":true},"usageMonitoring":{"type":"object","properties":{"binaries":{"type":"array","description":"List of OS-specific binary configurations for usage monitoring","items":{"type":"object","properties":{"osType":{"type":"string","description":"Operating system type","example":"WINDOWS","enum":["WINDOWS","LINUX","MAC"]},"binaryNames":{"type":"array","description":"List of binary/process names to monitor","example":["chrome.exe","firefox.exe"],"items":{"type":"string","description":"List of binary/process names to monitor","example":"[\"chrome.exe\",\"firefox.exe\"]"}},"nonMatches":{"type":"boolean","description":"Flag indicating whether configured binaries don't match detected binaries"}},"description":"List of OS-specific binary configurations for usage monitoring"}}},"description":"Indicates the binary usage monitoring configuration for the software license","nullable":true}}}}}},"responses":{"200":{"description":"The Software License that was updated","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["PER_DEVICE","PER_USER","CUSTOM"]},"automated":{"type":"boolean"},"purchaseDate":{"type":"integer","format":"int64"},"publisherId":{"type":"integer","format":"int32"},"vendorId":{"type":"integer","format":"int32"},"publisher":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"vendor":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"scope":{"type":"object","properties":{"global":{"type":"boolean"},"organizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"organizationId":{"type":"integer","format":"int32"}}}}}},"quantity":{"type":"integer","format":"int32"},"term":{"type":"object","properties":{"renewalUnit":{"type":"string","enum":["MONTH","YEAR"]},"value":{"type":"integer","format":"int32"},"expirationDate":{"type":"integer","format":"int64"},"autoRenewal":{"type":"boolean"},"generateActivityAlert":{"type":"boolean"},"daysBeforeExpiration":{"type":"integer","format":"int32"},"hasNotifiedExpirationDate":{"type":"boolean"},"hasNotifiedUpToRenewal":{"type":"boolean"}}},"notificationChannelInfo":{"type":"object","properties":{"email":{"type":"string"},"sms":{"type":"string"},"pushNotification":{"type":"string"}}},"assigmentAutomationSettings":{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"licenseAssignmentList":{"type":"array","items":{"type":"object","properties":{"licenseeId":{"type":"integer","format":"int32"},"licenseeName":{"type":"string"},"licenseeType":{"type":"string","enum":["NODE","APP_USER","CONTACT"]},"licenseeUserType":{"type":"string","enum":["TECHNICIAN","END_USER","CONTACT"]},"licenseeOrganizationName":{"type":"string"},"licenseeOrganizationId":{"type":"integer","format":"int32"},"licenseeEmail":{"type":"string"},"firstFoundAt":{"type":"integer","format":"int64"},"lastUsedAt":{"type":"integer","format":"int64"},"hasViewAccess":{"type":"boolean"}}}},"currentUsage":{"type":"integer","format":"int32"},"expired":{"type":"boolean"},"daysToExpire":{"type":"integer","format":"int32"},"note":{"type":"string"},"perLicenseCost":{"type":"number"},"totalCost":{"type":"number"},"costMode":{"type":"string","enum":["TOTAL","PER_LICENSE"]},"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]},"usageMonitoring":{"type":"array","items":{"type":"object","properties":{"osType":{"type":"string","enum":["WINDOWS","LINUX","MAC"]},"binaryNames":{"type":"array","items":{"type":"string"}},"nonMatches":{"type":"boolean"}}}},"firstFoundAt":{"type":"integer","format":"int64"},"lastUsageAt":{"type":"integer","format":"int64"}}}}}}}},"delete":{"tags":["Software Licenses"],"summary":"Delete a Software License","description":"Delete the Software License with the provided id","operationId":"delete","parameters":[{"name":"licenseId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/v2/software-license/licenses":{"get":{"tags":["Software Licenses"],"summary":"Get All Software Licenses","description":"Get All Software Licenses","operationId":"getAll","parameters":[{"name":"after","in":"query","schema":{"type":"string","description":"Cursor for forward pagination. Use nextCursor from previous response."}},{"name":"before","in":"query","schema":{"type":"string","description":"Cursor for backward pagination. Use previousCursor from previous response."}},{"name":"pageSize","in":"query","schema":{"maximum":500,"minimum":1,"type":"integer","description":"Number of results per page. Defaults to 100, minimum 1, maximum 500.","format":"int32","default":100}}],"responses":{"200":{"description":"Returns All Software Licenses","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Indicates the identifier of the licensee","format":"int32"},"name":{"type":"string","description":"Indicates the name of the software license"},"type":{"type":"string","description":"Indicates the type of the software license","enum":["PER_DEVICE","PER_USER","CUSTOM"]},"description":{"type":"string","description":"Indicates a description for the software license"},"purchaseDate":{"type":"integer","description":"Indicates the purchase date of the software license in unix","format":"int64"},"automated":{"type":"boolean","description":"Indicates if the software license assignment is automated"},"publisher":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"vendor":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"scope":{"type":"object","properties":{"global":{"type":"boolean"},"organizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"organizationId":{"type":"integer","format":"int32"}}}}}},"quantity":{"type":"integer","description":"Indicates the quantity of the software license","format":"int32"},"term":{"type":"object","properties":{"renewalUnit":{"type":"string","enum":["MONTH","YEAR"]},"value":{"type":"integer","format":"int32"},"expirationDate":{"type":"integer","format":"int64"},"autoRenewal":{"type":"boolean"},"generateActivityAlert":{"type":"boolean"},"daysBeforeExpiration":{"type":"integer","format":"int32"},"hasNotifiedExpirationDate":{"type":"boolean"},"hasNotifiedUpToRenewal":{"type":"boolean"}}},"notificationChannelInfo":{"type":"object","properties":{"email":{"type":"string"},"sms":{"type":"string"},"pushNotification":{"type":"string"}}},"assigmentAutomationSettings":{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"currentUsage":{"type":"integer","description":"Indicates the current usage of the software license","format":"int32"},"expired":{"type":"boolean","description":"Indicates itf the software license is expired"},"daysToExpire":{"type":"integer","description":"Indicates the days to expire the software license","format":"int32"},"note":{"type":"string","description":"Indicates if exists notes of the software license"},"automation":{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"usageMonitoring":{"type":"array","description":"Indicates the binary usage monitoring configuration","items":{"type":"object","properties":{"osType":{"type":"string","enum":["WINDOWS","LINUX","MAC"]},"binaryNames":{"type":"array","items":{"type":"string"}},"nonMatches":{"type":"boolean"}}}}},"description":"List of software licenses"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - Missing required permissions"}}}},"/v2/software-license/{licenseId}/assignments":{"get":{"tags":["Software Licenses"],"summary":"Get Software License Assignments","description":"Get Software License Assignments","operationId":"getLicenseAssignments","parameters":[{"name":"after","in":"query","schema":{"type":"string","description":"Cursor for forward pagination. Use nextCursor from previous response."}},{"name":"before","in":"query","schema":{"type":"string","description":"Cursor for backward pagination. Use previousCursor from previous response."}},{"name":"pageSize","in":"query","schema":{"maximum":500,"minimum":1,"type":"integer","description":"Number of results per page. Defaults to 100, minimum 1, maximum 500.","format":"int32","default":100}},{"name":"licenseId","in":"path","required":true,"schema":{"type":"integer","description":"Id of the Software License to get assignments for","format":"int32"}}],"responses":{"200":{"description":"Returns Software License Assignments","content":{"application/json":{"schema":{"type":"object","properties":{"licenseeId":{"type":"integer","description":"Indicates the identifier of the licensee","format":"int32"},"licenseeName":{"type":"string","description":"Indicates the name of the licensee"},"licenseeOrganizationName":{"type":"string","description":"Indicates the organization name of the licensee"},"licenseeOrganizationId":{"type":"integer","description":"Indicates the organization identifier of the licensee","format":"int32"},"licenseeEmail":{"type":"string","description":"Indicates the email of the licensee"},"lastUsedAt":{"type":"integer","description":"The last usage timestamp in unix epoch seconds","format":"int64","example":1672531199},"hasViewAccess":{"type":"boolean","description":"Indicates if the requester has access to view the licensee details"}},"description":"List of license assignments"}}}}}}},"/v2/software-license/assignments/last-usage":{"put":{"tags":["Software Licenses"],"summary":"Update License Assignments Last Usage","description":"Update the last usage timestamp for one or more license assignments. Supports device, app user, and contact assignment types. Maximum of 100 assignments per request.","operationId":"updateLicenseAssignmentsLastUsage","requestBody":{"description":"List of license assignment last usage updates","content":{"application/json":{"schema":{"type":"object","properties":{"licenseId":{"type":"integer","description":"The identifier of the software license","format":"int32"},"licenseeId":{"type":"integer","description":"The identifier of the licensee","format":"int32"},"licenseeType":{"type":"string","description":"The type of the licensee","enum":["NODE","APP_USER","CONTACT"]},"lastUsage":{"type":"integer","description":"The last usage timestamp in unix epoch seconds","format":"int64","example":1672531199}}}}}},"responses":{"204":{"description":"Last usage updated successfully"},"400":{"description":"Bad request - Empty list, batch size exceeded, or invalid input"}}}},"/v2/software-license/upsert":{"post":{"tags":["Software Licenses"],"summary":"Create or Update a Software License","description":"Create or Update a Software License in a simple way","operationId":"upsert","requestBody":{"description":"The Software License to be created or updated","content":{"application/json":{"schema":{"required":["name","publisherName","quantity","scope","type","vendorName"],"type":"object","properties":{"name":{"type":"string","description":"Indicates the name of the software license"},"description":{"maxLength":250,"minLength":0,"type":"string","description":"Indicates a description for the software license","nullable":true},"type":{"type":"string","description":"Indicates the type of the software license","example":"PER_DEVICE","enum":["PER_DEVICE","PER_USER","CUSTOM"]},"date":{"type":"integer","description":"Indicates the purchase date of the software license in unix epoch milliseconds","format":"int64","nullable":true,"example":1672531199000},"publisherName":{"type":"string","description":"Name of the publisher"},"vendorName":{"type":"string","description":"Name of the vendor"},"scope":{"type":"object","properties":{"global":{"type":"boolean","description":"Indicates if the scope is global"},"organizationNames":{"type":"array","description":"Indicates the organization names for the scope","items":{"type":"string","description":"Indicates the organization names for the scope"}},"locationNames":{"type":"array","description":"Indicates the location names for the scope","items":{"type":"string","description":"Indicates the location names for the scope"}}},"description":"Indicates the scope of the software license"},"quantity":{"type":"integer","description":"Indicates the quantity of the software license","format":"int32"},"currentUsage":{"type":"integer","description":"Indicates the current usage of the software license","format":"int32","nullable":true},"currentLicensees":{"uniqueItems":true,"type":"array","description":"Indicates the names of assigned licensees and removes those not specified","items":{"type":"string","description":"Indicates the names of assigned licensees and removes those not specified"}},"licenseesToAssign":{"uniqueItems":true,"type":"array","description":"Indicates the names of the licensees on which the license will be assigned","items":{"type":"string","description":"Indicates the names of the licensees on which the license will be assigned"}},"licenseesToRemove":{"uniqueItems":true,"type":"array","description":"Indicates the names of the licensees on which the license will be remowed","items":{"type":"string","description":"Indicates the names of the licensees on which the license will be remowed"}},"note":{"type":"string","description":"Indicates a note about the software license","nullable":true},"costMode":{"type":"string","description":"Indicates the cost mode of the software license","nullable":true,"enum":["TOTAL","PER_LICENSE"]},"cost":{"type":"number","description":"Indicates the cost of the software license","nullable":true},"usageMonitoring":{"type":"object","properties":{"binaries":{"type":"array","description":"List of OS-specific binary configurations for usage monitoring","items":{"type":"object","properties":{"osType":{"type":"string","description":"Operating system type","example":"WINDOWS","enum":["WINDOWS","LINUX","MAC"]},"binaryNames":{"type":"array","description":"List of binary/process names to monitor","example":["chrome.exe","firefox.exe"],"items":{"type":"string","description":"List of binary/process names to monitor","example":"[\"chrome.exe\",\"firefox.exe\"]"}},"nonMatches":{"type":"boolean","description":"Flag indicating whether configured binaries don't match detected binaries"}},"description":"List of OS-specific binary configurations for usage monitoring"}}},"description":"Indicates the binary usage monitoring configuration for the software license","nullable":true}}}}}},"responses":{"200":{"description":"The Software License that was created/updated","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["PER_DEVICE","PER_USER","CUSTOM"]},"automated":{"type":"boolean"},"purchaseDate":{"type":"integer","format":"int64"},"publisherId":{"type":"integer","format":"int32"},"vendorId":{"type":"integer","format":"int32"},"publisher":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"vendor":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"scope":{"type":"object","properties":{"global":{"type":"boolean"},"organizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"organizationId":{"type":"integer","format":"int32"}}}}}},"quantity":{"type":"integer","format":"int32"},"term":{"type":"object","properties":{"renewalUnit":{"type":"string","enum":["MONTH","YEAR"]},"value":{"type":"integer","format":"int32"},"expirationDate":{"type":"integer","format":"int64"},"autoRenewal":{"type":"boolean"},"generateActivityAlert":{"type":"boolean"},"daysBeforeExpiration":{"type":"integer","format":"int32"},"hasNotifiedExpirationDate":{"type":"boolean"},"hasNotifiedUpToRenewal":{"type":"boolean"}}},"notificationChannelInfo":{"type":"object","properties":{"email":{"type":"string"},"sms":{"type":"string"},"pushNotification":{"type":"string"}}},"assigmentAutomationSettings":{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"licenseAssignmentList":{"type":"array","items":{"type":"object","properties":{"licenseeId":{"type":"integer","format":"int32"},"licenseeName":{"type":"string"},"licenseeType":{"type":"string","enum":["NODE","APP_USER","CONTACT"]},"licenseeUserType":{"type":"string","enum":["TECHNICIAN","END_USER","CONTACT"]},"licenseeOrganizationName":{"type":"string"},"licenseeOrganizationId":{"type":"integer","format":"int32"},"licenseeEmail":{"type":"string"},"firstFoundAt":{"type":"integer","format":"int64"},"lastUsedAt":{"type":"integer","format":"int64"},"hasViewAccess":{"type":"boolean"}}}},"currentUsage":{"type":"integer","format":"int32"},"expired":{"type":"boolean"},"daysToExpire":{"type":"integer","format":"int32"},"note":{"type":"string"},"perLicenseCost":{"type":"number"},"totalCost":{"type":"number"},"costMode":{"type":"string","enum":["TOTAL","PER_LICENSE"]},"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]},"usageMonitoring":{"type":"array","items":{"type":"object","properties":{"osType":{"type":"string","enum":["WINDOWS","LINUX","MAC"]},"binaryNames":{"type":"array","items":{"type":"string"}},"nonMatches":{"type":"boolean"}}}},"firstFoundAt":{"type":"integer","format":"int64"},"lastUsageAt":{"type":"integer","format":"int64"}}}}}}}}},"/v2/itam/unmanaged-device":{"post":{"tags":["Unmanaged Devices"],"summary":"Create an Unmanaged Device","description":"Create an Unmanaged Device with the provided details","operationId":"createUnmanagedDevicePublicApi","requestBody":{"description":"The Unmanaged Device to be created","content":{"application/json":{"schema":{"required":["locationId","name","orgId","roleId"],"type":"object","properties":{"name":{"maxLength":200,"minLength":0,"type":"string","description":"The display name of the device to be created"},"orgId":{"type":"integer","description":"The id of the organization the device belongs to","format":"int32"},"locationId":{"type":"integer","description":"The id of the location the device belongs to","format":"int32"},"roleId":{"type":"integer","description":"The id of the role to use for this device. Must be a sub-role of Unmanaged Device ","format":"int32"},"assignedUserUid":{"type":"string","description":"The UUID of the user this device is assigned to","format":"uuid"},"warrantyStartDate":{"type":"number","description":"The warranty start date for the device, in unix epoch seconds","format":"double"},"warrantyEndDate":{"type":"number","description":"The warranty end date for the device, in unix epoch seconds","format":"double"},"assetFields":{"type":"object","properties":{"serialNumber":{"type":"string","description":"The SerialNumber to use for the new device"},"assetId":{"type":"string","description":"The asset id to use for the new device"},"assetStatus":{"type":"string","description":"The asset status to use for the new device"},"assetPurchaseDate":{"type":"number","description":"The purchase date of the new device","format":"double"},"assetPurchaseAmount":{"type":"number","description":"The purchase amount of the new device","format":"double"},"assetExpectedLifetime":{"type":"string","description":"The expected lifetime of the new device"}},"description":"The asset information"}}}}}},"responses":{"200":{"description":"The id of the Unmanaged Device that was created","content":{"application/json":{"schema":{"type":"object","properties":{"nodeId":{"type":"integer","format":"int32"}}}}}}}}},"/v2/itam/unmanaged-device/{nodeId}/decommission":{"post":{"tags":["Unmanaged Devices"],"summary":"Decommission an Unmanaged Device","description":"Decommission an Unmanaged Device with the provided id","operationId":"decommissionUnmanagedDevicePublicApi","parameters":[{"name":"nodeId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"The Unmanaged Device was successfully decommissioned"},"400":{"description":"Request validation failed"},"403":{"description":"Insufficient permissions to perform operation"},"404":{"description":"An Unmanaged Device with the provided nodeId was not found"}}}},"/v2/itam/unmanaged-device/decommissionList":{"post":{"tags":["Unmanaged Devices"],"summary":"Decommission an Unmanaged Device List","description":"Decommission an Unmanaged Device List with the provided ids","operationId":"decommissionUnmanagedDevicePublicApiList","requestBody":{"content":{"application/json":{"schema":{"required":["nodeIds"],"type":"object","properties":{"nodeIds":{"maxItems":100,"minItems":0,"type":"array","description":"The ids of the devices to be decommissioned","items":{"type":"integer","description":"The ids of the devices to be decommissioned","format":"int32"}}}}}}},"responses":{"200":{"description":"The Unmanaged Device List was successfully decommissioned"},"400":{"description":"Request validation failed"},"403":{"description":"Insufficient permissions to perform operation"},"404":{"description":"An Unmanaged Device with the provided nodeId was not found"}}}},"/v2/itam/unmanaged-device/{nodeId}":{"put":{"tags":["Unmanaged Devices"],"summary":"Update an Unmanaged Device","description":"Update an Unmanaged Device with the provided details","operationId":"updateUnmanagedDevicePublicApi","parameters":[{"name":"nodeId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Details of the Unmanaged Device to be updated","content":{"application/json":{"schema":{"required":["locationId","name","orgId"],"type":"object","properties":{"name":{"maxLength":200,"minLength":0,"type":"string","description":"The display name of the device to be updated"},"orgId":{"type":"integer","description":"The id of the organization the device belongs to","format":"int32"},"locationId":{"type":"integer","description":"The id of the location the device belongs to","format":"int32"},"assignedUserUid":{"type":"string","description":"The UUID of the user this device is assigned to","format":"uuid"},"warrantyStartDate":{"type":"number","description":"The warranty start date for the device, in unix epoch seconds","format":"double"},"warrantyEndDate":{"type":"number","description":"The warranty end date for the device, in unix epoch seconds","format":"double"},"assetFields":{"type":"object","properties":{"serialNumber":{"type":"string","description":"The SerialNumber to use for the new device"},"assetId":{"type":"string","description":"The asset id to use for the new device"},"assetStatus":{"type":"string","description":"The asset status to use for the new device"},"assetPurchaseDate":{"type":"number","description":"The purchase date of the new device","format":"double"},"assetPurchaseAmount":{"type":"number","description":"The purchase amount of the new device","format":"double"},"assetExpectedLifetime":{"type":"string","description":"The expected lifetime of the new device"}},"description":"The asset information"}}}}}},"responses":{"202":{"description":"The Unmanaged Device was successfully updated"},"404":{"description":"An Unmanaged Device with the provided nodeId was not found"}}},"delete":{"tags":["Unmanaged Devices"],"summary":"Delete an Unmanaged Device","description":"Delete an Unmanaged Device with the provided id","operationId":"deleteUnmanagedDevicePublicApi","parameters":[{"name":"nodeId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"The Unmanaged Device was successfully deleted"},"404":{"description":"An Unmanaged Device with the provided nodeId was not found"}}}},"/v2/backup/bandwidth-throttle":{"post":{"tags":["Backup"],"summary":"Sets the bandwidth throttle for a device","description":"Sets the bandwidth throttle for a device","operationId":"setBandwidthThrottleForDevice","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"deviceId":{"type":"integer","format":"int32"},"bandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Request of the Device Bandwidth Throttle setting."}}}},"responses":{"200":{"description":"Returns SUCCESS if the bandwidth throttle was set, FAILURE otherwise."}}}},"/v2/backup/integrity-check-jobs":{"get":{"tags":["Backup"],"summary":"Integrity check jobs.","description":"Returns a list of integrity check jobs. If the stf (startTime) filter is not provided, results default to jobs starting since midnight UTC 7 days ago (a 7-8 day window depending on time of day); use stf to retrieve older jobs or a specific date range.","operationId":"getIntegrityCheckJobs","parameters":[{"name":"df","in":"query","description":"Device filter.","schema":{"type":"string"}},{"name":"ddf","in":"query","description":"Deleted device filter.","schema":{"type":"string"}},{"name":"sf","in":"query","description":"Backup job status filter.","schema":{"type":"string"}},{"name":"ptf","in":"query","description":"Backup job planType filter.","schema":{"type":"string"}},{"name":"stf","in":"query","description":"Backup job startTime filter. If omitted, defaults to jobs starting since midnight UTC 7 days ago, spanning 7-8 days depending on time of day. Format: 'after yyyy-MM-ddTHH:mm:ss.SSSZ' or 'between (yyyy-MM-ddTHH:mm:ss.SSSZ,yyyy-MM-ddTHH:mm:ss.SSSZ)', e.g. 'after 2026-05-01T00:00:00.000Z'.","schema":{"type":"string"}},{"name":"include","in":"query","description":"Which devices include (active|deleted|all) default value active.","schema":{"type":"string","default":"active"}},{"name":"cursor","in":"query","description":"Cursor name.","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page.","schema":{"maximum":10000,"minimum":1,"type":"integer","format":"int32","default":10000}}],"responses":{"200":{"description":"The integrity check job report.","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"jobId":{"type":"string","description":"Job id","format":"uuid"},"jobStartTime":{"type":"number","description":"Job start time","format":"double"},"jobEndTime":{"type":"number","description":"Job end time","format":"double"},"jobStatus":{"type":"string","description":"Job status"},"destination":{"type":"string","description":"Job destination"},"sourceJobId":{"type":"string","description":"Job source id","format":"uuid"},"planGuid":{"type":"string","description":"Plan id","format":"uuid"},"planName":{"type":"string","description":"Plan name"},"planType":{"type":"string","description":"Plan type"},"totalActualStorageBytes":{"type":"integer","description":"Total bytes","format":"int64"},"totalStoredBytes":{"type":"integer","description":"Total stored bytes","format":"int64"},"filesUploaded":{"type":"integer","description":"Files uploaded","format":"int64"},"organizationId":{"type":"integer","description":"Organization id","format":"int32"},"locationId":{"type":"integer","description":"Location id","format":"int32"},"deviceId":{"type":"integer","description":"Device id","format":"int32"},"upsyncJob":{"type":"object","properties":{"startTime":{"type":"number","description":"Upsync job start time","format":"double"},"endTime":{"type":"number","description":"Upsync job end time","format":"double"},"status":{"type":"string","description":"Upsync job status"},"filesUploaded":{"type":"integer","description":"Upsync job files uploaded","format":"int64"},"bytesUploaded":{"type":"integer","description":"Upsync job bytes uploaded","format":"int64"}},"description":"Upsync job details"}}}}}}}}}}},"post":{"tags":["Backup"],"summary":"Create an integrity check job","description":"Creates an integrity check job","operationId":"submitIntegrityCheckJob","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"deviceId":{"type":"integer","format":"int32"},"planUid":{"type":"string","format":"uuid"}},"description":"Request of the Integrity Check Job creation."}}}},"responses":{"200":{"description":"Returns SUCCESS if the job was saved correctly, FAILURE otherwise.","content":{"application/json":{"schema":{"type":"object","properties":{"result":{"type":"string","enum":["SUCCESS","FAILURE","UNSUPPORTED","UNCOMPLETED","MISSED"]},"jobUid":{"type":"string","format":"uuid"},"deviceId":{"type":"integer","format":"int32"},"planGuid":{"type":"string","format":"uuid"},"planName":{"type":"string"},"planType":{"type":"string"}},"description":"Response of the Integrity Check Job creation."}}}}}}},"/v2/billing/accounts":{"get":{"tags":["Billing"],"summary":"Get all accounts","description":"Returns a list with all existing accounts.","operationId":"getAllAccounts","responses":{"200":{"description":"List of accounts successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"title":"NinjaOneBillingAccountResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"code":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"system":{"type":"boolean"}},"description":"Representation of a ninja billing Account."}},"examples":{"Example account response list":{"description":"Example account response list","value":[{"id":1,"code":"ACCOUNT_NAME","name":"Account example name","description":"Optional description","system":false}]}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}}}},"post":{"tags":["Billing"],"summary":"Creates a new account","description":"Creates a new account given its content","operationId":"createAccount","requestBody":{"description":"New Account object to be added","content":{"application/json":{"schema":{"title":"NinjaOneBillingAccountRequest","required":["code","name"],"type":"object","properties":{"code":{"maxLength":20,"minLength":0,"type":"string","description":"Unique code used to identify the account.","example":"ACCOUNT_NAME"},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Display name of the account.","example":"Account example name"},"description":{"maxLength":250,"minLength":0,"type":"string","description":"Optional description of the account.","example":"This is an example description of the account."}},"description":"Representation of a ninja billing Account request."},"examples":{"Example account request":{"description":"Example account request","value":{"code":"ACCOUNT_NAME","name":"Account example name","description":"Optional description"}}}}},"required":true},"responses":{"200":{"description":"Account successfully created","content":{"application/json":{"schema":{"title":"NinjaOneBillingAccountResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"code":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"system":{"type":"boolean"}},"description":"Representation of a ninja billing Account."},"examples":{"Created account":{"description":"Created account","value":{"id":1,"code":"ACCOUNT_NAME","name":"Account example name","description":"Optional description","system":false}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}}}}},"/v2/billing/accounts/{id}":{"get":{"tags":["Billing"],"summary":"Get specific account","description":"Retrieve a specific account given its ID","operationId":"getAccountById","parameters":[{"name":"id","in":"path","description":"Account ID","required":true,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"Account successfully retrieved","content":{"application/json":{"schema":{"title":"NinjaOneBillingAccountResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"code":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"system":{"type":"boolean"}},"description":"Representation of a ninja billing Account."},"examples":{"Example account response":{"description":"Example account response","value":{"id":1,"code":"ACCOUNT_NAME","name":"Account example name","description":"Optional description","system":false}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}},"404":{"description":"Account not found","content":{"application/json":{"examples":{"Not Found":{"description":"Not Found","value":{"resultCode":"ninja_psa_account_not_found","incidentId":"WEB_MGMT_SERVICE-local-development-1769056132-JYBINGFK"}}}}}}}},"put":{"tags":["Billing"],"summary":"Updates an account","description":"Updates a previously created account given its ID and updated content","operationId":"updateAccount","parameters":[{"name":"id","in":"path","description":"Account ID","required":true,"schema":{"type":"integer","format":"int32"},"example":1}],"requestBody":{"description":"Updated Account object","content":{"application/json":{"schema":{"title":"NinjaOneBillingAccountRequest","required":["code","name"],"type":"object","properties":{"code":{"maxLength":20,"minLength":0,"type":"string","description":"Unique code used to identify the account.","example":"ACCOUNT_NAME"},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Display name of the account.","example":"Account example name"},"description":{"maxLength":250,"minLength":0,"type":"string","description":"Optional description of the account.","example":"This is an example description of the account."}},"description":"Representation of a ninja billing Account request."},"examples":{"Example account update request":{"description":"Example account update request","value":{"code":"ACCOUNT_NAME","name":"Account example name","description":"Optional description"}}}}},"required":true},"responses":{"200":{"description":"Account successfully updated","content":{"application/json":{"schema":{"title":"NinjaOneBillingAccountResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"code":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"system":{"type":"boolean"}},"description":"Representation of a ninja billing Account."},"examples":{"Updated account":{"description":"Updated account","value":{"id":1,"code":"ACCOUNT_NAME","name":"Account example name","description":"Optional description","system":false}}}}}},"400":{"description":"System accounts can not be updated","content":{"application/json":{"examples":{"Not Updatable":{"description":"Not Updatable","value":{"resultCode":"system_account_cannot_be_updated","incidentId":"WEB_MGMT_SERVICE-local-development-1769057080-KPMSENQU"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}},"404":{"description":"Account not found","content":{"application/json":{"examples":{"Not Found":{"description":"Not Found","value":{"resultCode":"ninja_psa_account_not_found","incidentId":"WEB_MGMT_SERVICE-local-development-1769056132-JYBINGFK"}}}}}}}},"delete":{"tags":["Billing"],"summary":"Deletes an account","description":"Deletes a previously created account given its ID","operationId":"deleteAccount","parameters":[{"name":"id","in":"path","description":"Account ID","required":true,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"403":{"description":"Forbidden - Insufficient permissions","content":{"*/*":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}}}}},"/v2/billing/agreements":{"get":{"tags":["Billing"],"summary":"Retrieves an agreement list.","description":"Retrieves an agreement list given some filter parameters.","operationId":"findAgreements","parameters":[{"name":"clientId","in":"query","description":"ID of the client for filtering agreements.","schema":{"type":"integer","format":"int32"},"example":1},{"name":"name","in":"query","description":"Filters agreements by agreement name (exact match).","schema":{"type":"string"},"example":"Agreement test name"},{"name":"isDefault","in":"query","description":"Filters agreements marked as default.","schema":{"type":"boolean"},"example":true},{"name":"productId","in":"query","description":"Filters agreements that contain a specific catalog product ID.","schema":{"type":"integer","format":"int32"},"example":10}],"responses":{"200":{"description":"Filtered agreement list.","content":{"application/json":{"schema":{"type":"array","items":{"title":"NinjaOneBillingListedAgreementResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"invoiceGenerationType":{"type":"string","enum":["AUTOMATIC","MANUAL","ONE_OFF"]},"lastBillDate":{"type":"number","format":"double","nullable":true},"nextBillDate":{"type":"string","nullable":true},"nextBillingPeriodStartDate":{"type":"string","nullable":true},"lastPeriodStartDate":{"type":"string","nullable":true},"lastPeriodEndDate":{"type":"string","nullable":true},"content":{"type":"object","properties":{"interval":{"type":"string","nullable":true},"billDate":{"type":"string","nullable":true},"startDate":{"type":"string"},"endDate":{"type":"string","nullable":true},"businessHours":{"type":"object","properties":{"twentyFourSeven":{"type":"boolean"},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"startHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"endHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"allDayClosed":{"type":"boolean"}}}}},"description":"Days and time the work registered in tickets will be registered as off hours."}}},"client":{"required":["deleted"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the client","format":"int32","example":789},"name":{"type":"string","description":"Name of the client","example":"Acme Corporation"},"deleted":{"type":"boolean","description":"Indicates if the client has been deleted","example":false}},"description":"Client information associated with this invoice"},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"},"timeDefault":{"type":"boolean"},"businessHoursSource":{"type":"string","enum":["CUSTOM","TICKETING"]},"taxId":{"type":"integer","format":"int32"},"archived":{"type":"boolean"},"active":{"type":"boolean"}},"description":"Representation of a ninja billing Agreement."}},"examples":{"Filtered agreement list":{"description":"Filtered agreement list","value":[{"id":1,"name":"Agreement listed example","description":"Agreement example description","invoiceGenerationType":"AUTOMATIC","isActive":true,"lastBillDate":null,"nextBillDate":"2026-01-23T00:00:00.000Z","nextBillingPeriodStartDate":"2026-01-01T00:00:00.000Z","lastPeriodStartDate":null,"lastPeriodEndDate":null,"content":{"interval":"ANNUAL","billDate":"2026-01-23T00:00:00.000Z","startDate":"2026-01-01T00:00:00.000Z","endDate":"2026-01-31T00:00:00.000Z","businessHours":{"twentyFourSeven":true,"days":[]}},"client":{"id":2,"name":"Main Org","deleted":false},"createTime":1767609233000,"updateTime":1767609233000,"timeDefault":false,"isArchived":false,"businessHoursSource":"CUSTOM"}]}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}},"500":{"description":"Permission not granted","content":{"application/json":{"examples":{"Organization access denied":{"description":"Organization access permission not granted","value":{"resultCode":"organization_access_violation","incidentId":"WEB_MGMT_SERVICE-local-development-1769103497-RLOIYCAG"}}}}}}}},"post":{"tags":["Billing"],"summary":"Creates an agreement.","description":"Creates an agreement with all his properties and products.","operationId":"create_1","requestBody":{"description":"Creates an agreement with all his properties and products.","content":{"application/json":{"schema":{"type":"object"},"examples":{"Agreement request object to be created.":{"description":"Agreement request object to be created.","value":{"name":"Agreement creation example","description":"Agreement creation example description","content":{"billDate":"2026-01-23T00:00:00.000Z","interval":"ANNUAL","startDate":"2026-01-01T00:00:00.000Z","endDate":"2026-01-31T00:00:00.000Z","businessHours":{"twentyFourSeven":false,"days":[{"day":"SUNDAY","startHour":28800,"endHour":61200,"allDayClosed":true},{"day":"MONDAY","startHour":28800,"endHour":61200,"allDayClosed":false},{"day":"TUESDAY","startHour":28800,"endHour":59400,"allDayClosed":false},{"day":"WEDNESDAY","startHour":28800,"endHour":61200,"allDayClosed":true},{"day":"THURSDAY","startHour":28800,"endHour":61200,"allDayClosed":true},{"day":"FRIDAY","startHour":28800,"endHour":61200,"allDayClosed":true},{"day":"SATURDAY","startHour":28800,"endHour":61200,"allDayClosed":true}]}},"invoiceGenerationType":"AUTOMATIC","clientId":2,"timeEntriesProducts":[{"name":"TimeEntry Product","description":"TimeEntry Product Description","quantityType":"TIME_ENTRIES","accountId":1,"group":false,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"content":{"price":10,"cost":5,"taxable":true,"billing":"BILLABLE","autoRoundTimeEntries":"ROUND_UP_15_MIN","laborCodes":[1],"onSiteMultiplier":21,"offHoursMultiplier":5,"remoteMultiplier":13,"normalHoursMultiplier":7,"scheduleTypeOffHours":true,"scheduleTypeNormalHours":true,"locationTypeOnSite":true,"locationTypeRemote":true,"includeTime":true,"includedTimeAmountUnlimited":false,"includedHours":0,"unusedCarryOverUnlimited":false,"carryOverLimit":0,"productIds":[],"userRoles":[]}}],"deviceCountsProducts":[{"name":"Managed Windows Servers","description":"Windows servers product","quantityType":"DEVICE_COUNTS","accountId":1,"group":true,"productUserRole":{"allowAllTechnicians":false,"userRoles":[6,3,1]},"content":{"price":60,"cost":23,"taxable":true,"billing":"BILLABLE","anyRole":false,"groupIds":[1,2],"allGroups":false,"nodeRoles":[1],"productIds":[]}}],"endUserCountsProducts":[{"name":"Managed EndUser","description":"Managed EndUser Description","quantityType":"END_USER_COUNTS","accountId":1,"group":false,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"content":{"price":10,"cost":5,"taxable":true,"billing":"BILLABLE","anyRole":true,"endUserRoles":[2],"matchAllRoles":true,"productIds":[]}}],"backupStorageCountsProducts":[{"name":"Managed Backup","description":"Managed Backup Description","quantityType":"BACKUP_STORAGE_COUNTS","accountId":1,"group":true,"productUserRole":{"allowAllTechnicians":false,"userRoles":[6,3,1]},"content":{"price":130,"cost":67,"taxable":true,"billing":"BILLABLE","anyRole":false,"groupIds":[1,2],"allGroups":false,"nodeRoles":[1],"isStorageIncludedPerDevice":false,"includedStorage":35,"productIds":[]}}],"softwareLicenseProducts":[{"id":1,"name":"Microsoft 365 Business Standard","description":"Microsoft 365 subscription with Office apps and cloud services","quantityType":"SOFTWARE_LICENSE","accountId":789,"group":false,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"content":{"price":12.5,"cost":8,"taxable":true,"billing":"PER_UNIT","productIds":[],"includeCount":50,"isQuantityInUse":true,"costSource":"MANUAL"}}],"products":[{"name":"Manual Product","description":"Manual Product Description","quantityType":"MANUAL","accountId":1,"group":true,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"content":{"cost":40,"price":15.5,"billing":"BILLABLE","taxable":true,"quantity":3,"productIds":[]}},{"name":"Manual Product","description":"Manual Product Description","quantityType":"MANUAL","accountId":1,"group":true,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"content":{"cost":40,"price":15.5,"billing":"BILLABLE","taxable":true,"quantity":3,"productIds":[]},"productId":1}],"multiMatchDevices":false,"multiMatchEndUsers":false,"multiMatchDeviceBackups":false,"businessHoursSource":"CUSTOM","nextBillingPeriodStartDate":"2026-01-01T00:00:00.000Z","billEmails":["test@mail.com"],"billCcEmails":["testcc@mail.com"],"billBccEmails":["testbcc@mail.com"],"invoiceNote":"invoice note example","nextBillDate":"2026-01-23T00:00:00.000Z","dueDays":30,"dueDaysSource":"CUSTOM","displayIncludedTimeOnInvoices":true,"ticketBillingSettings":{"billTicketInAnyStatus":false,"condition":{"operator":"not_in","value":"4000"}},"autoApproveInvoice":true,"autoCompleteInvoice":false,"quickBooks":null,"xero":{"externalTax":{"id":"OUTPUT","name":"Tax on Sales"},"taxlessItemsExternalTax":{"id":"INPUT","name":"Tax on Purchases"},"brandingTheme":{"id":"988b0fad-4d2e-4b41-9bd5-adcbc08d487d","name":"Standard"},"newInvoiceStatus":"SUBMITTED"}}}}}}},"responses":{"200":{"description":"Successfully created agreement.","content":{"application/json":{"schema":{"title":"NinjaOneBillingAgreementResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"invoiceGenerationType":{"type":"string","enum":["AUTOMATIC","MANUAL","ONE_OFF"]},"lastBillDate":{"type":"number","format":"double","nullable":true},"nextBillDate":{"type":"string","nullable":true},"nextBillingPeriodStartDate":{"type":"string","nullable":true},"lastPeriodStartDate":{"type":"string","nullable":true},"lastPeriodEndDate":{"type":"string","nullable":true},"content":{"type":"object","properties":{"interval":{"type":"string","nullable":true},"billDate":{"type":"string","nullable":true},"startDate":{"type":"string"},"endDate":{"type":"string","nullable":true},"businessHours":{"type":"object","properties":{"twentyFourSeven":{"type":"boolean"},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"startHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"endHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"allDayClosed":{"type":"boolean"}}}}},"description":"Days and time the work registered in tickets will be registered as off hours."}}},"contact":{"type":"object","properties":{"uid":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int32"},"clientId":{"type":"integer","format":"int32","nullable":true},"clientName":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string"},"deleted":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER","CONTACT"]},"enabled":{"type":"boolean"},"ninjaAdmin":{"type":"boolean"},"sysadmin":{"type":"boolean"}},"nullable":true},"taxRate":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"taxRate":{"type":"number"}},"nullable":true},"client":{"required":["deleted"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the client","format":"int32","example":789},"name":{"type":"string","description":"Name of the client","example":"Acme Corporation"},"deleted":{"type":"boolean","description":"Indicates if the client has been deleted","example":false}},"description":"Client information associated with this invoice"},"externalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"},"timeDefault":{"type":"boolean"},"businessHoursSource":{"type":"string","enum":["CUSTOM","TICKETING"]},"dueDaysSource":{"type":"string","enum":["CUSTOM","INHERIT_FROM_CONFIGURATION"]},"dueDays":{"type":"integer","format":"int32"},"allowOnlineCreditCardPayments":{"type":"boolean"},"allowOnlineAchPayments":{"type":"boolean"},"invoiceNote":{"type":"string"},"billEmails":{"type":"array","items":{"type":"string"}},"billCcEmails":{"type":"array","items":{"type":"string"}},"billBccEmails":{"type":"array","items":{"type":"string"}},"ticketBillingSettings":{"type":"object","properties":{"billTicketInAnyStatus":{"type":"boolean"},"condition":{"type":"object","properties":{"operator":{"type":"string"},"value":{"type":"string"},"metadata":{"uniqueItems":true,"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}},"nullable":true}}},"nullable":true}},"nullable":true},"multiMatchEndUsers":{"type":"boolean"},"multiMatchDevices":{"type":"boolean"},"products":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"deviceCountsProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"timeEntriesProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"endUserCountsProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"backupStorageCountsProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"softwareLicenseProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"multiMatchDeviceBackups":{"type":"boolean"},"displayIncludedTimeOnInvoices":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"autoApproveInvoice":{"type":"boolean"},"autoCompleteInvoice":{"type":"boolean"},"quickBooks":{"type":"object","properties":{"externalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"allowOnlineCreditCardPayments":{"type":"boolean"},"allowOnlineAchPayments":{"type":"boolean"}}},"xero":{"type":"object","properties":{"externalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"brandingTheme":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"nullable":true},"taxlessItemsExternalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"nullable":true},"newInvoiceStatus":{"type":"string","enum":["DRAFT","SUBMITTED","AUTHORISED"]}}},"archived":{"type":"boolean"},"active":{"type":"boolean"}},"description":"Representation of a ninja billing Agreement."}}}},"400":{"description":"Bad request - agreement validation","content":{"application/json":{"examples":{"Interval missing":{"description":"Automatic agreements require interval value","value":{"resultCode":"invalid_request","errorMessage":"Interval is mandatory when invoice type generation is AUTOMATIC","incidentId":"WEB_MGMT_SERVICE-local-development-1769104598-JFVIUYMU"}},"Bill date missing":{"description":"Automatic agreements require bill date value","value":{"resultCode":"invalid_request","errorMessage":"Bill date is mandatory when invoice type generation is AUTOMATIC","incidentId":"WEB_MGMT_SERVICE-local-development-1769104630-CYVTFMLV"}},"Interval and bill date values error":{"description":"Manual agreements require both bill date and interval values present or missing","value":{"resultCode":"invalid_request","errorMessage":"Bill date and Interval should be both or none provided when MANUAL invoice type generation is selected","incidentId":"WEB_MGMT_SERVICE-local-development-1769105579-MJJKWQOS"}},"Wrong start date format":{"description":"Agreement date format is invalid","value":{"resultCode":"invalid_date","errorMessage":"The date provided is not valid. Expected format is yyyy-MM-dd","incidentId":"WEB_MGMT_SERVICE-local-development-1769106011-WBHUBCKK"}},"End date in the past":{"description":"For Automatic agreements end date can not be prior to today","value":{"resultCode":"invalid_end_date","errorMessage":"End date can not be less than division's today, but it can be today when there is not last bill date and invoice generation type is automatic","incidentId":"WEB_MGMT_SERVICE-local-development-1769106768-OZDIDEBE"}},"Wrong ticket business hours":{"description":"If business hours source is TICKETING, the actual hours should be empty","value":{"resultCode":"invalid_business_hours","errorMessage":"Business hours should be empty when source is TICKETING","incidentId":"WEB_MGMT_SERVICE-local-development-1769109099-MKXITFRB"}},"Wrong custom business hours":{"description":"If business hours source is CUSTOM, the actual hours should not be empty","value":{"resultCode":"invalid_business_hours","errorMessage":"Business hours should not be empty or null when source is CUSTOM","incidentId":"WEB_MGMT_SERVICE-local-development-1769109323-FHQTKHRJ"}},"Product Group Child Deactivated Validation Error":{"description":"Deactivated products cannot be used within product groups.","value":{"resultCode":"child_product_group_must_be_active","incidentId":"WEB_MGMT_SERVICE-local-development-1767809599-SRTUMBgA"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}},"409":{"description":"Duplicated agreement","content":{"application/json":{"examples":{"Duplicated":{"description":"Duplicated","value":{"resultCode":"agreement_name_already_taken_for_current_organization","incidentId":"WEB_MGMT_SERVICE-local-development-1769104660-VKAJKIDD"}}}}}},"500":{"description":"Permission not granted","content":{"application/json":{"examples":{"Organization access denied":{"description":"Organization access permission not granted","value":{"resultCode":"organization_access_violation","incidentId":"WEB_MGMT_SERVICE-local-development-1769103497-RLOIYCAG"}}}}}}}}},"/v2/billing/agreements/{id}/deactivate":{"patch":{"tags":["Billing"],"summary":"Deactivate agreement","description":"Deactivates an agreement given its ID","operationId":"deactivateAgreement","parameters":[{"name":"id","in":"path","description":"Agreement ID to deactivate","required":true,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"400":{"description":"Bad request - agreement deactivation","content":{"*/*":{"examples":{"Default agreement deactivation":{"description":"A default agreement can not be deactivated","value":{"resultCode":"cannot_deactivate_a_default_agreement","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"*/*":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}},"404":{"description":"Agreement not found","content":{"*/*":{"examples":{"Not Found":{"description":"Not Found","value":{"resultCode":"agreement_not_found","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}}}}}},"500":{"description":"Permission not granted","content":{"*/*":{"examples":{"Organization access denied":{"description":"Organization access permission not granted","value":{"resultCode":"organization_access_violation","incidentId":"WEB_MGMT_SERVICE-local-development-1769103497-RLOIYCAG"}}}}}}}}},"/v2/billing/agreements/{id}":{"get":{"tags":["Billing"],"summary":"Retrieves an agreement given its ID.","description":"Retrieves an agreement with a specific ID.","operationId":"findAgreementById","parameters":[{"name":"id","in":"path","description":"Agreement ID","required":true,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"Found agreement.","content":{"application/json":{"schema":{"title":"NinjaOneBillingAgreementResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"invoiceGenerationType":{"type":"string","enum":["AUTOMATIC","MANUAL","ONE_OFF"]},"lastBillDate":{"type":"number","format":"double","nullable":true},"nextBillDate":{"type":"string","nullable":true},"nextBillingPeriodStartDate":{"type":"string","nullable":true},"lastPeriodStartDate":{"type":"string","nullable":true},"lastPeriodEndDate":{"type":"string","nullable":true},"content":{"type":"object","properties":{"interval":{"type":"string","nullable":true},"billDate":{"type":"string","nullable":true},"startDate":{"type":"string"},"endDate":{"type":"string","nullable":true},"businessHours":{"type":"object","properties":{"twentyFourSeven":{"type":"boolean"},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"startHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"endHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"allDayClosed":{"type":"boolean"}}}}},"description":"Days and time the work registered in tickets will be registered as off hours."}}},"contact":{"type":"object","properties":{"uid":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int32"},"clientId":{"type":"integer","format":"int32","nullable":true},"clientName":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string"},"deleted":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER","CONTACT"]},"enabled":{"type":"boolean"},"ninjaAdmin":{"type":"boolean"},"sysadmin":{"type":"boolean"}},"nullable":true},"taxRate":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"taxRate":{"type":"number"}},"nullable":true},"client":{"required":["deleted"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the client","format":"int32","example":789},"name":{"type":"string","description":"Name of the client","example":"Acme Corporation"},"deleted":{"type":"boolean","description":"Indicates if the client has been deleted","example":false}},"description":"Client information associated with this invoice"},"externalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"},"timeDefault":{"type":"boolean"},"businessHoursSource":{"type":"string","enum":["CUSTOM","TICKETING"]},"dueDaysSource":{"type":"string","enum":["CUSTOM","INHERIT_FROM_CONFIGURATION"]},"dueDays":{"type":"integer","format":"int32"},"allowOnlineCreditCardPayments":{"type":"boolean"},"allowOnlineAchPayments":{"type":"boolean"},"invoiceNote":{"type":"string"},"billEmails":{"type":"array","items":{"type":"string"}},"billCcEmails":{"type":"array","items":{"type":"string"}},"billBccEmails":{"type":"array","items":{"type":"string"}},"ticketBillingSettings":{"type":"object","properties":{"billTicketInAnyStatus":{"type":"boolean"},"condition":{"type":"object","properties":{"operator":{"type":"string"},"value":{"type":"string"},"metadata":{"uniqueItems":true,"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}},"nullable":true}}},"nullable":true}},"nullable":true},"multiMatchEndUsers":{"type":"boolean"},"multiMatchDevices":{"type":"boolean"},"products":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"deviceCountsProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"timeEntriesProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"endUserCountsProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"backupStorageCountsProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"softwareLicenseProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"multiMatchDeviceBackups":{"type":"boolean"},"displayIncludedTimeOnInvoices":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"autoApproveInvoice":{"type":"boolean"},"autoCompleteInvoice":{"type":"boolean"},"quickBooks":{"type":"object","properties":{"externalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"allowOnlineCreditCardPayments":{"type":"boolean"},"allowOnlineAchPayments":{"type":"boolean"}}},"xero":{"type":"object","properties":{"externalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"brandingTheme":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"nullable":true},"taxlessItemsExternalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"nullable":true},"newInvoiceStatus":{"type":"string","enum":["DRAFT","SUBMITTED","AUTHORISED"]}}},"archived":{"type":"boolean"},"active":{"type":"boolean"}},"description":"Representation of a ninja billing Agreement."}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}},"404":{"description":"Agreement not found","content":{"application/json":{"examples":{"Not Found":{"description":"Not Found","value":{"resultCode":"agreement_not_found","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}}}}}},"500":{"description":"Permission not granted","content":{"application/json":{"examples":{"Organization access denied":{"description":"Organization access permission not granted","value":{"resultCode":"organization_access_violation","incidentId":"WEB_MGMT_SERVICE-local-development-1769103497-RLOIYCAG"}}}}}}}},"put":{"tags":["Billing"],"summary":"Updates an agreement.","description":"Updates an agreement with all his properties and products.","operationId":"update_1","parameters":[{"name":"id","in":"path","description":"Agreement ID","required":true,"schema":{"type":"integer","format":"int32"},"example":1}],"requestBody":{"description":"Agreement request object to be updated.","content":{"application/json":{"schema":{"title":"NinjaOneBillingAgreementRequest","required":["autoApproveInvoice","autoCompleteInvoice","displayIncludedTimeOnInvoices","invoiceNote","multiMatchEndUsers","name"],"type":"object","properties":{"name":{"maxLength":50,"minLength":0,"type":"string","description":"Agreement name.","example":"Agreement Example Name"},"description":{"maxLength":250,"minLength":0,"type":"string","description":"Agreement description.","example":"Agreement description example."},"products":{"type":"array","description":"List of manual quantity type products.","items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"deviceCountsProducts":{"type":"array","writeOnly":true,"items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"softwareLicenseProducts":{"type":"array","description":"List of software license quantity type products.","items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"backupStorageCountsProducts":{"type":"array","writeOnly":true,"items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"timeEntriesProducts":{"type":"array","writeOnly":true,"items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"endUserCountsProducts":{"type":"array","writeOnly":true,"items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"content":{"title":"NinjaOneBillingAgreementContentRequest","required":["endDate","startDate"],"type":"object","properties":{"startDate":{"type":"string","description":"Effective start date of the agreement. Invoices will be generated from this date.","format":"date","example":"2026-01-09T00:00:00.000Z"},"endDate":{"type":"string","description":"Effective end date of the agreement. Invoices will not be generated from this date.","format":"date","example":"2026-09-23T00:00:00.000Z"},"businessHours":{"type":"object","properties":{"twentyFourSeven":{"type":"boolean"},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"startHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"endHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"allDayClosed":{"type":"boolean"}}}}},"description":"Days and time the work registered in tickets will be registered as off hours."},"interval":{"type":"string","description":"How frequent the automatic agreements will generate invoices.","example":"MONTHLY","enum":["ANNUAL","SEMIANNUAL","QUARTERLY","MONTHLY","BIMONTHLY","BIWEEKLY","WEEKLY","ONE_TIME"]},"billDate":{"type":"string","description":"\n                    Date or day when the invoice will be generated, depending on the billing interval:\n                    - ANNUAL: Day of the year for the invoice to be generated,\n                    even if it is in the past will be updated to the next year eg. \"2026-01-01\"\n                    - QUARTERLY: Day of the month for the invoice to be generated each quarter eg. \"23\"\n                    - MONTHLY: Day of the month for the invoice to be generated eg. \"5\"\n                    - WEEKLY: Day of the week for the invoice to be generated eg. \"WEDNESDAY\"\n                    - ONE_TIME: Specific invoice date for the invoice to be generated eg. \"2026-01-09\"\n                ","example":"MONDAY"}},"description":"Representation of a ninja billing Agreement content request."},"clientId":{"minimum":1,"type":"integer","description":"ID of the organization owner of the agreement.","format":"int32","example":2},"invoiceGenerationType":{"type":"string","description":"How the agreement invoices will be generated.","example":"MANUAL","enum":["AUTOMATIC","MANUAL","ONE_OFF"]},"multiMatchDevices":{"type":"boolean","description":"Match multiple devices when counting to generate invoices.","example":true},"multiMatchDeviceBackups":{"type":"boolean","description":"Match multiple backup devices when counting to generate invoices.","example":true},"multiMatchEndUsers":{"type":"boolean","description":"Match multiple end user devices when counting to generate invoices.","example":true},"billEmails":{"uniqueItems":true,"type":"array","description":"Primary recipient email addresses to export to 3rd party integration when invoicing.","example":["test@mail.com"],"items":{"type":"string","description":"Primary recipient email addresses to export to 3rd party integration when invoicing.","example":"[\"test@mail.com\"]"}},"billCcEmails":{"uniqueItems":true,"type":"array","description":"Copy recipient email addresses to export to 3rd party integration when invoicing.","example":["testcc@mail.com"],"items":{"type":"string","description":"Copy recipient email addresses to export to 3rd party integration when invoicing.","example":"[\"testcc@mail.com\"]"}},"billBccEmails":{"uniqueItems":true,"type":"array","description":"Hidden primary recipient email addresses to export to 3rd party integration when invoicing.","example":["testbcc@mail.com"],"items":{"type":"string","description":"Hidden primary recipient email addresses to export to 3rd party integration when invoicing.","example":"[\"testbcc@mail.com\"]"}},"businessHoursSource":{"type":"string","description":"Where to pick business hours configuration, could be inherited from general configuration or custom.","example":"TICKETING","enum":["CUSTOM","TICKETING"]},"nextBillDate":{"type":"string","description":"When the next invoice will be automatically generated.","format":"date","example":"2026-01-09T00:00:00.000Z"},"nextBillingPeriodStartDate":{"type":"string","description":"When the next billing period will start to count for the next invoice.","format":"date","example":"2026-01-01T00:00:00.000Z"},"displayIncludedTimeOnInvoices":{"type":"boolean","description":"Show time entries that have been billed against an included amount of hours on invoices.","example":true},"dueDaysSource":{"type":"string","description":"Where the agreement will obtain the information about due days.","example":"CUSTOM","enum":["CUSTOM","INHERIT_FROM_CONFIGURATION"]},"dueDays":{"type":"integer","description":"How many days an invoice has to be payed after invoiced.","format":"int32","example":30},"ticketBillingSettings":{"title":"NinjaOneBillingTicketSettingsRequest","required":["billTicketInAnyStatus"],"type":"object","properties":{"billTicketInAnyStatus":{"type":"boolean","description":"Whether a ticket can be billed in any status or under specific conditions.","example":true},"condition":{"title":"NinjaOneBillingTicketSettingsRequest","required":["operator","value"],"type":"object","properties":{"operator":{"type":"string","description":"Operation to evaluate the ticket state.","example":"parent_in","enum":["in","not_in","parent_in","parent_not_in"]},"value":{"type":"string","description":"Allowed ticket states defined.","example":"new"}},"description":"Ticket state conditions under which a ticket will be invoiced."}},"description":"Representation of a ninja billing ticket settings request."},"autoApproveInvoice":{"type":"boolean","description":"Whether invoices generated from the agreement will be automatically approved when generated.","example":true},"autoCompleteInvoice":{"type":"boolean","description":"Whether invoices generated from the agreement will be automatically completed when approved.","example":true},"taxId":{"type":"integer","description":"ID of the tax to be applied to the agreement.","format":"int32","example":1},"quickBooks":{"title":"NinjaOneBillingQuickBooksAgreementIntegrationDataRequest","required":["allowOnlineAchPayments","allowOnlineCreditCardPayments"],"type":"object","properties":{"externalTax":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."},"allowOnlineCreditCardPayments":{"type":"boolean","description":"Specifies if online credit card payments are allowed for this invoice and corresponds to the Credit card check box on the QuickBooks UI.","example":true},"allowOnlineAchPayments":{"type":"boolean","description":"Specifies if this invoice can be paid with online bank transfers and corresponds to the Bank transfer check box on the QuickBooks UI.","example":true},"externalTaxRequest":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."}},"description":"Quickbooks integration agreement specific data.","nullable":true},"xero":{"title":"NinjaOneBillingXeroAgreementIntegrationDataRequest","type":"object","properties":{"externalTax":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."},"taxlessItemsExternalTax":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Not billable products external integration tax rate."},"brandingTheme":{"title":"NinjaOneBillingXeroBrandingThemeRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Xero integration branding theme specific data."},"newInvoiceStatus":{"type":"string","description":"Xero invoice status.","enum":["DRAFT","SUBMITTED","AUTHORISED"]},"externalTaxRequest":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."},"taxlessItemsExternalTaxRequest":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Not billable products external integration tax rate."},"brandingThemeRequest":{"title":"NinjaOneBillingXeroBrandingThemeRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Xero integration branding theme specific data."}},"description":"Xero integration agreement specific data.","nullable":true},"managedDeviceProducts":{"type":"array","description":"List of device count quantity type products.","items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"managedDeviceBackupProducts":{"type":"array","description":"List of backup storage count quantity type products.","items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"laborTicketTimeEntryProducts":{"type":"array","description":"List of time entry quantity type products.","items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"managedEndUserProducts":{"type":"array","description":"List of end user count quantity type products.","items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"invoiceNote":{"maxLength":250,"minLength":0,"type":"string","description":"String message added to invoices generated from the agreement.","example":"Invoice note example."},"quickBooksAgreementIntegrationDataRequest":{"title":"NinjaOneBillingQuickBooksAgreementIntegrationDataRequest","required":["allowOnlineAchPayments","allowOnlineCreditCardPayments"],"type":"object","properties":{"externalTax":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."},"allowOnlineCreditCardPayments":{"type":"boolean","description":"Specifies if online credit card payments are allowed for this invoice and corresponds to the Credit card check box on the QuickBooks UI.","example":true},"allowOnlineAchPayments":{"type":"boolean","description":"Specifies if this invoice can be paid with online bank transfers and corresponds to the Bank transfer check box on the QuickBooks UI.","example":true},"externalTaxRequest":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."}},"description":"Quickbooks integration agreement specific data.","nullable":true},"xeroAgreementIntegrationDataRequest":{"title":"NinjaOneBillingXeroAgreementIntegrationDataRequest","type":"object","properties":{"externalTax":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."},"taxlessItemsExternalTax":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Not billable products external integration tax rate."},"brandingTheme":{"title":"NinjaOneBillingXeroBrandingThemeRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Xero integration branding theme specific data."},"newInvoiceStatus":{"type":"string","description":"Xero invoice status.","enum":["DRAFT","SUBMITTED","AUTHORISED"]},"externalTaxRequest":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."},"taxlessItemsExternalTaxRequest":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Not billable products external integration tax rate."},"brandingThemeRequest":{"title":"NinjaOneBillingXeroBrandingThemeRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Xero integration branding theme specific data."}},"description":"Xero integration agreement specific data.","nullable":true},"multiMatchSoftwareLicenses":{"type":"boolean","description":"Match multiple software licenses when counting to generate invoices.","example":true}},"description":"Representation of a ninja billing Agreement creation request."},"examples":{"Agreement request example":{"description":"Example for updating an agreement","value":{"name":"Agreement creation example","description":"Agreement creation example description","content":{"billDate":"2026-01-23T00:00:00.000Z","interval":"ANNUAL","startDate":"2026-01-01T00:00:00.000Z","endDate":"2026-01-31T00:00:00.000Z","businessHours":{"twentyFourSeven":false,"days":[{"day":"SUNDAY","startHour":28800,"endHour":61200,"allDayClosed":true},{"day":"MONDAY","startHour":28800,"endHour":61200,"allDayClosed":false},{"day":"TUESDAY","startHour":28800,"endHour":59400,"allDayClosed":false},{"day":"WEDNESDAY","startHour":28800,"endHour":61200,"allDayClosed":true},{"day":"THURSDAY","startHour":28800,"endHour":61200,"allDayClosed":true},{"day":"FRIDAY","startHour":28800,"endHour":61200,"allDayClosed":true},{"day":"SATURDAY","startHour":28800,"endHour":61200,"allDayClosed":true}]}},"invoiceGenerationType":"AUTOMATIC","clientId":2,"timeEntriesProducts":[{"name":"TimeEntry Product","description":"TimeEntry Product Description","quantityType":"TIME_ENTRIES","accountId":1,"group":false,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"content":{"price":10,"cost":5,"taxable":true,"billing":"BILLABLE","autoRoundTimeEntries":"ROUND_UP_15_MIN","laborCodes":[1],"onSiteMultiplier":21,"offHoursMultiplier":5,"remoteMultiplier":13,"normalHoursMultiplier":7,"scheduleTypeOffHours":true,"scheduleTypeNormalHours":true,"locationTypeOnSite":true,"locationTypeRemote":true,"includeTime":true,"includedTimeAmountUnlimited":false,"includedHours":0,"unusedCarryOverUnlimited":false,"carryOverLimit":0,"productIds":[],"userRoles":[]}}],"deviceCountsProducts":[{"name":"Managed Windows Servers","description":"Windows servers product","quantityType":"DEVICE_COUNTS","accountId":1,"group":true,"productUserRole":{"allowAllTechnicians":false,"userRoles":[6,3,1]},"content":{"price":60,"cost":23,"taxable":true,"billing":"BILLABLE","anyRole":false,"groupIds":[1,2],"allGroups":false,"nodeRoles":[1],"productIds":[]}}],"endUserCountsProducts":[{"name":"Managed EndUser","description":"Managed EndUser Description","quantityType":"END_USER_COUNTS","accountId":1,"group":false,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"content":{"price":10,"cost":5,"taxable":true,"billing":"BILLABLE","anyRole":true,"endUserRoles":[2],"matchAllRoles":true,"productIds":[]}}],"backupStorageCountsProducts":[{"name":"Managed Backup","description":"Managed Backup Description","quantityType":"BACKUP_STORAGE_COUNTS","accountId":1,"group":true,"productUserRole":{"allowAllTechnicians":false,"userRoles":[6,3,1]},"content":{"price":130,"cost":67,"taxable":true,"billing":"BILLABLE","anyRole":false,"groupIds":[1,2],"allGroups":false,"nodeRoles":[1],"isStorageIncludedPerDevice":false,"includedStorage":35,"productIds":[]}}],"softwareLicenseProducts":[{"id":1,"name":"Microsoft 365 Business Standard","description":"Microsoft 365 subscription with Office apps and cloud services","quantityType":"SOFTWARE_LICENSE","accountId":789,"group":false,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"content":{"price":12.5,"cost":8,"taxable":true,"billing":"PER_UNIT","productIds":[],"includeCount":50,"isQuantityInUse":true,"costSource":"MANUAL"}}],"products":[{"name":"Manual Product","description":"Manual Product Description","quantityType":"MANUAL","accountId":1,"group":true,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"content":{"cost":40,"price":15.5,"billing":"BILLABLE","taxable":true,"quantity":3,"productIds":[]}},{"name":"Manual Product","description":"Manual Product Description","quantityType":"MANUAL","accountId":1,"group":true,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"content":{"cost":40,"price":15.5,"billing":"BILLABLE","taxable":true,"quantity":3,"productIds":[]},"productId":1}],"multiMatchDevices":false,"multiMatchEndUsers":false,"multiMatchDeviceBackups":false,"businessHoursSource":"CUSTOM","nextBillingPeriodStartDate":"2026-01-01T00:00:00.000Z","billEmails":["test@mail.com"],"billCcEmails":["testcc@mail.com"],"billBccEmails":["testbcc@mail.com"],"invoiceNote":"invoice note example","nextBillDate":"2026-01-23T00:00:00.000Z","dueDays":30,"dueDaysSource":"CUSTOM","displayIncludedTimeOnInvoices":true,"ticketBillingSettings":{"billTicketInAnyStatus":false,"condition":{"operator":"not_in","value":"4000"}},"autoApproveInvoice":true,"autoCompleteInvoice":false,"quickBooks":null,"xero":{"externalTax":{"id":"OUTPUT","name":"Tax on Sales"},"taxlessItemsExternalTax":{"id":"INPUT","name":"Tax on Purchases"},"brandingTheme":{"id":"988b0fad-4d2e-4b41-9bd5-adcbc08d487d","name":"Standard"},"newInvoiceStatus":"SUBMITTED"}}}}}},"required":true},"responses":{"200":{"description":"Successfully updated agreement.","content":{"application/json":{"schema":{"title":"NinjaOneBillingAgreementResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"invoiceGenerationType":{"type":"string","enum":["AUTOMATIC","MANUAL","ONE_OFF"]},"lastBillDate":{"type":"number","format":"double","nullable":true},"nextBillDate":{"type":"string","nullable":true},"nextBillingPeriodStartDate":{"type":"string","nullable":true},"lastPeriodStartDate":{"type":"string","nullable":true},"lastPeriodEndDate":{"type":"string","nullable":true},"content":{"type":"object","properties":{"interval":{"type":"string","nullable":true},"billDate":{"type":"string","nullable":true},"startDate":{"type":"string"},"endDate":{"type":"string","nullable":true},"businessHours":{"type":"object","properties":{"twentyFourSeven":{"type":"boolean"},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"startHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"endHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"allDayClosed":{"type":"boolean"}}}}},"description":"Days and time the work registered in tickets will be registered as off hours."}}},"contact":{"type":"object","properties":{"uid":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int32"},"clientId":{"type":"integer","format":"int32","nullable":true},"clientName":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string"},"deleted":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER","CONTACT"]},"enabled":{"type":"boolean"},"ninjaAdmin":{"type":"boolean"},"sysadmin":{"type":"boolean"}},"nullable":true},"taxRate":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"taxRate":{"type":"number"}},"nullable":true},"client":{"required":["deleted"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the client","format":"int32","example":789},"name":{"type":"string","description":"Name of the client","example":"Acme Corporation"},"deleted":{"type":"boolean","description":"Indicates if the client has been deleted","example":false}},"description":"Client information associated with this invoice"},"externalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"},"timeDefault":{"type":"boolean"},"businessHoursSource":{"type":"string","enum":["CUSTOM","TICKETING"]},"dueDaysSource":{"type":"string","enum":["CUSTOM","INHERIT_FROM_CONFIGURATION"]},"dueDays":{"type":"integer","format":"int32"},"allowOnlineCreditCardPayments":{"type":"boolean"},"allowOnlineAchPayments":{"type":"boolean"},"invoiceNote":{"type":"string"},"billEmails":{"type":"array","items":{"type":"string"}},"billCcEmails":{"type":"array","items":{"type":"string"}},"billBccEmails":{"type":"array","items":{"type":"string"}},"ticketBillingSettings":{"type":"object","properties":{"billTicketInAnyStatus":{"type":"boolean"},"condition":{"type":"object","properties":{"operator":{"type":"string"},"value":{"type":"string"},"metadata":{"uniqueItems":true,"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}},"nullable":true}}},"nullable":true}},"nullable":true},"multiMatchEndUsers":{"type":"boolean"},"multiMatchDevices":{"type":"boolean"},"products":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"deviceCountsProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"timeEntriesProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"endUserCountsProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"backupStorageCountsProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"softwareLicenseProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"multiMatchDeviceBackups":{"type":"boolean"},"displayIncludedTimeOnInvoices":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"autoApproveInvoice":{"type":"boolean"},"autoCompleteInvoice":{"type":"boolean"},"quickBooks":{"type":"object","properties":{"externalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"allowOnlineCreditCardPayments":{"type":"boolean"},"allowOnlineAchPayments":{"type":"boolean"}}},"xero":{"type":"object","properties":{"externalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"brandingTheme":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"nullable":true},"taxlessItemsExternalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"nullable":true},"newInvoiceStatus":{"type":"string","enum":["DRAFT","SUBMITTED","AUTHORISED"]}}},"archived":{"type":"boolean"},"active":{"type":"boolean"}},"description":"Representation of a ninja billing Agreement."}}}},"400":{"description":"Bad request - interval value","content":{"application/json":{"examples":{"Interval missing":{"description":"Automatic agreements require interval value","value":{"resultCode":"invalid_request","errorMessage":"Interval is mandatory when invoice type generation is AUTOMATIC","incidentId":"WEB_MGMT_SERVICE-local-development-1769104598-JFVIUYMU"}},"Product Group Child Deactivated Validation Error":{"description":"Deactivated products cannot be used within product groups.","value":{"resultCode":"child_product_group_must_be_active","incidentId":"WEB_MGMT_SERVICE-local-development-1767809599-SRTUMBgA"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}},"404":{"description":"Agreement not found","content":{"application/json":{"examples":{"Not Found":{"description":"Not Found","value":{"resultCode":"agreement_not_found","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}}}}}},"409":{"description":"Duplicated agreement","content":{"application/json":{"examples":{"Duplicated":{"description":"Duplicated","value":{"resultCode":"agreement_name_already_taken_for_current_organization","incidentId":"WEB_MGMT_SERVICE-local-development-1769104660-VKAJKIDD"}}}}}},"500":{"description":"Permission not granted","content":{"application/json":{"examples":{"Organization access denied":{"description":"Organization access permission not granted","value":{"resultCode":"organization_access_violation","incidentId":"WEB_MGMT_SERVICE-local-development-1769103497-RLOIYCAG"}}}}}}}}},"/v2/billing/invoices/approve":{"post":{"tags":["Billing"],"summary":"Approves invoices","description":"Approves one or more invoices by changing their status from PENDING to APPROVED.\n\n**Important:** Only invoices in PENDING status can be approved. All provided invoice IDs must correspond to existing PENDING invoices, otherwise the entire request will fail.","operationId":"approveInvoices","requestBody":{"description":"Request containing the IDs of invoices to approve","content":{"*/*":{"schema":{"required":["invoiceIds"],"type":"object","properties":{"invoiceIds":{"uniqueItems":true,"type":"array","description":"Set of invoice IDs to approve","example":[123,124,125],"items":{"type":"integer","description":"Set of invoice IDs to approve","format":"int32"}}},"description":"Request to approve one or more invoices"},"examples":{"Approve invoices":{"description":"Example for approving multiple invoices","value":{"invoiceIds":[123,124,125]}}}}},"required":true},"responses":{"200":{"description":"Invoices successfully approved","content":{"application/json":{"schema":{"type":"object"},"examples":{"Approved invoice IDs":{"description":"Approved invoice IDs","value":{"approvedInvoiceIds":[123,124,125]}}}}}},"400":{"description":"Bad request - Invalid invoice IDs or invoices not in PENDING status","content":{"application/json":{"examples":{"Invalid Invoices":{"description":"One or more invoices are not in PENDING status or do not exist","value":{"errorCode":"invalid_invoices","message":"One or more invoices are not in PENDING status or do not exist"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}}}}},"/v2/billing/invoices/archive":{"post":{"tags":["Billing"],"summary":"Archive invoices","description":"Archives one or more invoices by changing their status to ARCHIVED.","operationId":"archiveInvoices","requestBody":{"description":"Request containing the IDs of invoices to archive","content":{"application/json":{"schema":{"required":["invoiceIds"],"type":"object","properties":{"invoiceIds":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}},"examples":{"Archive invoices":{"description":"Example for archiving multiple invoices","value":{"invoiceIds":[123,456,789]}}}}},"required":true},"responses":{"200":{"description":"Invoices successfully archived","content":{"application/json":{"schema":{"type":"object"},"examples":{"Archived invoice IDs":{"description":"Archived invoice IDs","value":{"archivedInvoiceIds":[123,456,789]}}}}}},"400":{"description":"Bad request - Invalid invoice IDs","content":{"application/json":{}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{}}}}}},"/v2/billing/invoices":{"get":{"tags":["Billing"],"summary":"Get all invoices","description":"Returns a list of invoices with optional filters","operationId":"getInvoices","parameters":[{"name":"clientId","in":"query","description":"Filter invoices by organization/client ID.","schema":{"type":"integer","format":"int32"},"example":789},{"name":"agreementId","in":"query","description":"Filter invoices by agreement ID.","schema":{"type":"integer","format":"int32"},"example":456},{"name":"createdDateFrom","in":"query","description":"Filter invoices created on or after this date (inclusive). Format: yyyy-MM-dd","schema":{"type":"string","format":"date"},"example":"2024-01-01T00:00:00.000Z"},{"name":"createdDateTo","in":"query","description":"Filter invoices created on or before this date (inclusive). Format: yyyy-MM-dd","schema":{"type":"string","format":"date"},"example":"2024-12-31T00:00:00.000Z"},{"name":"periodFrom","in":"query","description":"Filter invoices by billing period start (inclusive). Must be provided together with periodTo. Format: yyyy-MM-dd","schema":{"type":"string","format":"date"},"example":"2024-01-01T00:00:00.000Z"},{"name":"periodTo","in":"query","description":"Filter invoices by billing period end (inclusive). Must be provided together with periodFrom. Format: yyyy-MM-dd","schema":{"type":"string","format":"date"},"example":"2024-12-31T00:00:00.000Z"}],"responses":{"200":{"description":"List of invoices successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"required":["createTime","currency","hasActiveIntegrationData","invoiceGenerationType","status","subTotal","total","totalTax","updateTime"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the invoice","format":"int32","example":123},"invoiceNumber":{"type":"string","description":"Invoice number","example":"INV-2024-001"},"agreementName":{"type":"string","description":"Name of the agreement associated with this invoice","example":"Monthly Service Agreement"},"agreementId":{"type":"integer","description":"Unique identifier for the agreement","format":"int32","example":456},"subTotal":{"type":"number","description":"Subtotal amount before taxes and discounts","example":1000},"totalTax":{"type":"number","description":"Total tax amount","example":80},"total":{"type":"number","description":"Total amount including taxes and discounts","example":1080},"createTime":{"type":"number","description":"Timestamp when the invoice was created","format":"double"},"updateTime":{"type":"number","description":"Timestamp when the invoice was last updated","format":"double"},"invoiceGenerationType":{"type":"string","description":"Type of invoice generation (MANUAL or AUTOMATIC)","example":"AUTOMATIC","enum":["AUTOMATIC","MANUAL","ONE_OFF"]},"status":{"type":"string","description":"Current status of the invoice","example":"PENDING","enum":["PENDING","APPROVED","COMPLETE","EXPORTING","FAILED","EXPORTED","ARCHIVED"]},"client":{"required":["deleted"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the client","format":"int32","example":789},"name":{"type":"string","description":"Name of the client","example":"Acme Corporation"},"deleted":{"type":"boolean","description":"Indicates if the client has been deleted","example":false}},"description":"Client information associated with this invoice"},"failureReason":{"type":"string","description":"Reason for failure if the invoice export failed","nullable":true,"example":"Connection timeout to external system"},"currency":{"type":"string","description":"Currency used for this invoice","example":"USD","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]},"billingPeriodStartDate":{"type":"string","description":"Start date of the billing period in YYYY-MM-DD format","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"End date of the billing period in YYYY-MM-DD format","example":"2024-01-31T00:00:00.000Z"},"dueDate":{"type":"string","description":"Due date for payment in YYYY-MM-DD format","example":"2024-02-15T00:00:00.000Z"},"hasActiveIntegrationData":{"type":"boolean","description":"Indicates if the invoice has active integration data configured","example":true},"paymentStatus":{"type":"string","description":"Payment status of the invoice.","example":"UNPAID","enum":["UNPAID","PARTIALLY","FULL","OVER"]},"outstandingBalance":{"type":"number","description":"Outstanding balance remaining on the invoice.","example":500},"lastPaymentDate":{"type":"string","description":"Date of the last payment received, in YYYY-MM-DD format.","nullable":true,"example":"2024-02-10T00:00:00.000Z"}}}},"examples":{"Example invoice response list":{"description":"Example invoice response list","value":[{"id":123,"invoiceNumber":"INV-2024-001","agreementName":"Monthly Service Agreement","agreementId":456,"subTotal":1000,"totalTax":95,"total":1045,"createTime":1705314600000,"updateTime":1705314600000,"invoiceGenerationType":"AUTOMATIC","status":"APPROVED","client":{"id":789,"name":"Acme Corporation","isActive":true,"deleted":false},"failureReason":null,"currency":"USD","billingPeriodStartDate":"2024-01-01T00:00:00.000Z","billingPeriodEndDate":"2024-01-31T00:00:00.000Z","dueDate":"2024-02-15T00:00:00.000Z","hasActiveIntegrationData":true},{"id":124,"invoiceNumber":"INV-2024-002","agreementName":"Quarterly Support Agreement","agreementId":457,"subTotal":2000,"totalTax":190,"total":2090,"createTime":1705314600000,"updateTime":1705314600000,"invoiceGenerationType":"MANUAL","status":"PENDING","client":{"id":790,"name":"Tech Solutions Inc","isActive":true,"deleted":true},"failureReason":null,"currency":"USD","billingPeriodStartDate":"2024-02-01T00:00:00.000Z","billingPeriodEndDate":"2024-02-28T00:00:00.000Z","dueDate":"2024-03-15T00:00:00.000Z","hasActiveIntegrationData":false}]}}}}},"400":{"description":"Bad Request - Invalid date range parameters","content":{"application/json":{"examples":{"Invalid date format":{"description":"Invalid date format","value":{"resultCode":"invalid_date_format","errorMessage":"The createdDateFrom provided is not valid. Expected format is yyyy-MM-dd","incidentId":"WEB_MGMT_SERVICE-local-development-1767809599-SRTUMBgA"}},"Invalid created date range - missing pair":{"description":"Invalid created date range - missing pair","value":{"resultCode":"invalid_created_date_range","errorMessage":"Both created_date_from and created_date_to must be provided together or neither","incidentId":"WEB_MGMT_SERVICE-local-development-1767809599-SRTUMBgA"}},"Invalid created date range - wrong order":{"description":"Invalid created date range - wrong order","value":{"resultCode":"invalid_created_date_range","errorMessage":"The created_date_from cannot be after created_date_to","incidentId":"WEB_MGMT_SERVICE-local-development-1767809599-SRTUMBgA"}},"Invalid billing period range - missing pair":{"description":"Invalid billing period range - missing pair","value":{"resultCode":"invalid_billing_period_range","errorMessage":"Both billing_period_from and billing_period_to must be provided together or neither","incidentId":"WEB_MGMT_SERVICE-local-development-1767809599-SRTUMBgA"}},"Invalid billing period range - wrong order":{"description":"Invalid billing period range - wrong order","value":{"resultCode":"invalid_billing_period_range","errorMessage":"The billing_period_from cannot be after billing_period_to","incidentId":"WEB_MGMT_SERVICE-local-development-1767809599-SRTUMBgA"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}}}},"post":{"tags":["Billing"],"summary":"Creates an invoice","description":"Creates a new invoice for the specified agreement.\n\nThe invoice will be created with status PENDING unless the agreement has auto-approve enabled.\nIf invoice number settings are enabled, a number will be automatically assigned.","operationId":"createInvoice","requestBody":{"description":"Invoice creation request containing the agreement ID for which to generate the invoice.","content":{"*/*":{"schema":{"title":"NinjaOneBillingInvoiceCreateRequest","required":["agreementId"],"type":"object","properties":{"agreementId":{"type":"integer","description":"The ID of the agreement for which to generate the invoice.","format":"int32","example":123}},"description":"Representation of a ninja billing Invoice creation request."},"examples":{"Create invoice":{"description":"Example for creating an invoice from an agreement","value":{"agreementId":123}}}}},"required":true},"responses":{"201":{"description":"Invoice successfully created","content":{"application/json":{"schema":{"title":"NinjaOneBillingInvoiceResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice.","format":"int32","example":123},"invoiceNumber":{"type":"string","description":"Invoice number.","example":"INV-2024-001"},"client":{"required":["deleted"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the client","format":"int32","example":789},"name":{"type":"string","description":"Name of the client","example":"Acme Corporation"},"deleted":{"type":"boolean","description":"Indicates if the client has been deleted","example":false}},"description":"Client information associated with this invoice"},"status":{"type":"string","description":"Invoice status.","example":"APPROVED","enum":["PENDING","APPROVED","COMPLETE","EXPORTING","FAILED","EXPORTED","ARCHIVED"]},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"invoiceDate":{"type":"string","description":"Invoice date.","example":"2024-02-01T00:00:00.000Z"},"dueDate":{"type":"string","description":"Due date.","example":"2024-02-15T00:00:00.000Z"},"subTotal":{"type":"number","description":"Subtotal amount before discount.","example":1000},"discount":{"type":"number","description":"Discount amount.","example":50},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":950},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":95},"total":{"type":"number","description":"Total amount including tax.","example":1045},"currency":{"type":"string","description":"Currency code.","example":"USD"},"notes":{"type":"array","description":"Invoice notes.","items":{"type":"string","description":"Invoice notes."}},"invoiceNote":{"type":"string","description":"Invoice note field.","example":"Additional invoice information"},"interval":{"type":"string","description":"Billing interval.","example":"MONTHLY"},"errorDescription":{"type":"string","description":"Error description if failed.","nullable":true,"example":"Failed to export to Xero"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"invoiceGenerationType":{"type":"string","description":"Invoice generation type.","example":"MANUAL","enum":["AUTOMATIC","MANUAL","ONE_OFF"]},"billContent":{"title":"BillContentPublicApiDTO","type":"object","properties":{"issuerName":{"type":"string","description":"Issuer name.","example":"ACME Corp"},"issuerAddress":{"type":"string","description":"Issuer address.","example":"123 Main St, City, State 12345"},"issuerWebPage":{"type":"string","description":"Issuer webpage.","example":"https://acme.com"},"issuerPhone":{"type":"string","description":"Issuer phone.","example":"+1-555-0123"},"billName":{"type":"string","description":"Bill name.","example":"Client Company"},"billAddress":{"type":"string","description":"Bill address.","example":"456 Oak Ave, City, State 67890"},"billEmail":{"type":"string","description":"Bill email.","example":"billing@client.com"},"billPhone":{"type":"string","description":"Bill phone.","example":"+1-555-9876"}},"description":"Bill content information for invoice."},"appUserName":{"type":"string","description":"App user name who created/modified the invoice.","example":"john.doe@company.com"},"agreement":{"title":"AgreementBasicPublicApiDTO","type":"object","properties":{"id":{"type":"integer","description":"Agreement ID.","format":"int32","example":456},"name":{"type":"string","description":"Agreement name.","example":"Annual Support Agreement"}},"description":"Basic agreement information."},"externalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"failureReason":{"type":"string","description":"Failure reason if invoice processing failed.","nullable":true,"example":"Integration sync failed"},"allowOnlineCreditCardPayments":{"type":"boolean","description":"Whether online credit card payments are allowed.","example":true},"allowOnlineAchPayments":{"type":"boolean","description":"Whether online ACH payments are allowed.","example":false},"hasActiveIntegrationData":{"type":"boolean","description":"Whether invoice has active integration data.","example":false},"products":{"type":"array","description":"Invoice products/line items added directly to the invoice.","items":{"title":"NinjaOneBillingInvoiceProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice product.","format":"int32","example":1},"productId":{"type":"integer","description":"Product ID from catalog.","format":"int32","example":10},"name":{"type":"string","description":"Product name.","example":"Managed Services"},"description":{"type":"string","description":"Description.","example":"Monthly managed services for 50 devices"},"price":{"type":"number","description":"Unit price.","example":10},"cost":{"type":"number","description":"Cost.","example":5},"quantity":{"type":"number","description":"Quantity.","example":50},"subTotal":{"type":"number","description":"Subtotal before discount.","example":500},"discount":{"type":"number","description":"Discount amount.","example":25},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":475},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":47.5},"total":{"type":"number","description":"Total amount including tax.","example":522.5},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"accountId":{"type":"integer","description":"Account ID.","format":"int32","example":5},"quantityType":{"type":"string","description":"Quantity type.","example":"DEVICE_COUNTS"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"agreementProductId":{"type":"integer","description":"Agreement product ID.","format":"int32","example":123},"ticketProductId":{"type":"integer","description":"Ticket product ID.","format":"int32","example":456},"integrationSettings":{"title":"InvoiceProductIntegrationSettingsPublicApiDTO","type":"object","properties":{"inheritTaxRateFromAgreement":{"type":"boolean","description":"Whether to inherit tax rate from agreement.","example":true},"taxRate":{"type":"string","description":"Tax rate id from integration","example":"INPUT"}},"description":"Integration settings for invoice product."},"group":{"type":"boolean","description":"Whether this is a product group.","example":false},"productIds":{"type":"array","description":"Product IDs if this is a group.","items":{"type":"integer","description":"Product IDs if this is a group.","format":"int32"}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true}},"description":"Representation of an invoice product/line item."}},"agreementProducts":{"type":"array","description":"Invoice products/line items coming from agreements.","items":{"title":"NinjaOneBillingInvoiceProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice product.","format":"int32","example":1},"productId":{"type":"integer","description":"Product ID from catalog.","format":"int32","example":10},"name":{"type":"string","description":"Product name.","example":"Managed Services"},"description":{"type":"string","description":"Description.","example":"Monthly managed services for 50 devices"},"price":{"type":"number","description":"Unit price.","example":10},"cost":{"type":"number","description":"Cost.","example":5},"quantity":{"type":"number","description":"Quantity.","example":50},"subTotal":{"type":"number","description":"Subtotal before discount.","example":500},"discount":{"type":"number","description":"Discount amount.","example":25},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":475},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":47.5},"total":{"type":"number","description":"Total amount including tax.","example":522.5},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"accountId":{"type":"integer","description":"Account ID.","format":"int32","example":5},"quantityType":{"type":"string","description":"Quantity type.","example":"DEVICE_COUNTS"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"agreementProductId":{"type":"integer","description":"Agreement product ID.","format":"int32","example":123},"ticketProductId":{"type":"integer","description":"Ticket product ID.","format":"int32","example":456},"integrationSettings":{"title":"InvoiceProductIntegrationSettingsPublicApiDTO","type":"object","properties":{"inheritTaxRateFromAgreement":{"type":"boolean","description":"Whether to inherit tax rate from agreement.","example":true},"taxRate":{"type":"string","description":"Tax rate id from integration","example":"INPUT"}},"description":"Integration settings for invoice product."},"group":{"type":"boolean","description":"Whether this is a product group.","example":false},"productIds":{"type":"array","description":"Product IDs if this is a group.","items":{"type":"integer","description":"Product IDs if this is a group.","format":"int32"}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true}},"description":"Representation of an invoice product/line item."}},"ticketProducts":{"type":"array","description":"Invoice products/line items coming from tickets.","items":{"title":"NinjaOneBillingInvoiceProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice product.","format":"int32","example":1},"productId":{"type":"integer","description":"Product ID from catalog.","format":"int32","example":10},"name":{"type":"string","description":"Product name.","example":"Managed Services"},"description":{"type":"string","description":"Description.","example":"Monthly managed services for 50 devices"},"price":{"type":"number","description":"Unit price.","example":10},"cost":{"type":"number","description":"Cost.","example":5},"quantity":{"type":"number","description":"Quantity.","example":50},"subTotal":{"type":"number","description":"Subtotal before discount.","example":500},"discount":{"type":"number","description":"Discount amount.","example":25},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":475},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":47.5},"total":{"type":"number","description":"Total amount including tax.","example":522.5},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"accountId":{"type":"integer","description":"Account ID.","format":"int32","example":5},"quantityType":{"type":"string","description":"Quantity type.","example":"DEVICE_COUNTS"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"agreementProductId":{"type":"integer","description":"Agreement product ID.","format":"int32","example":123},"ticketProductId":{"type":"integer","description":"Ticket product ID.","format":"int32","example":456},"integrationSettings":{"title":"InvoiceProductIntegrationSettingsPublicApiDTO","type":"object","properties":{"inheritTaxRateFromAgreement":{"type":"boolean","description":"Whether to inherit tax rate from agreement.","example":true},"taxRate":{"type":"string","description":"Tax rate id from integration","example":"INPUT"}},"description":"Integration settings for invoice product."},"group":{"type":"boolean","description":"Whether this is a product group.","example":false},"productIds":{"type":"array","description":"Product IDs if this is a group.","items":{"type":"integer","description":"Product IDs if this is a group.","format":"int32"}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true}},"description":"Representation of an invoice product/line item."}},"oneOffProducts":{"type":"array","description":"Invoice products/line items added directly to a one-off invoice (not linked to any catalog product, agreement, or ticket).","items":{"title":"NinjaOneBillingInvoiceProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice product.","format":"int32","example":1},"productId":{"type":"integer","description":"Product ID from catalog.","format":"int32","example":10},"name":{"type":"string","description":"Product name.","example":"Managed Services"},"description":{"type":"string","description":"Description.","example":"Monthly managed services for 50 devices"},"price":{"type":"number","description":"Unit price.","example":10},"cost":{"type":"number","description":"Cost.","example":5},"quantity":{"type":"number","description":"Quantity.","example":50},"subTotal":{"type":"number","description":"Subtotal before discount.","example":500},"discount":{"type":"number","description":"Discount amount.","example":25},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":475},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":47.5},"total":{"type":"number","description":"Total amount including tax.","example":522.5},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"accountId":{"type":"integer","description":"Account ID.","format":"int32","example":5},"quantityType":{"type":"string","description":"Quantity type.","example":"DEVICE_COUNTS"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"agreementProductId":{"type":"integer","description":"Agreement product ID.","format":"int32","example":123},"ticketProductId":{"type":"integer","description":"Ticket product ID.","format":"int32","example":456},"integrationSettings":{"title":"InvoiceProductIntegrationSettingsPublicApiDTO","type":"object","properties":{"inheritTaxRateFromAgreement":{"type":"boolean","description":"Whether to inherit tax rate from agreement.","example":true},"taxRate":{"type":"string","description":"Tax rate id from integration","example":"INPUT"}},"description":"Integration settings for invoice product."},"group":{"type":"boolean","description":"Whether this is a product group.","example":false},"productIds":{"type":"array","description":"Product IDs if this is a group.","items":{"type":"integer","description":"Product IDs if this is a group.","format":"int32"}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true}},"description":"Representation of an invoice product/line item."}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true},"paymentStatus":{"type":"string","description":"Payment status of the invoice.","example":"UNPAID","enum":["UNPAID","PARTIALLY","FULL","OVER"]},"outstandingBalance":{"type":"number","description":"Outstanding balance remaining on the invoice.","example":500},"lastPaymentDate":{"type":"string","description":"Date of the last payment received, in YYYY-MM-DD format.","nullable":true,"example":"2024-02-10T00:00:00.000Z"},"deleted":{"type":"boolean","description":"Whether the invoice is deleted.","example":false}},"description":"Representation of a ninja billing invoice."},"examples":{"Created invoice":{"description":"Created invoice","value":{"id":123,"invoiceNumber":"INV-2024-001","client":{"id":789,"name":"Acme Corporation","deleted":false},"status":"PENDING","billingPeriodStartDate":"2024-01-01T00:00:00.000Z","billingPeriodEndDate":"2024-01-31T00:00:00.000Z","invoiceDate":"2024-02-01T00:00:00.000Z","dueDate":"2024-02-15T00:00:00.000Z","subTotal":1000,"discount":50,"subTotalWithDiscount":950,"taxRate":0.1,"totalTax":95,"total":1045,"currency":"USD","notes":["Thank you for your business","Payment due within 15 days"],"invoiceNote":"Additional invoice information","interval":"MONTHLY","errorDescription":null,"createTime":"2024-01-15T10:30:00.000Z","updateTime":"2024-01-20T14:45:00.000Z","invoiceGenerationType":"MANUAL","isDeleted":false,"billContent":{"issuerName":"ACME Corp","issuerAddress":"123 Main St, City, State 12345","issuerWebPage":"https://acme.com","issuerPhone":"+1-555-0123","billName":"Client Company","billAddress":"456 Oak Ave, City, State 67890","billEmail":"billing@client.com","billPhone":"+1-555-9876"},"appUserName":"john.doe@company.com","agreement":{"id":456,"name":"Monthly Service Agreement"},"failureReason":null,"allowOnlineCreditCardPayments":true,"allowOnlineAchPayments":false,"hasActiveIntegrationData":false,"tax":{"name":"Sales Tax","taxRates":[{"name":"State Tax","rate":10,"compounded":false}]},"products":[{"id":1,"productId":10,"name":"Managed Services","description":"Monthly managed services for 50 devices","price":10,"cost":5,"quantity":50,"subTotal":500,"discount":25,"subTotalWithDiscount":475,"taxRate":0.1,"totalTax":47.5,"total":522.5,"taxable":true,"billingPeriodStartDate":"2024-01-01T00:00:00.000Z","billingPeriodEndDate":"2024-01-31T00:00:00.000Z","accountId":5,"quantityType":"DEVICE_COUNTS","tax":{"name":"Sales Tax","taxRates":[{"name":"State Tax","rate":10,"compounded":false}]}}],"agreementProducts":[{"id":3,"productId":12,"name":"Agreement Product","description":"Product from agreement","price":15,"cost":7,"quantity":5,"subTotal":75,"discount":0,"subTotalWithDiscount":75,"taxRate":0.1,"totalTax":7.5,"total":82.5,"taxable":true,"billingPeriodStartDate":"2024-01-01T00:00:00.000Z","billingPeriodEndDate":"2024-01-31T00:00:00.000Z","accountId":7,"quantityType":"MANUAL","tax":{"name":"Sales Tax","taxRates":[{"name":"State Tax","rate":10,"compounded":false}]}}],"ticketProducts":[{"id":4,"productId":13,"name":"Ticket Product","description":"Product from ticket","price":20,"cost":10,"quantity":2,"subTotal":40,"discount":0,"subTotalWithDiscount":40,"taxRate":0.1,"totalTax":4,"total":44,"taxable":true,"billingPeriodStartDate":"2024-01-01T00:00:00.000Z","billingPeriodEndDate":"2024-01-31T00:00:00.000Z","accountId":8,"quantityType":"MANUAL","tax":{"name":"Sales Tax","taxRates":[{"name":"State Tax","rate":10,"compounded":false}]}}],"oneOffProducts":[{"id":5,"name":"Ad-hoc Service","description":"One-time service not linked to any catalog product","price":200,"cost":100,"quantity":1,"subTotal":200,"discount":0,"subTotalWithDiscount":200,"taxRate":0.1,"totalTax":20,"total":220,"taxable":true,"accountId":9,"quantityType":"MANUAL","group":false,"productIds":[]}]}}}}}},"204":{"description":"No charges were found, so no invoice was generated. Your billing period has been advanced."},"400":{"description":"Bad Request - Validation error","content":{"application/json":{"examples":{"Inactive Agreement":{"description":"Cannot create invoice for an inactive agreement","value":{"errorCode":"inactive_agreement","message":"An invoice cannot be generated for an inactive agreement"}},"One Time Agreement Already Billed":{"description":"One-time agreements can only be billed once","value":{"errorCode":"one_time_agreement_already_billed","message":"A One Time agreement can only be billed once"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}},"404":{"description":"Not found - Agreement does not exist","content":{"application/json":{"examples":{"Agreement Not Found":{"description":"Agreement Not Found","value":{"errorCode":"psa_agreement_not_found","message":"Agreement not found"}}}}}},"409":{"description":"Conflict - Invoice number already exists (if auto-numbering is enabled)","content":{"application/json":{"examples":{"Duplicate Invoice Number":{"description":"Duplicate Invoice Number","value":{"errorCode":"invoice_number_already_exists","message":"An invoice with this number already exists"}}}}}}}}},"/v2/billing/invoices/export":{"post":{"tags":["Billing"],"summary":"Export invoices","description":"Exports approved invoices to be marked as completed.","operationId":"exportInvoices","requestBody":{"description":"Request containing the IDs of invoices to export","content":{"application/json":{"schema":{"required":["invoiceIds"],"type":"object","properties":{"invoiceIds":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}},"examples":{"Export invoices":{"description":"Example for exporting multiple approved invoices","value":{"invoiceIds":[123,456,789]}}}}},"required":true},"responses":{"200":{"description":"Invoices successfully exported","content":{"application/json":{"schema":{"type":"object"},"examples":{"Exported invoice IDs":{"description":"Exported invoice IDs","value":{"exportedInvoiceIds":[123,456,789]}}}}}},"400":{"description":"Bad request - Empty invoice IDs list or invalid invoice status","content":{"application/json":{}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{}}}}}},"/v2/billing/invoices/{id}":{"get":{"tags":["Billing"],"summary":"Get invoice by ID","description":"Returns a single invoice given its ID","operationId":"getInvoiceById","parameters":[{"name":"id","in":"path","description":"Invoice ID","required":true,"schema":{"type":"integer","format":"int32"},"example":123}],"responses":{"200":{"description":"Invoice successfully retrieved","content":{"application/json":{"schema":{"title":"NinjaOneBillingInvoiceResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice.","format":"int32","example":123},"invoiceNumber":{"type":"string","description":"Invoice number.","example":"INV-2024-001"},"client":{"required":["deleted"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the client","format":"int32","example":789},"name":{"type":"string","description":"Name of the client","example":"Acme Corporation"},"deleted":{"type":"boolean","description":"Indicates if the client has been deleted","example":false}},"description":"Client information associated with this invoice"},"status":{"type":"string","description":"Invoice status.","example":"APPROVED","enum":["PENDING","APPROVED","COMPLETE","EXPORTING","FAILED","EXPORTED","ARCHIVED"]},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"invoiceDate":{"type":"string","description":"Invoice date.","example":"2024-02-01T00:00:00.000Z"},"dueDate":{"type":"string","description":"Due date.","example":"2024-02-15T00:00:00.000Z"},"subTotal":{"type":"number","description":"Subtotal amount before discount.","example":1000},"discount":{"type":"number","description":"Discount amount.","example":50},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":950},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":95},"total":{"type":"number","description":"Total amount including tax.","example":1045},"currency":{"type":"string","description":"Currency code.","example":"USD"},"notes":{"type":"array","description":"Invoice notes.","items":{"type":"string","description":"Invoice notes."}},"invoiceNote":{"type":"string","description":"Invoice note field.","example":"Additional invoice information"},"interval":{"type":"string","description":"Billing interval.","example":"MONTHLY"},"errorDescription":{"type":"string","description":"Error description if failed.","nullable":true,"example":"Failed to export to Xero"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"invoiceGenerationType":{"type":"string","description":"Invoice generation type.","example":"MANUAL","enum":["AUTOMATIC","MANUAL","ONE_OFF"]},"billContent":{"title":"BillContentPublicApiDTO","type":"object","properties":{"issuerName":{"type":"string","description":"Issuer name.","example":"ACME Corp"},"issuerAddress":{"type":"string","description":"Issuer address.","example":"123 Main St, City, State 12345"},"issuerWebPage":{"type":"string","description":"Issuer webpage.","example":"https://acme.com"},"issuerPhone":{"type":"string","description":"Issuer phone.","example":"+1-555-0123"},"billName":{"type":"string","description":"Bill name.","example":"Client Company"},"billAddress":{"type":"string","description":"Bill address.","example":"456 Oak Ave, City, State 67890"},"billEmail":{"type":"string","description":"Bill email.","example":"billing@client.com"},"billPhone":{"type":"string","description":"Bill phone.","example":"+1-555-9876"}},"description":"Bill content information for invoice."},"appUserName":{"type":"string","description":"App user name who created/modified the invoice.","example":"john.doe@company.com"},"agreement":{"title":"AgreementBasicPublicApiDTO","type":"object","properties":{"id":{"type":"integer","description":"Agreement ID.","format":"int32","example":456},"name":{"type":"string","description":"Agreement name.","example":"Annual Support Agreement"}},"description":"Basic agreement information."},"externalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"failureReason":{"type":"string","description":"Failure reason if invoice processing failed.","nullable":true,"example":"Integration sync failed"},"allowOnlineCreditCardPayments":{"type":"boolean","description":"Whether online credit card payments are allowed.","example":true},"allowOnlineAchPayments":{"type":"boolean","description":"Whether online ACH payments are allowed.","example":false},"hasActiveIntegrationData":{"type":"boolean","description":"Whether invoice has active integration data.","example":false},"products":{"type":"array","description":"Invoice products/line items added directly to the invoice.","items":{"title":"NinjaOneBillingInvoiceProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice product.","format":"int32","example":1},"productId":{"type":"integer","description":"Product ID from catalog.","format":"int32","example":10},"name":{"type":"string","description":"Product name.","example":"Managed Services"},"description":{"type":"string","description":"Description.","example":"Monthly managed services for 50 devices"},"price":{"type":"number","description":"Unit price.","example":10},"cost":{"type":"number","description":"Cost.","example":5},"quantity":{"type":"number","description":"Quantity.","example":50},"subTotal":{"type":"number","description":"Subtotal before discount.","example":500},"discount":{"type":"number","description":"Discount amount.","example":25},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":475},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":47.5},"total":{"type":"number","description":"Total amount including tax.","example":522.5},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"accountId":{"type":"integer","description":"Account ID.","format":"int32","example":5},"quantityType":{"type":"string","description":"Quantity type.","example":"DEVICE_COUNTS"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"agreementProductId":{"type":"integer","description":"Agreement product ID.","format":"int32","example":123},"ticketProductId":{"type":"integer","description":"Ticket product ID.","format":"int32","example":456},"integrationSettings":{"title":"InvoiceProductIntegrationSettingsPublicApiDTO","type":"object","properties":{"inheritTaxRateFromAgreement":{"type":"boolean","description":"Whether to inherit tax rate from agreement.","example":true},"taxRate":{"type":"string","description":"Tax rate id from integration","example":"INPUT"}},"description":"Integration settings for invoice product."},"group":{"type":"boolean","description":"Whether this is a product group.","example":false},"productIds":{"type":"array","description":"Product IDs if this is a group.","items":{"type":"integer","description":"Product IDs if this is a group.","format":"int32"}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true}},"description":"Representation of an invoice product/line item."}},"agreementProducts":{"type":"array","description":"Invoice products/line items coming from agreements.","items":{"title":"NinjaOneBillingInvoiceProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice product.","format":"int32","example":1},"productId":{"type":"integer","description":"Product ID from catalog.","format":"int32","example":10},"name":{"type":"string","description":"Product name.","example":"Managed Services"},"description":{"type":"string","description":"Description.","example":"Monthly managed services for 50 devices"},"price":{"type":"number","description":"Unit price.","example":10},"cost":{"type":"number","description":"Cost.","example":5},"quantity":{"type":"number","description":"Quantity.","example":50},"subTotal":{"type":"number","description":"Subtotal before discount.","example":500},"discount":{"type":"number","description":"Discount amount.","example":25},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":475},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":47.5},"total":{"type":"number","description":"Total amount including tax.","example":522.5},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"accountId":{"type":"integer","description":"Account ID.","format":"int32","example":5},"quantityType":{"type":"string","description":"Quantity type.","example":"DEVICE_COUNTS"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"agreementProductId":{"type":"integer","description":"Agreement product ID.","format":"int32","example":123},"ticketProductId":{"type":"integer","description":"Ticket product ID.","format":"int32","example":456},"integrationSettings":{"title":"InvoiceProductIntegrationSettingsPublicApiDTO","type":"object","properties":{"inheritTaxRateFromAgreement":{"type":"boolean","description":"Whether to inherit tax rate from agreement.","example":true},"taxRate":{"type":"string","description":"Tax rate id from integration","example":"INPUT"}},"description":"Integration settings for invoice product."},"group":{"type":"boolean","description":"Whether this is a product group.","example":false},"productIds":{"type":"array","description":"Product IDs if this is a group.","items":{"type":"integer","description":"Product IDs if this is a group.","format":"int32"}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true}},"description":"Representation of an invoice product/line item."}},"ticketProducts":{"type":"array","description":"Invoice products/line items coming from tickets.","items":{"title":"NinjaOneBillingInvoiceProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice product.","format":"int32","example":1},"productId":{"type":"integer","description":"Product ID from catalog.","format":"int32","example":10},"name":{"type":"string","description":"Product name.","example":"Managed Services"},"description":{"type":"string","description":"Description.","example":"Monthly managed services for 50 devices"},"price":{"type":"number","description":"Unit price.","example":10},"cost":{"type":"number","description":"Cost.","example":5},"quantity":{"type":"number","description":"Quantity.","example":50},"subTotal":{"type":"number","description":"Subtotal before discount.","example":500},"discount":{"type":"number","description":"Discount amount.","example":25},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":475},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":47.5},"total":{"type":"number","description":"Total amount including tax.","example":522.5},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"accountId":{"type":"integer","description":"Account ID.","format":"int32","example":5},"quantityType":{"type":"string","description":"Quantity type.","example":"DEVICE_COUNTS"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"agreementProductId":{"type":"integer","description":"Agreement product ID.","format":"int32","example":123},"ticketProductId":{"type":"integer","description":"Ticket product ID.","format":"int32","example":456},"integrationSettings":{"title":"InvoiceProductIntegrationSettingsPublicApiDTO","type":"object","properties":{"inheritTaxRateFromAgreement":{"type":"boolean","description":"Whether to inherit tax rate from agreement.","example":true},"taxRate":{"type":"string","description":"Tax rate id from integration","example":"INPUT"}},"description":"Integration settings for invoice product."},"group":{"type":"boolean","description":"Whether this is a product group.","example":false},"productIds":{"type":"array","description":"Product IDs if this is a group.","items":{"type":"integer","description":"Product IDs if this is a group.","format":"int32"}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true}},"description":"Representation of an invoice product/line item."}},"oneOffProducts":{"type":"array","description":"Invoice products/line items added directly to a one-off invoice (not linked to any catalog product, agreement, or ticket).","items":{"title":"NinjaOneBillingInvoiceProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice product.","format":"int32","example":1},"productId":{"type":"integer","description":"Product ID from catalog.","format":"int32","example":10},"name":{"type":"string","description":"Product name.","example":"Managed Services"},"description":{"type":"string","description":"Description.","example":"Monthly managed services for 50 devices"},"price":{"type":"number","description":"Unit price.","example":10},"cost":{"type":"number","description":"Cost.","example":5},"quantity":{"type":"number","description":"Quantity.","example":50},"subTotal":{"type":"number","description":"Subtotal before discount.","example":500},"discount":{"type":"number","description":"Discount amount.","example":25},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":475},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":47.5},"total":{"type":"number","description":"Total amount including tax.","example":522.5},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"accountId":{"type":"integer","description":"Account ID.","format":"int32","example":5},"quantityType":{"type":"string","description":"Quantity type.","example":"DEVICE_COUNTS"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"agreementProductId":{"type":"integer","description":"Agreement product ID.","format":"int32","example":123},"ticketProductId":{"type":"integer","description":"Ticket product ID.","format":"int32","example":456},"integrationSettings":{"title":"InvoiceProductIntegrationSettingsPublicApiDTO","type":"object","properties":{"inheritTaxRateFromAgreement":{"type":"boolean","description":"Whether to inherit tax rate from agreement.","example":true},"taxRate":{"type":"string","description":"Tax rate id from integration","example":"INPUT"}},"description":"Integration settings for invoice product."},"group":{"type":"boolean","description":"Whether this is a product group.","example":false},"productIds":{"type":"array","description":"Product IDs if this is a group.","items":{"type":"integer","description":"Product IDs if this is a group.","format":"int32"}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true}},"description":"Representation of an invoice product/line item."}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true},"paymentStatus":{"type":"string","description":"Payment status of the invoice.","example":"UNPAID","enum":["UNPAID","PARTIALLY","FULL","OVER"]},"outstandingBalance":{"type":"number","description":"Outstanding balance remaining on the invoice.","example":500},"lastPaymentDate":{"type":"string","description":"Date of the last payment received, in YYYY-MM-DD format.","nullable":true,"example":"2024-02-10T00:00:00.000Z"},"deleted":{"type":"boolean","description":"Whether the invoice is deleted.","example":false}},"description":"Representation of a ninja billing invoice."},"examples":{"Example invoice response":{"description":"Example invoice response","value":{"id":123,"invoiceNumber":"INV-2024-001","client":{"id":789,"name":"Acme Corporation","deleted":false},"status":"PENDING","billingPeriodStartDate":"2024-01-01T00:00:00.000Z","billingPeriodEndDate":"2024-01-31T00:00:00.000Z","invoiceDate":"2024-02-01T00:00:00.000Z","dueDate":"2024-02-15T00:00:00.000Z","subTotal":1000,"discount":50,"subTotalWithDiscount":950,"taxRate":0.1,"totalTax":95,"total":1045,"currency":"USD","notes":["Thank you for your business","Payment due within 15 days"],"invoiceNote":"Additional invoice information","interval":"MONTHLY","errorDescription":null,"createTime":"2024-01-15T10:30:00.000Z","updateTime":"2024-01-20T14:45:00.000Z","invoiceGenerationType":"MANUAL","isDeleted":false,"billContent":{"issuerName":"ACME Corp","issuerAddress":"123 Main St, City, State 12345","issuerWebPage":"https://acme.com","issuerPhone":"+1-555-0123","billName":"Client Company","billAddress":"456 Oak Ave, City, State 67890","billEmail":"billing@client.com","billPhone":"+1-555-9876"},"appUserName":"john.doe@company.com","agreement":{"id":456,"name":"Monthly Service Agreement"},"failureReason":null,"allowOnlineCreditCardPayments":true,"allowOnlineAchPayments":false,"hasActiveIntegrationData":false,"tax":{"name":"Sales Tax","taxRates":[{"name":"State Tax","rate":10,"compounded":false}]},"products":[{"id":1,"productId":10,"name":"Managed Services","description":"Monthly managed services for 50 devices","price":10,"cost":5,"quantity":50,"subTotal":500,"discount":25,"subTotalWithDiscount":475,"taxRate":0.1,"totalTax":47.5,"total":522.5,"taxable":true,"billingPeriodStartDate":"2024-01-01T00:00:00.000Z","billingPeriodEndDate":"2024-01-31T00:00:00.000Z","accountId":5,"quantityType":"DEVICE_COUNTS","tax":{"name":"Sales Tax","taxRates":[{"name":"State Tax","rate":10,"compounded":false}]}}],"agreementProducts":[{"id":3,"productId":12,"name":"Agreement Product","description":"Product from agreement","price":15,"cost":7,"quantity":5,"subTotal":75,"discount":0,"subTotalWithDiscount":75,"taxRate":0.1,"totalTax":7.5,"total":82.5,"taxable":true,"billingPeriodStartDate":"2024-01-01T00:00:00.000Z","billingPeriodEndDate":"2024-01-31T00:00:00.000Z","accountId":7,"quantityType":"MANUAL","tax":{"name":"Sales Tax","taxRates":[{"name":"State Tax","rate":10,"compounded":false}]}}],"ticketProducts":[{"id":4,"productId":13,"name":"Ticket Product","description":"Product from ticket","price":20,"cost":10,"quantity":2,"subTotal":40,"discount":0,"subTotalWithDiscount":40,"taxRate":0.1,"totalTax":4,"total":44,"taxable":true,"billingPeriodStartDate":"2024-01-01T00:00:00.000Z","billingPeriodEndDate":"2024-01-31T00:00:00.000Z","accountId":8,"quantityType":"MANUAL","tax":{"name":"Sales Tax","taxRates":[{"name":"State Tax","rate":10,"compounded":false}]}}],"oneOffProducts":[{"id":5,"name":"Ad-hoc Service","description":"One-time service not linked to any catalog product","price":200,"cost":100,"quantity":1,"subTotal":200,"discount":0,"subTotalWithDiscount":200,"taxRate":0.1,"totalTax":20,"total":220,"taxable":true,"accountId":9,"quantityType":"MANUAL","group":false,"productIds":[]}]}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}},"404":{"description":"Invoice not found","content":{"application/json":{"examples":{"Not Found":{"description":"Not Found","value":{"errorCode":"invoice_not_found","message":"Invoice not found"}}}}}}}},"put":{"tags":["Billing"],"summary":"Updates an invoice","description":"Updates a previously created invoice given its ID and updated content","operationId":"updateInvoice","parameters":[{"name":"id","in":"path","description":"Invoice ID","required":true,"schema":{"type":"integer","format":"int32"},"example":123}],"requestBody":{"description":"Updated Invoice object with modified fields.","content":{"*/*":{"schema":{"title":"NinjaOneBillingInvoiceRequest","type":"object","properties":{"invoiceDate":{"type":"string","description":"Invoice date in ISO format (YYYY-MM-DD).","example":"2024-01-15T00:00:00.000Z"},"products":{"type":"array","description":"List of catalog products to include in the invoice.","items":{"title":"NinjaOneBillingInvoiceProductRequest","required":["cost","description","name","price","quantity","taxable"],"type":"object","properties":{"id":{"type":"integer","description":"ID of the invoice product (required for updates, null for new products).","format":"int32","example":123},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the product.","example":"Hardware Support"},"productId":{"type":"integer","description":"ID of the product from the catalog.","format":"int32","example":456},"ticketProductId":{"type":"integer","description":"ID of the ticket product.","format":"int32","example":789},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"price":{"type":"number","description":"Price per unit of the product.","format":"double","example":500},"cost":{"type":"number","description":"Cost per unit of the product.","format":"double","example":250},"quantity":{"type":"number","description":"Quantity of the product.","example":2},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the product.","example":"Monthly hardware support service"}},"description":"Representation of a product within an invoice."}},"agreementProducts":{"type":"array","description":"List of agreement products to include in the invoice.","items":{"title":"NinjaOneBillingInvoiceProductRequest","required":["cost","description","name","price","quantity","taxable"],"type":"object","properties":{"id":{"type":"integer","description":"ID of the invoice product (required for updates, null for new products).","format":"int32","example":123},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the product.","example":"Hardware Support"},"productId":{"type":"integer","description":"ID of the product from the catalog.","format":"int32","example":456},"ticketProductId":{"type":"integer","description":"ID of the ticket product.","format":"int32","example":789},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"price":{"type":"number","description":"Price per unit of the product.","format":"double","example":500},"cost":{"type":"number","description":"Cost per unit of the product.","format":"double","example":250},"quantity":{"type":"number","description":"Quantity of the product.","example":2},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the product.","example":"Monthly hardware support service"}},"description":"Representation of a product within an invoice."}},"ticketProducts":{"type":"array","description":"List of ticket products to include in the invoice.","items":{"title":"NinjaOneBillingInvoiceProductRequest","required":["cost","description","name","price","quantity","taxable"],"type":"object","properties":{"id":{"type":"integer","description":"ID of the invoice product (required for updates, null for new products).","format":"int32","example":123},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the product.","example":"Hardware Support"},"productId":{"type":"integer","description":"ID of the product from the catalog.","format":"int32","example":456},"ticketProductId":{"type":"integer","description":"ID of the ticket product.","format":"int32","example":789},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"price":{"type":"number","description":"Price per unit of the product.","format":"double","example":500},"cost":{"type":"number","description":"Cost per unit of the product.","format":"double","example":250},"quantity":{"type":"number","description":"Quantity of the product.","example":2},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the product.","example":"Monthly hardware support service"}},"description":"Representation of a product within an invoice."}},"billingPeriodStartDate":{"type":"string","description":"Billing period start date in ISO format (YYYY-MM-DD).","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date in ISO format (YYYY-MM-DD).","example":"2024-01-31T00:00:00.000Z"},"invoiceNote":{"maxLength":250,"minLength":0,"type":"string","description":"Note to include in the invoice.","example":"Monthly service invoice"},"dueDate":{"type":"string","description":"Due date for the invoice in ISO format (YYYY-MM-DD).","example":"2024-02-15T00:00:00.000Z"},"invoiceNumber":{"maxLength":21,"minLength":0,"type":"string","description":"Invoice number.","example":"INV-2024-001"}},"description":"Representation of a ninja billing Invoice update request."}}},"required":true},"responses":{"200":{"description":"Invoice successfully updated","content":{"application/json":{"schema":{"title":"NinjaOneBillingInvoiceResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice.","format":"int32","example":123},"invoiceNumber":{"type":"string","description":"Invoice number.","example":"INV-2024-001"},"client":{"required":["deleted"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the client","format":"int32","example":789},"name":{"type":"string","description":"Name of the client","example":"Acme Corporation"},"deleted":{"type":"boolean","description":"Indicates if the client has been deleted","example":false}},"description":"Client information associated with this invoice"},"status":{"type":"string","description":"Invoice status.","example":"APPROVED","enum":["PENDING","APPROVED","COMPLETE","EXPORTING","FAILED","EXPORTED","ARCHIVED"]},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"invoiceDate":{"type":"string","description":"Invoice date.","example":"2024-02-01T00:00:00.000Z"},"dueDate":{"type":"string","description":"Due date.","example":"2024-02-15T00:00:00.000Z"},"subTotal":{"type":"number","description":"Subtotal amount before discount.","example":1000},"discount":{"type":"number","description":"Discount amount.","example":50},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":950},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":95},"total":{"type":"number","description":"Total amount including tax.","example":1045},"currency":{"type":"string","description":"Currency code.","example":"USD"},"notes":{"type":"array","description":"Invoice notes.","items":{"type":"string","description":"Invoice notes."}},"invoiceNote":{"type":"string","description":"Invoice note field.","example":"Additional invoice information"},"interval":{"type":"string","description":"Billing interval.","example":"MONTHLY"},"errorDescription":{"type":"string","description":"Error description if failed.","nullable":true,"example":"Failed to export to Xero"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"invoiceGenerationType":{"type":"string","description":"Invoice generation type.","example":"MANUAL","enum":["AUTOMATIC","MANUAL","ONE_OFF"]},"billContent":{"title":"BillContentPublicApiDTO","type":"object","properties":{"issuerName":{"type":"string","description":"Issuer name.","example":"ACME Corp"},"issuerAddress":{"type":"string","description":"Issuer address.","example":"123 Main St, City, State 12345"},"issuerWebPage":{"type":"string","description":"Issuer webpage.","example":"https://acme.com"},"issuerPhone":{"type":"string","description":"Issuer phone.","example":"+1-555-0123"},"billName":{"type":"string","description":"Bill name.","example":"Client Company"},"billAddress":{"type":"string","description":"Bill address.","example":"456 Oak Ave, City, State 67890"},"billEmail":{"type":"string","description":"Bill email.","example":"billing@client.com"},"billPhone":{"type":"string","description":"Bill phone.","example":"+1-555-9876"}},"description":"Bill content information for invoice."},"appUserName":{"type":"string","description":"App user name who created/modified the invoice.","example":"john.doe@company.com"},"agreement":{"title":"AgreementBasicPublicApiDTO","type":"object","properties":{"id":{"type":"integer","description":"Agreement ID.","format":"int32","example":456},"name":{"type":"string","description":"Agreement name.","example":"Annual Support Agreement"}},"description":"Basic agreement information."},"externalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"failureReason":{"type":"string","description":"Failure reason if invoice processing failed.","nullable":true,"example":"Integration sync failed"},"allowOnlineCreditCardPayments":{"type":"boolean","description":"Whether online credit card payments are allowed.","example":true},"allowOnlineAchPayments":{"type":"boolean","description":"Whether online ACH payments are allowed.","example":false},"hasActiveIntegrationData":{"type":"boolean","description":"Whether invoice has active integration data.","example":false},"products":{"type":"array","description":"Invoice products/line items added directly to the invoice.","items":{"title":"NinjaOneBillingInvoiceProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice product.","format":"int32","example":1},"productId":{"type":"integer","description":"Product ID from catalog.","format":"int32","example":10},"name":{"type":"string","description":"Product name.","example":"Managed Services"},"description":{"type":"string","description":"Description.","example":"Monthly managed services for 50 devices"},"price":{"type":"number","description":"Unit price.","example":10},"cost":{"type":"number","description":"Cost.","example":5},"quantity":{"type":"number","description":"Quantity.","example":50},"subTotal":{"type":"number","description":"Subtotal before discount.","example":500},"discount":{"type":"number","description":"Discount amount.","example":25},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":475},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":47.5},"total":{"type":"number","description":"Total amount including tax.","example":522.5},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"accountId":{"type":"integer","description":"Account ID.","format":"int32","example":5},"quantityType":{"type":"string","description":"Quantity type.","example":"DEVICE_COUNTS"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"agreementProductId":{"type":"integer","description":"Agreement product ID.","format":"int32","example":123},"ticketProductId":{"type":"integer","description":"Ticket product ID.","format":"int32","example":456},"integrationSettings":{"title":"InvoiceProductIntegrationSettingsPublicApiDTO","type":"object","properties":{"inheritTaxRateFromAgreement":{"type":"boolean","description":"Whether to inherit tax rate from agreement.","example":true},"taxRate":{"type":"string","description":"Tax rate id from integration","example":"INPUT"}},"description":"Integration settings for invoice product."},"group":{"type":"boolean","description":"Whether this is a product group.","example":false},"productIds":{"type":"array","description":"Product IDs if this is a group.","items":{"type":"integer","description":"Product IDs if this is a group.","format":"int32"}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true}},"description":"Representation of an invoice product/line item."}},"agreementProducts":{"type":"array","description":"Invoice products/line items coming from agreements.","items":{"title":"NinjaOneBillingInvoiceProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice product.","format":"int32","example":1},"productId":{"type":"integer","description":"Product ID from catalog.","format":"int32","example":10},"name":{"type":"string","description":"Product name.","example":"Managed Services"},"description":{"type":"string","description":"Description.","example":"Monthly managed services for 50 devices"},"price":{"type":"number","description":"Unit price.","example":10},"cost":{"type":"number","description":"Cost.","example":5},"quantity":{"type":"number","description":"Quantity.","example":50},"subTotal":{"type":"number","description":"Subtotal before discount.","example":500},"discount":{"type":"number","description":"Discount amount.","example":25},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":475},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":47.5},"total":{"type":"number","description":"Total amount including tax.","example":522.5},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"accountId":{"type":"integer","description":"Account ID.","format":"int32","example":5},"quantityType":{"type":"string","description":"Quantity type.","example":"DEVICE_COUNTS"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"agreementProductId":{"type":"integer","description":"Agreement product ID.","format":"int32","example":123},"ticketProductId":{"type":"integer","description":"Ticket product ID.","format":"int32","example":456},"integrationSettings":{"title":"InvoiceProductIntegrationSettingsPublicApiDTO","type":"object","properties":{"inheritTaxRateFromAgreement":{"type":"boolean","description":"Whether to inherit tax rate from agreement.","example":true},"taxRate":{"type":"string","description":"Tax rate id from integration","example":"INPUT"}},"description":"Integration settings for invoice product."},"group":{"type":"boolean","description":"Whether this is a product group.","example":false},"productIds":{"type":"array","description":"Product IDs if this is a group.","items":{"type":"integer","description":"Product IDs if this is a group.","format":"int32"}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true}},"description":"Representation of an invoice product/line item."}},"ticketProducts":{"type":"array","description":"Invoice products/line items coming from tickets.","items":{"title":"NinjaOneBillingInvoiceProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice product.","format":"int32","example":1},"productId":{"type":"integer","description":"Product ID from catalog.","format":"int32","example":10},"name":{"type":"string","description":"Product name.","example":"Managed Services"},"description":{"type":"string","description":"Description.","example":"Monthly managed services for 50 devices"},"price":{"type":"number","description":"Unit price.","example":10},"cost":{"type":"number","description":"Cost.","example":5},"quantity":{"type":"number","description":"Quantity.","example":50},"subTotal":{"type":"number","description":"Subtotal before discount.","example":500},"discount":{"type":"number","description":"Discount amount.","example":25},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":475},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":47.5},"total":{"type":"number","description":"Total amount including tax.","example":522.5},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"accountId":{"type":"integer","description":"Account ID.","format":"int32","example":5},"quantityType":{"type":"string","description":"Quantity type.","example":"DEVICE_COUNTS"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"agreementProductId":{"type":"integer","description":"Agreement product ID.","format":"int32","example":123},"ticketProductId":{"type":"integer","description":"Ticket product ID.","format":"int32","example":456},"integrationSettings":{"title":"InvoiceProductIntegrationSettingsPublicApiDTO","type":"object","properties":{"inheritTaxRateFromAgreement":{"type":"boolean","description":"Whether to inherit tax rate from agreement.","example":true},"taxRate":{"type":"string","description":"Tax rate id from integration","example":"INPUT"}},"description":"Integration settings for invoice product."},"group":{"type":"boolean","description":"Whether this is a product group.","example":false},"productIds":{"type":"array","description":"Product IDs if this is a group.","items":{"type":"integer","description":"Product IDs if this is a group.","format":"int32"}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true}},"description":"Representation of an invoice product/line item."}},"oneOffProducts":{"type":"array","description":"Invoice products/line items added directly to a one-off invoice (not linked to any catalog product, agreement, or ticket).","items":{"title":"NinjaOneBillingInvoiceProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice product.","format":"int32","example":1},"productId":{"type":"integer","description":"Product ID from catalog.","format":"int32","example":10},"name":{"type":"string","description":"Product name.","example":"Managed Services"},"description":{"type":"string","description":"Description.","example":"Monthly managed services for 50 devices"},"price":{"type":"number","description":"Unit price.","example":10},"cost":{"type":"number","description":"Cost.","example":5},"quantity":{"type":"number","description":"Quantity.","example":50},"subTotal":{"type":"number","description":"Subtotal before discount.","example":500},"discount":{"type":"number","description":"Discount amount.","example":25},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":475},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":47.5},"total":{"type":"number","description":"Total amount including tax.","example":522.5},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"accountId":{"type":"integer","description":"Account ID.","format":"int32","example":5},"quantityType":{"type":"string","description":"Quantity type.","example":"DEVICE_COUNTS"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"agreementProductId":{"type":"integer","description":"Agreement product ID.","format":"int32","example":123},"ticketProductId":{"type":"integer","description":"Ticket product ID.","format":"int32","example":456},"integrationSettings":{"title":"InvoiceProductIntegrationSettingsPublicApiDTO","type":"object","properties":{"inheritTaxRateFromAgreement":{"type":"boolean","description":"Whether to inherit tax rate from agreement.","example":true},"taxRate":{"type":"string","description":"Tax rate id from integration","example":"INPUT"}},"description":"Integration settings for invoice product."},"group":{"type":"boolean","description":"Whether this is a product group.","example":false},"productIds":{"type":"array","description":"Product IDs if this is a group.","items":{"type":"integer","description":"Product IDs if this is a group.","format":"int32"}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true}},"description":"Representation of an invoice product/line item."}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true},"paymentStatus":{"type":"string","description":"Payment status of the invoice.","example":"UNPAID","enum":["UNPAID","PARTIALLY","FULL","OVER"]},"outstandingBalance":{"type":"number","description":"Outstanding balance remaining on the invoice.","example":500},"lastPaymentDate":{"type":"string","description":"Date of the last payment received, in YYYY-MM-DD format.","nullable":true,"example":"2024-02-10T00:00:00.000Z"},"deleted":{"type":"boolean","description":"Whether the invoice is deleted.","example":false}},"description":"Representation of a ninja billing invoice."},"examples":{"Updated invoice":{"description":"Updated invoice","value":{"id":123,"invoiceNumber":"INV-2024-001","client":{"id":789,"name":"Acme Corporation","deleted":false},"status":"PENDING","billingPeriodStartDate":"2024-01-01T00:00:00.000Z","billingPeriodEndDate":"2024-01-31T00:00:00.000Z","invoiceDate":"2024-02-01T00:00:00.000Z","dueDate":"2024-02-15T00:00:00.000Z","subTotal":1000,"discount":50,"subTotalWithDiscount":950,"taxRate":0.1,"totalTax":95,"total":1045,"currency":"USD","notes":["Thank you for your business","Payment due within 15 days"],"invoiceNote":"Additional invoice information","interval":"MONTHLY","errorDescription":null,"createTime":"2024-01-15T10:30:00.000Z","updateTime":"2024-01-20T14:45:00.000Z","invoiceGenerationType":"MANUAL","isDeleted":false,"billContent":{"issuerName":"ACME Corp","issuerAddress":"123 Main St, City, State 12345","issuerWebPage":"https://acme.com","issuerPhone":"+1-555-0123","billName":"Client Company","billAddress":"456 Oak Ave, City, State 67890","billEmail":"billing@client.com","billPhone":"+1-555-9876"},"appUserName":"john.doe@company.com","agreement":{"id":456,"name":"Monthly Service Agreement"},"failureReason":null,"allowOnlineCreditCardPayments":true,"allowOnlineAchPayments":false,"hasActiveIntegrationData":false,"tax":{"name":"Sales Tax","taxRates":[{"name":"State Tax","rate":10,"compounded":false}]},"products":[{"id":1,"productId":10,"name":"Managed Services","description":"Monthly managed services for 50 devices","price":10,"cost":5,"quantity":50,"subTotal":500,"discount":25,"subTotalWithDiscount":475,"taxRate":0.1,"totalTax":47.5,"total":522.5,"taxable":true,"billingPeriodStartDate":"2024-01-01T00:00:00.000Z","billingPeriodEndDate":"2024-01-31T00:00:00.000Z","accountId":5,"quantityType":"DEVICE_COUNTS","tax":{"name":"Sales Tax","taxRates":[{"name":"State Tax","rate":10,"compounded":false}]}}],"agreementProducts":[{"id":3,"productId":12,"name":"Agreement Product","description":"Product from agreement","price":15,"cost":7,"quantity":5,"subTotal":75,"discount":0,"subTotalWithDiscount":75,"taxRate":0.1,"totalTax":7.5,"total":82.5,"taxable":true,"billingPeriodStartDate":"2024-01-01T00:00:00.000Z","billingPeriodEndDate":"2024-01-31T00:00:00.000Z","accountId":7,"quantityType":"MANUAL","tax":{"name":"Sales Tax","taxRates":[{"name":"State Tax","rate":10,"compounded":false}]}}],"ticketProducts":[{"id":4,"productId":13,"name":"Ticket Product","description":"Product from ticket","price":20,"cost":10,"quantity":2,"subTotal":40,"discount":0,"subTotalWithDiscount":40,"taxRate":0.1,"totalTax":4,"total":44,"taxable":true,"billingPeriodStartDate":"2024-01-01T00:00:00.000Z","billingPeriodEndDate":"2024-01-31T00:00:00.000Z","accountId":8,"quantityType":"MANUAL","tax":{"name":"Sales Tax","taxRates":[{"name":"State Tax","rate":10,"compounded":false}]}}],"oneOffProducts":[{"id":5,"name":"Ad-hoc Service","description":"One-time service not linked to any catalog product","price":200,"cost":100,"quantity":1,"subTotal":200,"discount":0,"subTotalWithDiscount":200,"taxRate":0.1,"totalTax":20,"total":220,"taxable":true,"accountId":9,"quantityType":"MANUAL","group":false,"productIds":[]}]}}}}}},"400":{"description":"Bad Request - Validation error or invoice is complete","content":{"application/json":{"examples":{"Validation Error":{"description":"General validation errors (invalid dates, formats, etc.)","value":{"errorCode":"invalid_invoice_date","message":"The invoice date provided is not valid. Expected format is yyyy-MM-dd"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}},"404":{"description":"Invoice not found","content":{"application/json":{"examples":{"Not Found":{"description":"Not Found","value":{"errorCode":"invoice_not_found","message":"Invoice not found"}}}}}},"409":{"description":"Conflict - Invoice number already exists","content":{"application/json":{"examples":{"Duplicate Invoice Number":{"description":"Duplicate Invoice Number","value":{"errorCode":"invoice_number_already_exists","message":"An invoice with this number already exists"}}}}}}}}},"/v2/billing/invoices/unarchive":{"post":{"tags":["Billing"],"summary":"Unarchive invoices","description":"Unarchives one or more invoices by changing their status from ARCHIVED to PENDING.","operationId":"unarchiveInvoices","requestBody":{"description":"Request containing the IDs of invoices to unarchive","content":{"application/json":{"schema":{"required":["invoiceIds"],"type":"object","properties":{"invoiceIds":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}},"examples":{"Unarchive invoices":{"description":"Example for unarchiving multiple invoices","value":{"invoiceIds":[123,456]}}}}},"required":true},"responses":{"200":{"description":"Invoices successfully unarchived","content":{"application/json":{"schema":{"type":"object"},"examples":{"Unarchived invoice IDs":{"description":"Unarchived invoice IDs","value":{"unarchivedInvoiceIds":[123,456]}}}}}},"400":{"description":"Bad request - Invoice IDs required","content":{"application/json":{}}},"403":{"description":"Forbidden - Insufficient permissions (requires PSA Admin) or client access denied","content":{"application/json":{}}}}}},"/v2/billing/invoices/{id}/note":{"patch":{"tags":["Billing"],"summary":"Update invoice note","description":"Updates only the note field of an invoice. This operation is allowed even for COMPLETE invoices.\n\n**Note:** This endpoint returns 204 No Content on success. No invoice data is returned.","operationId":"updateInvoiceNote","parameters":[{"name":"id","in":"path","description":"Invoice ID","required":true,"schema":{"type":"integer","format":"int32"},"example":123}],"requestBody":{"description":"Note update request","content":{"*/*":{"schema":{"title":"NinjaOneBillingInvoiceNoteRequest","type":"object","properties":{"invoiceNote":{"maxLength":250,"minLength":0,"type":"string","description":"The note to be associated with the invoice. Can be null to clear the note.","nullable":true,"example":"Payment received via wire transfer on January 15, 2026"}},"description":"Request to update the note field of an invoice. This operation is allowed even for COMPLETE invoices."},"examples":{"Update Note":{"description":"Updates the invoice note field","value":{"invoiceNote":"Payment received via wire transfer on January 15, 2026"}}}}},"required":true},"responses":{"204":{"description":"Invoice note updated successfully - No content returned"},"400":{"description":"Bad Request - Invoice status does not allow modification","content":{"application/json":{"examples":{"Archived Invoice":{"description":"Invoice is archived and cannot be modified","value":{"errorCode":"invoice_archived","message":"Cannot update note on archived invoice"}},"Exporting Invoice":{"description":"Invoice is being exported and cannot be modified","value":{"errorCode":"invoice_exporting","message":"Cannot update note while invoice is being exported"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}},"404":{"description":"Invoice not found","content":{"application/json":{"examples":{"Not Found":{"description":"Not Found","value":{"errorCode":"invoice_not_found","message":"Invoice not found"}}}}}}}}},"/v2/billing/products/{id}/activate":{"patch":{"tags":["Billing"],"summary":"Activates a product","description":"Activates a previously deactivated product given its ID.\n\n**Note:** This endpoint returns 204 No Content on success. No product data is returned.\n\nActive products are available for use in agreements and invoices.","operationId":"activateProduct","parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"204":{"description":"Product successfully activated"},"400":{"description":"Bad Request - Product is already activated","content":{"application/json":{"examples":{"Already Activated":{"description":"Already Activated","value":{"resultCode":"product_already_activated","incidentId":"WEB_MGMT_SERVICE-local-development-1767809599-SRTUMBgA"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}},"404":{"description":"Product not found","content":{"application/json":{"examples":{"Not Found":{"description":"Not Found","value":{"resultCode":"product_not_found_or_insufficient_permissions","incidentId":"WEB_MGMT_SERVICE-local-development-1767749367-NWOKBUVT"}}}}}}}}},"/v2/billing/products":{"get":{"tags":["Billing"],"summary":"Get all products","description":"Returns a list of products with optional filters.\n\nThe content field structure varies by quantity type and includes price, cost, taxable, and other type-specific fields:\n- **MANUAL**: price, cost, taxable, billing, quantity, productIds\n- **DEVICE_COUNTS**: price, cost, taxable, billing, anyRole, groupIds, allGroups, nodeRoles, productIds\n- **END_USER_COUNTS**: price, cost, taxable, billing, anyRole, endUserRoles, matchAllRoles, productIds\n- **BACKUP_STORAGE_COUNTS**: price, cost, taxable, billing, anyRole, groupIds, allGroups, nodeRoles, isStorageIncludedPerDevice, includedStorage, productIds\n- **TIME_ENTRIES**: price, cost, taxable, billing, autoRoundTimeEntries, laborCodes, userRoles, onSiteMultiplier, offHoursMultiplier, remoteMultiplier, normalHoursMultiplier, scheduleTypeOffHours, scheduleTypeNormalHours, locationTypeOnSite, locationTypeRemote, includeTime, includedTimeAmountUnlimited, includedHours, unusedCarryOverUnlimited, carryOverLimit, balance, productIds","operationId":"getProducts","parameters":[{"name":"name","in":"query","description":"Filter products by name (case-insensitive partial match)","schema":{"type":"string"},"example":"Product 1"},{"name":"quantityType","in":"query","description":"Filter products by quantity type","schema":{"type":"string"},"example":"DEVICE_COUNTS"},{"name":"accountCode","in":"query","description":"Filter products by account code","schema":{"type":"string"},"example":"HARDWARE"}],"responses":{"200":{"description":"List of products successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"title":"NinjaOneBillingProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the product.","format":"int32","example":1},"name":{"type":"string","description":"Name of the product.","example":"Hardware Support"},"description":{"type":"string","description":"Description of the product.","example":"Monthly hardware support service"},"quantityType":{"type":"string","description":"Quantity type of the product.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","description":"Additional content/configuration for the product. Structure varies by quantity type. Includes price, cost, taxable, and other type-specific fields."},"createTime":{"type":"number","description":"Timestamp when the product was created.","format":"double"},"updateTime":{"type":"number","description":"Timestamp when the product was last updated.","format":"double"},"accountId":{"type":"integer","description":"Account ID associated with the product.","format":"int32","example":8},"group":{"type":"boolean","description":"Whether the product is a group product.","example":false},"taxId":{"type":"integer","description":"Tax ID associated with the product. Null if no specific tax is set.","format":"int32","nullable":true,"example":1},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether the product inherits tax from the agreement.","example":true},"active":{"type":"boolean","description":"Indicates if the product is active.","example":true}},"description":"Representation of a ninja billing Product response."}},"examples":{"Example product response list":{"description":"Example product response list","value":[{"id":1,"name":"Product 1","description":"Product 1","quantityType":"MANUAL","content":{"price":100,"cost":80,"taxable":true,"billing":"BILLABLE","quantity":1,"productIds":[]},"isActive":true,"createTime":1705314600000,"updateTime":1705314600000,"accountId":8,"group":false}]}}}}},"500":{"description":"Permission denied","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"permission_denied","incidentId":"WEB_MGMT_SERVICE-local-development-1768938297-FMKRGGWG"}}}}}}}},"post":{"tags":["Billing"],"summary":"Creates a product","description":"Creates a new product in the catalog.\n\nThe content field structure varies by quantity type and must include all required fields for that type:\n- **Required for all types**: price, cost, taxable, billing\n- **MANUAL**: quantity, productIds\n- **DEVICE_COUNTS**: anyRole, groupIds, allGroups, nodeRoles (optional), productIds\n- **END_USER_COUNTS**: anyRole, endUserRoles (optional), matchAllRoles, productIds\n- **BACKUP_STORAGE_COUNTS**: anyRole, groupIds, allGroups, nodeRoles (optional), isStorageIncludedPerDevice, includedStorage, productIds\n- **TIME_ENTRIES**: autoRoundTimeEntries, laborCodes, userRoles, onSiteMultiplier, offHoursMultiplier, remoteMultiplier, normalHoursMultiplier, scheduleTypeOffHours, scheduleTypeNormalHours, locationTypeOnSite, locationTypeRemote, includeTime, includedTimeAmountUnlimited, includedHours, unusedCarryOverUnlimited, carryOverLimit, productIds\n\nThe productUserRole field controls which technicians can use this product.","operationId":"createProduct","requestBody":{"description":"Product object to create. The content field structure varies by quantity type - see examples for each type.","content":{"*/*":{"schema":{"title":"NinjaOneBillingProductRequest","required":["accountId","content","description","group","name","productUserRole","quantityType"],"type":"object","properties":{"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the product.","example":"Hardware Support"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the product.","example":"Monthly hardware support service"},"quantityType":{"type":"string","description":"Quantity type of the product.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"accountId":{"type":"integer","description":"Account ID associated with the product.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product should be grouped.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"content":{"type":"object","additionalProperties":true,"description":"Additional content/configuration for the product. Structure varies by quantity type."},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing Product request."},"examples":{"MANUAL product":{"description":"Example for creating a manual quantity product","value":{"name":"Manual Product","description":"Manual Product Description","quantityType":"MANUAL","accountId":1,"group":true,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"content":{"cost":40,"price":15.5,"billing":"BILLABLE","taxable":true,"quantity":3,"productIds":[]}}},"DEVICE_COUNTS product":{"description":"Example for creating a device counts product","value":{"name":"Managed Windows Servers","description":"Windows servers product","quantityType":"DEVICE_COUNTS","accountId":1,"group":true,"productUserRole":{"allowAllTechnicians":false,"userRoles":[6,3,1]},"content":{"price":60,"cost":23,"taxable":true,"billing":"BILLABLE","anyRole":false,"groupIds":[1,2],"allGroups":false,"nodeRoles":[1],"productIds":[]}}},"END_USER_COUNTS product":{"description":"Example for creating an end user counts product","value":{"name":"Managed EndUser","description":"Managed EndUser Description","quantityType":"END_USER_COUNTS","accountId":1,"group":false,"productUserRole":{"allowAllTechnicians":false,"userRoles":[6,3,1]},"content":{"price":10,"cost":5,"taxable":true,"billing":"BILLABLE","anyRole":true,"endUserRoles":[2],"matchAllRoles":true,"productIds":[]}}},"BACKUP_STORAGE_COUNTS product":{"description":"Example for creating a backup storage counts product","value":{"name":"Managed Backup","description":"Managed Backup Description","quantityType":"BACKUP_STORAGE_COUNTS","accountId":1,"group":true,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"content":{"price":130,"cost":67,"taxable":true,"billing":"BILLABLE","anyRole":false,"groupIds":[1,2],"allGroups":false,"nodeRoles":[1],"isStorageIncludedPerDevice":false,"includedStorage":35,"productIds":[]}}},"TIME_ENTRIES product":{"description":"Example for creating a time entries product","value":{"name":"TimeEntry Product","description":"TimeEntry Product Description","quantityType":"TIME_ENTRIES","accountId":1,"group":false,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"content":{"price":10,"cost":5,"taxable":true,"billing":"BILLABLE","autoRoundTimeEntries":"ROUND_UP_15_MIN","laborCodes":[1],"onSiteMultiplier":21,"offHoursMultiplier":5,"remoteMultiplier":13,"normalHoursMultiplier":7,"scheduleTypeOffHours":true,"scheduleTypeNormalHours":true,"locationTypeOnSite":true,"locationTypeRemote":true,"includeTime":true,"includedTimeAmountUnlimited":false,"includedHours":0,"unusedCarryOverUnlimited":false,"carryOverLimit":0,"productIds":[],"userRoles":[]}}}}}},"required":true},"responses":{"201":{"description":"Product successfully created","content":{"application/json":{"schema":{"title":"NinjaOneBillingProductDetailResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the product.","format":"int32","example":1},"name":{"type":"string","description":"Name of the product.","example":"Hardware Support"},"description":{"type":"string","description":"Description of the product.","example":"Monthly hardware support service"},"quantityType":{"type":"string","description":"Quantity type of the product.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","description":"Additional content/configuration for the product. Structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings for exporting invoices with this product."},"createTime":{"type":"number","description":"Timestamp when the product was created.","format":"double"},"updateTime":{"type":"number","description":"Timestamp when the product was last updated.","format":"double"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"accountId":{"type":"integer","description":"Account ID associated with the product.","format":"int32","example":8},"group":{"type":"boolean","description":"Whether the product is a group product.","example":false},"taxId":{"type":"integer","description":"Tax ID associated with the product. Null if no specific tax is set.","format":"int32","nullable":true,"example":1},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether the product inherits tax from the agreement.","example":true},"active":{"type":"boolean","description":"Indicates if the product is active.","example":true}},"description":"Detailed representation of a ninja billing Product response."},"examples":{"Created product":{"description":"Created product","value":{"id":1,"name":"Manual Product","description":"A manual quantity product","quantityType":"MANUAL","content":{"cost":40,"price":15.5,"billing":"BILLABLE","taxable":true,"quantity":3,"productIds":[]},"integrationSettings":{"inheritTaxRateFromAgreement":true,"taxRate":null,"inheritAccountCodeFromProductType":true,"accountCode":null},"isActive":true,"createTime":1767694433000,"updateTime":1767694433000,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"accountId":8,"group":false}}}}}},"400":{"description":"Bad Request - Validation error","content":{"application/json":{"examples":{"Validation Error":{"description":"Validation Error","value":{"resultCode":"FAILURE","errorMessage":"Validation failed","errorDetails":{"name":"Product name is required","quantityType":"Invalid quantity type"}}},"Product Group Child Deactivated Validation Error":{"description":"Deactivated products cannot be used within product groups.","value":{"resultCode":"child_product_group_must_be_active","incidentId":"WEB_MGMT_SERVICE-local-development-1767809599-SRTUMBgA"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}},"409":{"description":"Conflict - Product name already exists","content":{"application/json":{"examples":{"Duplicate Name":{"description":"Duplicate Name","value":{"resultCode":"duplicated_product_name","incidentId":"WEB_MGMT_SERVICE-local-development-1767805196-YDMWCvLR"}}}}}}}}},"/v2/billing/products/{id}/deactivate":{"patch":{"tags":["Billing"],"summary":"Deactivates a product","description":"Deactivates a previously activated product given its ID.\n\n**Note:** This endpoint returns 204 No Content on success. No product data is returned.\n\nDeactivated products cannot be added to new agreements but existing agreements will not be affected.","operationId":"deactivateProduct","parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"204":{"description":"Product successfully deactivated"},"400":{"description":"Bad Request - Product is already deactivated","content":{"application/json":{"examples":{"Already Deactivated":{"description":"Already Deactivated","value":{"resultCode":"product_already_deactivated","incidentId":"WEB_MGMT_SERVICE-local-development-1767809599-SRTUMBgA"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}},"404":{"description":"Product not found","content":{"application/json":{"examples":{"Not Found":{"description":"Not Found","value":{"resultCode":"product_not_found_or_insufficient_permissions","incidentId":"WEB_MGMT_SERVICE-local-development-1767749367-NWOKBUVT"}}}}}}}}},"/v2/billing/products/{id}":{"get":{"tags":["Billing"],"summary":"Get product by ID","description":"Retrieves a product by its unique identifier.\n\nThe content field structure varies by quantity type and includes price, cost, taxable, billing type, and other type-specific configuration fields. See the examples for each quantity type to understand the complete structure.","operationId":"getProductById","parameters":[{"name":"id","in":"path","description":"Product ID","required":true,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"Product found","content":{"application/json":{"schema":{"title":"NinjaOneBillingProductDetailResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the product.","format":"int32","example":1},"name":{"type":"string","description":"Name of the product.","example":"Hardware Support"},"description":{"type":"string","description":"Description of the product.","example":"Monthly hardware support service"},"quantityType":{"type":"string","description":"Quantity type of the product.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","description":"Additional content/configuration for the product. Structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings for exporting invoices with this product."},"createTime":{"type":"number","description":"Timestamp when the product was created.","format":"double"},"updateTime":{"type":"number","description":"Timestamp when the product was last updated.","format":"double"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"accountId":{"type":"integer","description":"Account ID associated with the product.","format":"int32","example":8},"group":{"type":"boolean","description":"Whether the product is a group product.","example":false},"taxId":{"type":"integer","description":"Tax ID associated with the product. Null if no specific tax is set.","format":"int32","nullable":true,"example":1},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether the product inherits tax from the agreement.","example":true},"active":{"type":"boolean","description":"Indicates if the product is active.","example":true}},"description":"Detailed representation of a ninja billing Product response."},"examples":{"Manual product":{"description":"Manual product","value":{"id":1,"name":"Manual Product","description":"A manual quantity product","quantityType":"MANUAL","content":{"cost":40,"price":15.5,"billing":"BILLABLE","taxable":true,"quantity":3,"productIds":[]},"integrationSettings":{"inheritTaxRateFromAgreement":true,"taxRate":null,"inheritAccountCodeFromProductType":true,"accountCode":null},"isActive":true,"createTime":1767694433000,"updateTime":1767694433000,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"accountId":8,"group":false}},"Device counts product":{"description":"Device counts product","value":{"id":2,"name":"Managed Devices Product","description":"A device counts product","quantityType":"DEVICE_COUNTS","content":{"price":60,"cost":23,"taxable":true,"billing":"BILLABLE","anyRole":false,"groupIds":[1,2],"allGroups":false,"nodeRoles":[{"id":1,"name":"Windows Workstation"}],"productIds":[]},"integrationSettings":{"inheritTaxRateFromAgreement":true,"taxRate":null,"inheritAccountCodeFromProductType":true,"accountCode":null},"isActive":true,"createTime":1767694433000,"updateTime":1767694433000,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"accountId":8,"group":false}},"Time entries product":{"description":"Time entries product","value":{"id":3,"name":"Time Entries Product","description":"A time entries product","quantityType":"TIME_ENTRIES","content":{"price":10,"cost":5,"taxable":true,"billing":"BILLABLE","autoRoundTimeEntries":"ROUND_UP_15_MIN","laborCodes":[1],"onSiteMultiplier":21,"offHoursMultiplier":5,"remoteMultiplier":13,"normalHoursMultiplier":7,"scheduleTypeOffHours":true,"scheduleTypeNormalHours":true,"locationTypeOnSite":true,"locationTypeRemote":true,"includeTime":true,"includedTimeAmountUnlimited":true,"includedHours":0,"unusedCarryOverUnlimited":true,"carryOverLimit":0,"balance":null,"productIds":[],"userRoles":[]},"integrationSettings":{"inheritTaxRateFromAgreement":true,"taxRate":null,"inheritAccountCodeFromProductType":true,"accountCode":null},"isActive":true,"createTime":1767694433000,"updateTime":1767694433000,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"accountId":8,"group":false}},"End user counts product":{"description":"End user counts product","value":{"id":4,"name":"End User Counts Product","description":"An end user counts product","quantityType":"END_USER_COUNTS","content":{"price":10,"cost":5,"taxable":true,"billing":"BILLABLE","anyRole":true,"endUserRoles":[{"id":2,"name":"End User Role"}],"matchAllRoles":true,"productIds":[]},"integrationSettings":{"inheritTaxRateFromAgreement":true,"taxRate":null,"inheritAccountCodeFromProductType":true,"accountCode":null},"isActive":true,"createTime":1767694433000,"updateTime":1767694433000,"productUserRole":{"allowAllTechnicians":false,"userRoles":[{"id":1,"name":"Admin"}]},"accountId":8,"group":false}},"Backup storage product":{"description":"Backup storage product","value":{"id":5,"name":"Backup Storage Product","description":"A backup storage counts product","quantityType":"BACKUP_STORAGE_COUNTS","content":{"price":130,"cost":67,"taxable":true,"billing":"BILLABLE","anyRole":false,"groupIds":[1,2],"allGroups":false,"nodeRoles":[{"id":1,"name":"Windows Server"}],"isStorageIncludedPerDevice":false,"includedStorage":35,"productIds":[]},"integrationSettings":{"inheritTaxRateFromAgreement":true,"taxRate":null,"inheritAccountCodeFromProductType":true,"accountCode":null},"isActive":true,"createTime":1767694433000,"updateTime":1767694433000,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"accountId":8,"group":false}},"With integration":{"description":"With integration","value":{"id":6,"name":"Xero Integrated Product","description":"A product with Xero integration settings","quantityType":"MANUAL","content":{"cost":40,"price":15.5,"billing":"BILLABLE","taxable":true,"quantity":3,"productIds":[]},"integrationSettings":{"inheritTaxRateFromAgreement":false,"taxRate":"INPUT"},"isActive":true,"createTime":1705314600000,"updateTime":1705314600000,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"accountId":12,"group":false}}}}}},"404":{"description":"Product not found or insufficient permissions","content":{"application/json":{"examples":{"Not Found":{"description":"Not Found","value":{"resultCode":"product_not_found_or_insufficient_permissions","incidentId":"WEB_MGMT_SERVICE-local-development-1767749367-NWOKBUVT"}}}}}}}},"put":{"tags":["Billing"],"summary":"Updates a product","description":"Updates a previously created product given its ID and updated content.\n\nThe content field structure varies by quantity type and must include all required fields for that type (price, cost, taxable, billing, and type-specific fields). See the create product description for details on required fields per quantity type.\n\n**Note:** The quantity type cannot be changed after product creation.","operationId":"updateProduct","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Updated Product object. The content field structure varies by quantity type - see examples for each type.","content":{"*/*":{"schema":{"title":"NinjaOneBillingProductRequest","required":["accountId","content","description","group","name","productUserRole","quantityType"],"type":"object","properties":{"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the product.","example":"Hardware Support"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the product.","example":"Monthly hardware support service"},"quantityType":{"type":"string","description":"Quantity type of the product.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"accountId":{"type":"integer","description":"Account ID associated with the product.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product should be grouped.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"content":{"type":"object","additionalProperties":true,"description":"Additional content/configuration for the product. Structure varies by quantity type."},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing Product request."},"examples":{"MANUAL product update":{"description":"Example for updating a manual quantity product","value":{"name":"Manual Product","description":"Manual Product Description","quantityType":"MANUAL","accountId":1,"group":true,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"content":{"cost":40,"price":15.5,"billing":"BILLABLE","taxable":true,"quantity":3,"productIds":[]}}},"DEVICE_COUNTS product update":{"description":"Example for updating a device counts product","value":{"name":"Managed Windows Servers","description":"Windows servers product","quantityType":"DEVICE_COUNTS","accountId":1,"group":true,"productUserRole":{"allowAllTechnicians":false,"userRoles":[6,3,1]},"content":{"price":60,"cost":23,"taxable":true,"billing":"BILLABLE","anyRole":false,"groupIds":[1,2],"allGroups":false,"nodeRoles":[1],"productIds":[]}}},"END_USER_COUNTS product update":{"description":"Example for updating an end user counts product","value":{"name":"Managed EndUser","description":"Managed EndUser Description","quantityType":"END_USER_COUNTS","accountId":1,"group":false,"productUserRole":{"allowAllTechnicians":false,"userRoles":[6,3,1]},"content":{"price":10,"cost":5,"taxable":true,"billing":"BILLABLE","anyRole":true,"endUserRoles":[2],"matchAllRoles":true,"productIds":[]}}},"BACKUP_STORAGE_COUNTS product update":{"description":"Example for updating a backup storage counts product","value":{"name":"Managed Backup","description":"Managed Backup Description","quantityType":"BACKUP_STORAGE_COUNTS","accountId":1,"group":true,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"content":{"price":130,"cost":67,"taxable":true,"billing":"BILLABLE","anyRole":false,"groupIds":[1,2],"allGroups":false,"nodeRoles":[1],"isStorageIncludedPerDevice":false,"includedStorage":35,"productIds":[]}}},"TIME_ENTRIES product update":{"description":"Example for updating a time entries product","value":{"name":"TimeEntry Product","description":"TimeEntry Product Description","quantityType":"TIME_ENTRIES","accountId":1,"group":false,"productUserRole":{"allowAllTechnicians":true,"userRoles":[]},"content":{"price":10,"cost":5,"taxable":true,"billing":"BILLABLE","autoRoundTimeEntries":"ROUND_UP_15_MIN","laborCodes":[1],"onSiteMultiplier":21,"offHoursMultiplier":5,"remoteMultiplier":13,"normalHoursMultiplier":7,"scheduleTypeOffHours":true,"scheduleTypeNormalHours":true,"locationTypeOnSite":true,"locationTypeRemote":true,"includeTime":true,"includedTimeAmountUnlimited":false,"includedHours":0,"unusedCarryOverUnlimited":false,"carryOverLimit":0,"productIds":[],"userRoles":[]}}}}}},"required":true},"responses":{"200":{"description":"Product successfully updated","content":{"application/json":{"schema":{"title":"NinjaOneBillingProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the product.","format":"int32","example":1},"name":{"type":"string","description":"Name of the product.","example":"Hardware Support"},"description":{"type":"string","description":"Description of the product.","example":"Monthly hardware support service"},"quantityType":{"type":"string","description":"Quantity type of the product.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","description":"Additional content/configuration for the product. Structure varies by quantity type. Includes price, cost, taxable, and other type-specific fields."},"createTime":{"type":"number","description":"Timestamp when the product was created.","format":"double"},"updateTime":{"type":"number","description":"Timestamp when the product was last updated.","format":"double"},"accountId":{"type":"integer","description":"Account ID associated with the product.","format":"int32","example":8},"group":{"type":"boolean","description":"Whether the product is a group product.","example":false},"taxId":{"type":"integer","description":"Tax ID associated with the product. Null if no specific tax is set.","format":"int32","nullable":true,"example":1},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether the product inherits tax from the agreement.","example":true},"active":{"type":"boolean","description":"Indicates if the product is active.","example":true}},"description":"Representation of a ninja billing Product response."},"examples":{"Updated product":{"description":"Updated product","value":{"id":1,"name":"Product 1","description":"Product 1","quantityType":"MANUAL","content":{"price":100,"cost":80,"taxable":true,"billing":"BILLABLE","quantity":1,"productIds":[]},"isActive":true,"createTime":1705314600000,"updateTime":1705314600000,"accountId":8,"group":false}}}}}},"400":{"description":"Bad Request - Validation error","content":{"application/json":{"examples":{"Validation Error":{"description":"Validation Error","value":{"resultCode":"FAILURE","errorMessage":"Validation failed","errorDetails":{"name":"Product name is required","quantityType":"Invalid quantity type"}}},"Product Group Child Deactivated Validation Error":{"description":"Deactivated products cannot be used within product groups.","value":{"resultCode":"child_product_group_must_be_active","incidentId":"WEB_MGMT_SERVICE-local-development-1767809599-SRTUMBgA"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}},"404":{"description":"Product not found","content":{"application/json":{"examples":{"Not Found":{"description":"Not Found","value":{"resultCode":"product_not_found_or_insufficient_permissions","incidentId":"WEB_MGMT_SERVICE-local-development-1767749367-NWOKBUVT"}}}}}},"409":{"description":"Conflict - Product name already exists","content":{"application/json":{"examples":{"Duplicate Name":{"description":"Duplicate Name","value":{"resultCode":"duplicated_product_name","incidentId":"WEB_MGMT_SERVICE-local-development-1767805196-YDMWCvLR"}}}}}}}}},"/v2/billing/ticket-products/adhoc":{"post":{"tags":["Billing"],"summary":"Creates an adhoc ticket product.","description":"Creates a ticket product that is not associated to a product and attaches it to a ticket.","operationId":"createAdhocTicketProducts","requestBody":{"description":"Adhoc ticket product object to be created.","content":{"application/json":{"schema":{"title":"NinjaOneBillingTicketProductRequest","required":["accountId","content","description","group","name","productId","quantityType","ticketId"],"type":"object","properties":{"name":{"maxLength":50,"minLength":0,"type":"string","description":"Ticket product name.","example":"Billable Ticket Product Name."},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Ticket product description.","example":"This is a billable ticket product description."},"quantityType":{"type":"string","description":"How the product quantity is calculated. in billing.","example":"MANUAL","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product basic information needed to its calculations."},"ticketId":{"minimum":1,"type":"integer","description":"Ticket ID where the product is assigned.","format":"int32","example":12},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","nullable":true,"example":19},"accountId":{"type":"integer","description":"Account ID assigned to the product.","format":"int32","example":1},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"group":{"type":"boolean","description":"Whether the product can be built as group.","example":true}},"description":"Representation of a ninja billing ticket product request."},"examples":{"MANUAL non-catalog ticket product":{"description":"Example for creating a non-catalog manual quantity ticket product","value":{"name":"manual non-catalog ticket product","description":"ticket product description","quantityType":"MANUAL","content":{"cost":40,"price":15.5,"billing":"BILLABLE","taxable":true,"quantity":3,"productIds":[]},"ticketId":1205,"productId":null,"productUserRole":null,"integrationSettings":{"inheritTaxRateFromAgreement":false,"inheritAccountCodeFromProductType":false,"taxRate":"INPUT","accountCode":"cd43907c-be47-4340-9886-979b0ea17dca"},"accountId":5,"group":false}}}}},"required":true},"responses":{"200":{"description":"Successfully created non-catalog/adhoc ticket product.","content":{"application/json":{"schema":{"title":"NinjaOneBillingTicketProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"billingStatus":{"type":"string","enum":["BILLED","PENDING","NOT_BILLABLE","UNASSIGNED"]},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"technician":{"title":"NinjaOneBillingTicketTechnician","type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"id":{"type":"integer","format":"int32"},"email":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Representation of a ninja billing Technician."},"productId":{"type":"integer","format":"int32"},"integrationSettings":{"type":"object","additionalProperties":true},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing Ticket Product."},"examples":{"Created non-catalog ticket product":{"description":"Created non-catalog ticket product","value":{"id":16,"name":"ticket product","description":"ticket product description","billingStatus":"BILLED","quantityType":"MANUAL","content":{"price":150.5,"cost":45,"quantity":10},"technician":{"firstName":"Test","lastName":"User","id":1,"email":"test.user@ninja.com","deleted":false},"productId":1}}}}}},"400":{"description":"Ticket product creation request validation error","content":{"application/json":{"examples":{"Invalid user roles":{"description":"Ticket product content contains not null user roles","value":{"resultCode":"invalid_adhoc_ticket_product_role_request","incidentId":"WEB_MGMT_SERVICE-local-development-1769096312-REPQJJJR"}},"Invalid adhoc content":{"description":"Ticket products content contains product id","value":{"resultCode":"invalid_request_content","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}},"Agreement assignment required":{"description":"Ticket products can not be added tickets that do not have assigned agreements","value":{"resultCode":"agreement_is_required","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}},"Invalid ticket status":{"description":"Ticket products can not be added to closed or deleted tickets","value":{"resultCode":"invalid_ticket_status","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}},"Invalid quantity type":{"description":"Ticket products can only be MANUAL quantity type","value":{"resultCode":"unsupported_quantity_type","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}},"Product Group Child Deactivated Validation Error":{"description":"Deactivated products cannot be used within product groups.","value":{"resultCode":"child_product_group_must_be_active","incidentId":"WEB_MGMT_SERVICE-local-development-1767809599-SRTUMBgA"}}}}}},"404":{"description":"Ticket not found","content":{"application/json":{"examples":{"Not Found":{"description":"Not Found","value":{"resultCode":"ticket_not_found","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}}}}}},"500":{"description":"Permission not granted","content":{"application/json":{"examples":{"Organization access denied":{"description":"Organization access permission not granted","value":{"resultCode":"access_denied","incidentId":"WEB_MGMT_SERVICE-local-development-1769098750-YKWUCNQB"}},"Ticket Product view denied":{"description":"Ticket products view permission not granted","value":{"resultCode":"access_denied","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}}}}}}}}},"/v2/billing/ticket-products/catalog":{"post":{"tags":["Billing"],"summary":"Creates a catalog ticket product.","description":"Creates a ticket product that is associated to a product and attaches it to a ticket.","operationId":"createCatalogTicketProducts","requestBody":{"description":"Catalog ticket product object to be created.","content":{"application/json":{"schema":{"title":"NinjaOneBillingTicketProductRequest","required":["accountId","content","description","group","name","productId","quantityType","ticketId"],"type":"object","properties":{"name":{"maxLength":50,"minLength":0,"type":"string","description":"Ticket product name.","example":"Billable Ticket Product Name."},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Ticket product description.","example":"This is a billable ticket product description."},"quantityType":{"type":"string","description":"How the product quantity is calculated. in billing.","example":"MANUAL","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product basic information needed to its calculations."},"ticketId":{"minimum":1,"type":"integer","description":"Ticket ID where the product is assigned.","format":"int32","example":12},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","nullable":true,"example":19},"accountId":{"type":"integer","description":"Account ID assigned to the product.","format":"int32","example":1},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"group":{"type":"boolean","description":"Whether the product can be built as group.","example":true}},"description":"Representation of a ninja billing ticket product request."},"examples":{"MANUAL catalog ticket product":{"description":"Example for creating a catalog manual quantity ticket product","value":{"name":"manual catalog ticket product","description":"ticket product description","quantityType":"MANUAL","content":{"cost":40,"price":15.5,"billing":"BILLABLE","taxable":true,"quantity":3,"productIds":[]},"ticketId":1205,"productId":2,"productUserRole":{"allowAllTechnicians":false,"userRoles":[6,3,1]},"integrationSettings":{"inheritTaxRateFromAgreement":true,"taxRate":null,"inheritAccountCodeFromProductType":true,"accountCode":null},"accountId":5,"group":false}}}}},"required":true},"responses":{"200":{"description":"Successfully created catalog ticket product.","content":{"application/json":{"schema":{"title":"NinjaOneBillingTicketProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"billingStatus":{"type":"string","enum":["BILLED","PENDING","NOT_BILLABLE","UNASSIGNED"]},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"technician":{"title":"NinjaOneBillingTicketTechnician","type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"id":{"type":"integer","format":"int32"},"email":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Representation of a ninja billing Technician."},"productId":{"type":"integer","format":"int32"},"integrationSettings":{"type":"object","additionalProperties":true},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing Ticket Product."},"examples":{"Created catalog ticket product":{"description":"Created catalog ticket product","value":{"id":16,"name":"ticket product","description":"ticket product description","billingStatus":"BILLED","quantityType":"MANUAL","content":{"price":150.5,"cost":45,"quantity":10},"technician":{"firstName":"Test","lastName":"User","id":1,"email":"test.user@ninja.com","deleted":false},"productId":1}}}}}},"400":{"description":"Ticket product creation request validation error","content":{"application/json":{"examples":{"Invalid quantity type":{"description":"Ticket products can only be MANUAL quantity type","value":{"resultCode":"unsupported_quantity_type","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}},"Invalid ticket status":{"description":"Ticket products can not be added to closed or deleted tickets","value":{"resultCode":"invalid_ticket_status","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}},"Agreement assignment required":{"description":"Ticket products can not be added tickets that do not have assigned agreements","value":{"resultCode":"agreement_is_required","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}},"Product Group Child Deactivated Validation Error":{"description":"Deactivated products cannot be used within product groups.","value":{"resultCode":"child_product_group_must_be_active","incidentId":"WEB_MGMT_SERVICE-local-development-1767809599-SRTUMBgA"}}}}}},"404":{"description":"Ticket not found","content":{"application/json":{"examples":{"Not Found":{"description":"Not Found","value":{"resultCode":"ticket_not_found","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}}}}}},"500":{"description":"Permission not granted","content":{"application/json":{"examples":{"Organization access denied":{"description":"Organization access permission not granted","value":{"resultCode":"access_denied","incidentId":"WEB_MGMT_SERVICE-local-development-1769098750-YKWUCNQB"}},"Ticket Product view denied":{"description":"Ticket products view permission not granted","value":{"resultCode":"access_denied","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}}}}}}}}},"/v2/billing/ticket-products/ticket/{id}":{"get":{"tags":["Billing"],"summary":"Get all products related to a ticket","description":"Returns a list with all existing products associated to a ticket given its ID.","operationId":"getByTicketId","parameters":[{"name":"id","in":"path","description":"Ticket ID","required":true,"schema":{"type":"integer","format":"int32"},"example":1}],"responses":{"200":{"description":"List of ticket products successfully retrieved","content":{"application/json":{"schema":{"type":"array","items":{"title":"NinjaOneBillingTicketProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"billingStatus":{"type":"string","enum":["BILLED","PENDING","NOT_BILLABLE","UNASSIGNED"]},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"technician":{"title":"NinjaOneBillingTicketTechnician","type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"id":{"type":"integer","format":"int32"},"email":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Representation of a ninja billing Technician."},"productId":{"type":"integer","format":"int32"},"integrationSettings":{"type":"object","additionalProperties":true},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing Ticket Product."}},"examples":{"Example ticket product response list":{"description":"Example ticket product response list","value":[{"id":16,"name":"ticket product","description":"ticket product description","billingStatus":"BILLED","quantityType":"MANUAL","content":{"price":150.5,"cost":45,"quantity":10},"technician":{"firstName":"Test","lastName":"User","id":1,"email":"test.user@ninja.com","deleted":false},"productId":1}]}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}},"404":{"description":"Ticket not found","content":{"application/json":{"examples":{"Not Found":{"description":"Not Found","value":{"resultCode":"ticket_not_found","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}}}}}},"500":{"description":"Permission not granted","content":{"application/json":{"examples":{"Organization access denied":{"description":"Organization access permission not granted","value":{"resultCode":"access_denied","incidentId":"WEB_MGMT_SERVICE-local-development-1769098750-YKWUCNQB"}},"Ticket Product view denied":{"description":"Ticket products view permission not granted","value":{"resultCode":"access_denied","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}}}}}}}}},"/v2/billing/ticket-products/delete":{"post":{"tags":["Billing"],"summary":"Removes a list of ticket products from a ticket","description":"Removes a list of ticket products given its IDs from a ticket given its ID","operationId":"removeTicketProducts","requestBody":{"description":"Ticket Product ID list and ticket ID from which these will be removed.","content":{"application/json":{"schema":{"title":"NinjaOneBillingTicketProductRemovalRequest","required":["ticketId","ticketProductIds"],"type":"object","properties":{"ticketId":{"minimum":1,"type":"integer","description":"Ticket ID from which products will be removed.","format":"int32","example":19},"ticketProductIds":{"uniqueItems":true,"type":"array","description":"List of Ticket Product IDs to be removed","items":{"type":"integer","description":"Ticket Product ID to be removed.","format":"int32","example":19}}},"description":"Needed data to remove a list of ticket products from an existing ticket."},"examples":{"Ticket product remove request":{"description":"Ticket ID and ticket product IDs to be removed","value":{"ticketId":1001,"ticketProductIds":[36,45]}}}}},"required":true},"responses":{"400":{"description":"Ticket product remove request validation error","content":{"*/*":{"examples":{"Billed ticket product":{"description":"Remove request can not contain billed ticket products","value":{"resultCode":"billed_ticket_product_exists","incidentId":"WEB_MGMT_SERVICE-local-development-1769096312-REPQJJJR"}},"Invalid ticket status":{"description":"Ticket products can not be added or removed from closed or deleted tickets","value":{"resultCode":"invalid_ticket_status","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}}}}}},"404":{"description":"Ticket not found","content":{"*/*":{"examples":{"Not Found":{"description":"Not Found","value":{"resultCode":"ticket_not_found","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}}}}}},"500":{"description":"Permission not granted","content":{"*/*":{"examples":{"Organization access denied":{"description":"Organization access permission not granted","value":{"resultCode":"access_denied","incidentId":"WEB_MGMT_SERVICE-local-development-1769098750-YKWUCNQB"}},"Ticket Product view denied":{"description":"Ticket products view permission not granted","value":{"resultCode":"access_denied","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}}}}}}}}},"/v2/billing/ticket-products/{ticketProductId}":{"put":{"tags":["Billing"],"summary":"Updates a ticket product.","description":"Updates a ticket product from a ticket.","operationId":"updateTicketProducts","parameters":[{"name":"ticketProductId","in":"path","description":"Ticket product ID","required":true,"schema":{"type":"integer","format":"int32"},"example":1}],"requestBody":{"description":"Updated Ticket Product object","content":{"application/json":{"schema":{"title":"NinjaOneBillingTicketProductRequest","required":["accountId","content","description","group","name","productId","quantityType","ticketId"],"type":"object","properties":{"name":{"maxLength":50,"minLength":0,"type":"string","description":"Ticket product name.","example":"Billable Ticket Product Name."},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Ticket product description.","example":"This is a billable ticket product description."},"quantityType":{"type":"string","description":"How the product quantity is calculated. in billing.","example":"MANUAL","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product basic information needed to its calculations."},"ticketId":{"minimum":1,"type":"integer","description":"Ticket ID where the product is assigned.","format":"int32","example":12},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","nullable":true,"example":19},"accountId":{"type":"integer","description":"Account ID assigned to the product.","format":"int32","example":1},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"group":{"type":"boolean","description":"Whether the product can be built as group.","example":true}},"description":"Representation of a ninja billing ticket product request."},"examples":{"MANUAL catalog ticket product":{"description":"Example for updating a catalog ticket product","value":{"name":"manual catalog ticket product","description":"ticket product description","quantityType":"MANUAL","content":{"cost":40,"price":15.5,"billing":"BILLABLE","taxable":true,"quantity":3,"productIds":[]},"ticketId":1205,"productId":2,"productUserRole":{"allowAllTechnicians":false,"userRoles":[6,3,1]},"integrationSettings":{"inheritTaxRateFromAgreement":true,"taxRate":null,"inheritAccountCodeFromProductType":true,"accountCode":null},"accountId":5,"group":false}},"MANUAL non-catalog ticket product":{"description":"Example for updating a non-catalog ticket product","value":{"name":"manual non-catalog ticket product","description":"ticket product description","quantityType":"MANUAL","content":{"cost":40,"price":15.5,"billing":"BILLABLE","taxable":true,"quantity":3,"productIds":[]},"ticketId":1205,"productId":null,"productUserRole":null,"integrationSettings":{"inheritTaxRateFromAgreement":false,"inheritAccountCodeFromProductType":false,"taxRate":"INPUT","accountCode":"cd43907c-be47-4340-9886-979b0ea17dca"},"accountId":5,"group":false}}}}},"required":true},"responses":{"200":{"description":"Successfully updated ticket product.","content":{"application/json":{"schema":{"title":"NinjaOneBillingTicketProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"billingStatus":{"type":"string","enum":["BILLED","PENDING","NOT_BILLABLE","UNASSIGNED"]},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"technician":{"title":"NinjaOneBillingTicketTechnician","type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"id":{"type":"integer","format":"int32"},"email":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Representation of a ninja billing Technician."},"productId":{"type":"integer","format":"int32"},"integrationSettings":{"type":"object","additionalProperties":true},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing Ticket Product."},"examples":{"Updated ticket product":{"description":"Updated ticket product","value":{"id":16,"name":"ticket product","description":"ticket product description","billingStatus":"BILLED","quantityType":"MANUAL","content":{"price":150.5,"cost":45,"quantity":10},"technician":{"firstName":"Test","lastName":"User","id":1,"email":"test.user@ninja.com","deleted":false},"productId":1}}}}}},"400":{"description":"Ticket product update request validation error","content":{"application/json":{"examples":{"Content validation error":{"description":"Ticket product content has a validation error","value":{"resultCode":"FAILURE","errorMessage":"Validation failed","errorDetails":{"name":"Product name is required","quantityType":"Invalid quantity type"}}},"Agreement assignment required":{"description":"Ticket products can not be added to tickets that do not have assigned agreements","value":{"resultCode":"agreement_is_required","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}},"Invalid ticket status":{"description":"Ticket products can not be added or removed from closed or deleted tickets","value":{"resultCode":"invalid_ticket_status","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}},"Ticket product billed":{"description":"Already billed ticket products can not be updated","value":{"resultCode":"ticket_product_is_already_billed","incidentId":"WEB_MGMT_SERVICE-local-development-1769096312-REPQJJJR"}},"Ticket changed":{"description":"Ticket can not be updated","value":{"resultCode":"ticket_can_not_be_changed","incidentId":"WEB_MGMT_SERVICE-local-development-1769096312-REPQJJJR"}},"Catalog ticket product type changed":{"description":"Catalog ticket product can not be updated to be adhoc","value":{"resultCode":"current_catalog_product_can_not_be_changed_to_adhoc","incidentId":"WEB_MGMT_SERVICE-local-development-1769096312-REPQJJJR"}},"Adhoc ticket product type changed":{"description":"Adhoc ticket product can not be updated to be catalog","value":{"resultCode":"current_adhoc_product_can_not_be_changed_to_catalog","incidentId":"WEB_MGMT_SERVICE-local-development-1769096312-REPQJJJR"}},"Product changed":{"description":"Product can not be updated","value":{"resultCode":"product_can_not_be_changed","incidentId":"WEB_MGMT_SERVICE-local-development-1769096312-REPQJJJR"}},"Product Group Child Deactivated Validation Error":{"description":"Deactivated products cannot be used within product groups.","value":{"resultCode":"child_product_group_must_be_active","incidentId":"WEB_MGMT_SERVICE-local-development-1767809599-SRTUMBgA"}}}}}},"404":{"description":"Ticket not found","content":{"application/json":{"examples":{"Not Found":{"description":"Not Found","value":{"resultCode":"ticket_not_found","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}}}}}},"500":{"description":"Permission not granted","content":{"application/json":{"examples":{"Organization access denied":{"description":"Organization access permission not granted","value":{"resultCode":"access_denied","incidentId":"WEB_MGMT_SERVICE-local-development-1769098750-YKWUCNQB"}},"Ticket Product view denied":{"description":"Ticket products view permission not granted","value":{"resultCode":"access_denied","incidentId":"WEB_MGMT_SERVICE-local-development-1769058361-EANICZSY"}}}}}}}}},"/v2/billing/ticket-time-entry/{timeEntryId}":{"put":{"tags":["Billing"],"summary":"Updates PSA properties of a ticket time entry","description":"Updates the PSA billing properties of a ticket time entry.","operationId":"updatePsaProperties","parameters":[{"name":"timeEntryId","in":"path","description":"Time Entry ID","required":true,"schema":{"type":"integer","format":"int64"},"example":12345}],"requestBody":{"description":"Time entry PSA properties to update","content":{"application/json":{"schema":{"type":"object","properties":{"startDate":{"type":"string"},"remote":{"type":"boolean"},"inHours":{"type":"object","properties":{"agreementId":{"type":"integer","format":"int32"},"agreementProductId":{"type":"integer","format":"int32"},"billingType":{"type":"string","enum":["BILLABLE","NOT_BILLABLE","NO_CHARGE"]},"timeTracked":{"type":"integer","format":"int32"},"agreementOriginType":{"type":"string","enum":["NONE","SELF","TICKET"]}}},"offHours":{"type":"object","properties":{"agreementId":{"type":"integer","format":"int32"},"agreementProductId":{"type":"integer","format":"int32"},"billingType":{"type":"string","enum":["BILLABLE","NOT_BILLABLE","NO_CHARGE"]},"timeTracked":{"type":"integer","format":"int32"},"agreementOriginType":{"type":"string","enum":["NONE","SELF","TICKET"]}}},"billingNote":{"maxLength":2000,"minLength":0,"type":"string"}}},"examples":{"Update PSA properties":{"description":"Example for updating PSA properties of a time entry","value":{"inHours":{"agreementOriginType":"SELF","agreementId":10,"agreementProductId":5,"timeTracked":1800},"offHours":{"agreementOriginType":"NONE","agreementId":1,"agreementProductId":1,"timeTracked":0},"billingNote":"test note"}}}}},"required":true},"responses":{"200":{"description":"Time entry PSA properties successfully updated","content":{"application/json":{"schema":{"title":"NinjaOneBillingTicketTimeEntryResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the time entry (same as ticket log entry ID).","format":"int64","example":12345},"ticketId":{"type":"integer","description":"ID of the ticket this time entry belongs to.","format":"int32","example":1001},"timeTracked":{"type":"integer","description":"Time tracked in seconds.","format":"int32","example":3600},"startDate":{"type":"number","description":"Start date of the time entry.","format":"double"},"remote":{"type":"boolean","description":"Whether the time entry was performed remotely.","example":false},"createTime":{"type":"number","description":"Creation timestamp of the time entry.","format":"double"},"updateTime":{"type":"number","description":"Last update timestamp of the time entry.","format":"double"},"billingNote":{"type":"string","description":"Note added to give context on the comment|work being billed.","example":"should be charged weekly"}},"description":"Representation of a ninja billing Ticket Time Entry."},"examples":{"Updated time entry":{"description":"Updated time entry","value":{"id":12345,"ticketId":1001,"timeTracked":3600,"startDate":1767609233000,"remote":false,"agreementOriginType":"SELF","agreementProductId":5,"price":150,"invoiceId":1,"agreementId":10,"billingStatus":"PENDING","createTime":1767609233000,"updateTime":1767609233000}}}}}},"400":{"description":"Bad Request - Validation error","content":{"application/json":{"examples":{"Agreement Required for SELF Origin":{"description":"Agreement ID must be provided when agreement origin type is SELF","value":{"resultCode":"agreement_must_be_provided_when_agreement_origin_type_is_self","incidentId":"abc123"}},"Agreement Not Allowed for NONE/TICKET Origin":{"description":"Agreement ID must not be provided when agreement origin type is NONE or TICKET","value":{"resultCode":"agreement_must_not_be_provided_when_agreement_origin_type_is_none_or_ticket","incidentId":"abc123"}},"Agreement Product Not Allowed for NONE Origin":{"description":"Agreement product ID must not be provided when origin type is NONE","value":{"resultCode":"agreement_product_must_not_be_provided_when_origin_none","incidentId":"abc123"}},"Agreement Product Invalid":{"description":"The agreement product does not belong to the specified agreement","value":{"resultCode":"agreement_product_does_not_belong_to_specified_agreement","incidentId":"abc123"}},"Agreement Product Not Labor":{"description":"The agreement product is not a labor/ticket time entry type","value":{"resultCode":"agreement_product_is_not_labor_ticket_time_entry","incidentId":"abc123"}},"Billing Data Already On Invoice":{"description":"Cannot update time entry because all billing data is already on an invoice","value":{"resultCode":"time_entry_billing_data_already_on_invoice","incidentId":"abc123"}},"Cannot Update Start Date/Remote When Billed":{"description":"Cannot update start date or remote flag when any billing data is on an invoice","value":{"resultCode":"cannot_update_start_date_or_remote_when_billing_data_on_invoice","incidentId":"abc123"}},"Timer Not Enabled":{"description":"Timer functionality is not enabled on the ticket form","value":{"resultCode":"timer_not_enabled_on_ticket_form","incidentId":"abc123"}}}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"examples":{"Forbidden":{"description":"Forbidden","value":{"resultCode":"FAILURE","errorMessage":"Insufficient permissions"}}}}}},"404":{"description":"Time entry not found","content":{"application/json":{"examples":{"Not Found":{"description":"Not Found","value":{"resultCode":"NOT_FOUND","errorMessage":"time_entry_not_found","incidentId":"abc123"}}}}}},"409":{"description":"Conflict - Time entry billing data is already on an invoice","content":{"application/json":{"examples":{"Already Billed":{"description":"Already Billed","value":{"resultCode":"CONFLICT","errorMessage":"time_entry_already_billed","incidentId":"abc123"}}}}}}}}},"/v2/staged-device":{"post":{"tags":["Unmanaged Devices"],"summary":"Create staged device","description":"Create staged device","operationId":"createStagedDevice","requestBody":{"content":{"application/json":{"schema":{"required":["locationId","name","orgId","roleId"],"type":"object","properties":{"name":{"maxLength":200,"minLength":0,"type":"string","description":"The display name of the device to be created"},"orgId":{"type":"integer","description":"The id of the organization the device belongs to","format":"int32"},"locationId":{"type":"integer","description":"The id of the location the device belongs to","format":"int32"},"roleId":{"type":"integer","description":"The id of the role to use for this device","format":"int32"},"assignedUserUid":{"type":"string","description":"The UUID of the user this device is assigned to","format":"uuid"},"warrantyStartDate":{"type":"number","description":"The warranty start date for the device, in unix epoch seconds","format":"double"},"warrantyEndDate":{"type":"number","description":"The warranty end date for the device, in unix epoch seconds","format":"double"},"itamAssetId":{"type":"string","description":"The asset id to use for the new device"},"itamAssetStatus":{"type":"string","description":"The asset status to use for the new device"},"itamAssetPurchaseDate":{"type":"number","description":"The purchase date of the new device","format":"double"},"itamAssetPurchaseAmount":{"type":"number","description":"The purchase amount of the new device","format":"float"},"itamAssetExpectedLifetime":{"type":"string","description":"The expected lifetime of the new device"},"itamAssetEndOfLifeDate":{"type":"number","description":"The end of life date for the new device","format":"double"},"itamAssetSerialNumber":{"type":"string"}}}}}},"responses":{"200":{"description":"The id of the Staged Device that was created","content":{"application/json":{"schema":{"type":"object","properties":{"nodeId":{"type":"integer","format":"int32"}}}}}},"400":{"description":"Request validation failed"},"403":{"description":"Insufficient permissions to perform operation"}}}},"/v2/tab":{"post":{"tags":["Custom Tabs"],"summary":"Create a new Custom Tab","description":"Create a Custom Tab with the provided details","operationId":"createCustomTabPublicApi","requestBody":{"description":"The Custom Tab to be created","content":{"application/json":{"schema":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The display name to use for the custom tab"},"description":{"maxLength":250,"minLength":0,"type":"string","description":"The description to use for the custom tab"},"entityType":{"type":"string","description":"The type to use for the custom tab. Organizations and Locations share the same type of tab","enum":["NODE_ROLE","ORGANIZATION","END_USER","SYSTEM","GLOBAL"]},"entityId":{"minimum":1,"type":"integer","description":"For tab types that require an id to create (currently, only NODE_ROLE types), this field is the ID of the entity","format":"int32"},"items":{"type":"array","description":"The initial list of content items to include in the tab","items":{"type":"object","properties":{"itemType":{"type":"string","description":"Specifies whether this item is an ATTRIBUTE or a UI_ELEMENT","enum":["ATTRIBUTE","UI_ELEMENT"]},"id":{"type":"integer","description":"If the content item is an attribute, then this will be the id of that attribute otherwise this should be omitted","format":"int32"},"name":{"type":"string"},"uiElementUid":{"type":"string","format":"uuid"},"uiElementType":{"type":"string","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string"},"uiElementCreateTime":{"type":"number","format":"double"},"uiElementUpdateTime":{"type":"number","format":"double"}}}},"position":{"type":"integer","format":"int32"}}}}}},"responses":{"200":{"description":"The Custom Tab that was created","content":{"application/json":{"schema":{"type":"object","properties":{"default":{"type":"boolean"},"id":{"type":"integer","description":"Tab ID","format":"int32"},"name":{"type":"string","description":"Display name of tab"},"description":{"type":"string","description":"The description to use for the custom tab"},"entityType":{"type":"string","description":"The type of object the tab is for (ie, NODE_ROLE, ORGANIZATION, END_USER, etc)","enum":["NODE_ROLE","ORGANIZATION","END_USER","SYSTEM","GLOBAL"]},"entityId":{"type":"integer","description":"For entity types that are bound to an ID, this will be the id of the object. Otherwise, omitted","format":"int32"},"parentTabId":{"type":"integer","description":"For tab extensions, this will be the id of the tab that was extended (ie, the 'root tab')","format":"int32"},"items":{"type":"array","description":"The content of the tab","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID of an attribute","format":"int32"},"name":{"type":"string","description":"Name of the content item"},"fieldName":{"type":"string","description":"Field name of the attribute"},"description":{"type":"string","description":"Description of the content item"},"entityType":{"type":"string","description":"Entity type that this custom field or operation applies to","enum":["USER","NODE","TICKET","DOCUMENT","INPUT_FIELD_FORM"]},"attributeType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"attributeScope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition scopes of the attribute","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"defaultValue":{"type":"string","description":"For multi-select attributes, this is the id of the default value"},"content":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean","description":"Whether the attribute should be customized for end users"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","description":"For multi-select attributes, this is the list of values available","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean","description":"Boolean representing whether the attribute is required or not"},"footerText":{"type":"string","description":"Text to include after rendering the attribute"},"tooltipText":{"type":"string","description":"Text to use as a tooltip for the attribute"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"For multi-select attributes, these are the available content options"},"active":{"type":"boolean","description":"Whether the attribute is active or not"},"createTime":{"type":"number","description":"The time that the attribute was created (unix epoch)","format":"double"},"updateTime":{"type":"number","description":"The time that the attribute was last updated (unix epoch)","format":"double"},"uiElementUid":{"type":"string","description":"For UI elements, the uuid of the element","format":"uuid"},"uiElementType":{"type":"string","description":"For UI elements, type of the element","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"For UI elements, value of the element"},"uiElementCreateTime":{"type":"number","description":"For UI elements, timestamp of when the element was created (unix epoch)","format":"double"},"uiElementUpdateTime":{"type":"number","description":"For UI elements, timestamp of when the element was last updated (unix epoch)","format":"double"}},"description":"This object represents either an attribute, or a UI Element. The available attributes will depend on which type it is"}},"position":{"type":"integer","description":"Integer representing the position of the tab. Used when ordering multiple tabs","format":"int32"},"isDefault":{"type":"boolean","description":"True if this is a default tab, false otherwise"}}}}}}}}},"/v2/tab/{tabId}":{"get":{"tags":["Custom Tabs"],"summary":"Retrieve a Custom Tab","description":"Gets a custom tab. NOTE: This will _not_ fetch tab extensions. You must use the GET tab/{tabId}/role/{roleId} for that","operationId":"getCustomTabPublicApi","parameters":[{"name":"tabId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"The Custom Tab that was requested","content":{"application/json":{"schema":{"type":"object","properties":{"default":{"type":"boolean"},"id":{"type":"integer","description":"Tab ID","format":"int32"},"name":{"type":"string","description":"Display name of tab"},"description":{"type":"string","description":"The description to use for the custom tab"},"entityType":{"type":"string","description":"The type of object the tab is for (ie, NODE_ROLE, ORGANIZATION, END_USER, etc)","enum":["NODE_ROLE","ORGANIZATION","END_USER","SYSTEM","GLOBAL"]},"entityId":{"type":"integer","description":"For entity types that are bound to an ID, this will be the id of the object. Otherwise, omitted","format":"int32"},"parentTabId":{"type":"integer","description":"For tab extensions, this will be the id of the tab that was extended (ie, the 'root tab')","format":"int32"},"items":{"type":"array","description":"The content of the tab","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID of an attribute","format":"int32"},"name":{"type":"string","description":"Name of the content item"},"fieldName":{"type":"string","description":"Field name of the attribute"},"description":{"type":"string","description":"Description of the content item"},"entityType":{"type":"string","description":"Entity type that this custom field or operation applies to","enum":["USER","NODE","TICKET","DOCUMENT","INPUT_FIELD_FORM"]},"attributeType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"attributeScope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition scopes of the attribute","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"defaultValue":{"type":"string","description":"For multi-select attributes, this is the id of the default value"},"content":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean","description":"Whether the attribute should be customized for end users"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","description":"For multi-select attributes, this is the list of values available","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean","description":"Boolean representing whether the attribute is required or not"},"footerText":{"type":"string","description":"Text to include after rendering the attribute"},"tooltipText":{"type":"string","description":"Text to use as a tooltip for the attribute"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"For multi-select attributes, these are the available content options"},"active":{"type":"boolean","description":"Whether the attribute is active or not"},"createTime":{"type":"number","description":"The time that the attribute was created (unix epoch)","format":"double"},"updateTime":{"type":"number","description":"The time that the attribute was last updated (unix epoch)","format":"double"},"uiElementUid":{"type":"string","description":"For UI elements, the uuid of the element","format":"uuid"},"uiElementType":{"type":"string","description":"For UI elements, type of the element","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"For UI elements, value of the element"},"uiElementCreateTime":{"type":"number","description":"For UI elements, timestamp of when the element was created (unix epoch)","format":"double"},"uiElementUpdateTime":{"type":"number","description":"For UI elements, timestamp of when the element was last updated (unix epoch)","format":"double"}},"description":"This object represents either an attribute, or a UI Element. The available attributes will depend on which type it is"}},"position":{"type":"integer","description":"Integer representing the position of the tab. Used when ordering multiple tabs","format":"int32"},"isDefault":{"type":"boolean","description":"True if this is a default tab, false otherwise"}}}}}},"404":{"description":"No custom tab could be found with that ID"}}},"delete":{"tags":["Custom Tabs"],"summary":"Delete a Custom Tab","description":"Delete a Custom Tab","operationId":"deleteCustomTabPublicApi","parameters":[{"name":"tabId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"The Custom Tab was successfully deleted"},"404":{"description":"The Custom Tab could not be found"}}},"patch":{"tags":["Custom Tabs"],"summary":"Update a Custom Tab","description":"Update a Custom Tab. This API can be used to either update existing tabs, or create tab 'role extensions' for existing tabs","operationId":"updateCustomTabPublicApi","parameters":[{"name":"tabId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Details of the Custom Tab to be updated","content":{"application/json":{"schema":{"type":"object","properties":{"roleId":{"minimum":1,"type":"integer","format":"int32"},"items":{"type":"array","items":{"type":"object","properties":{"itemType":{"type":"string","description":"Specifies whether this item is an ATTRIBUTE or a UI_ELEMENT","enum":["ATTRIBUTE","UI_ELEMENT"]},"id":{"type":"integer","description":"If the content item is an attribute, then this will be the id of that attribute otherwise this should be omitted","format":"int32"},"name":{"type":"string"},"uiElementUid":{"type":"string","format":"uuid"},"uiElementType":{"type":"string","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string"},"uiElementCreateTime":{"type":"number","format":"double"},"uiElementUpdateTime":{"type":"number","format":"double"}}}},"position":{"type":"integer","format":"int32"}}}}}},"responses":{"200":{"description":"The Custom Tab was successfully updated"},"404":{"description":"The Custom Tab could not be found"}}}},"/v2/tab/{tabId}/end-user":{"get":{"tags":["Custom Tabs"],"summary":"Retrieve the requested tab along with any extensions for end-user tabs","description":"Retrieve the requested tab along with any extensions for end-user tabs","operationId":"getTabHierarchyForEndUser","parameters":[{"name":"tabId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"The Custom Tabs and extensions as viewed by end-user tabs"},"404":{"description":"The Custom Tab could not be found"}}}},"/v2/tab/{tabId}/organization":{"get":{"tags":["Custom Tabs"],"summary":"Retrieve the requested tab along with any extensions for organization and location tabs","description":"Retrieve the requested tab along with any extensions for organization and location tabs","operationId":"getTabHierarchyForOrganization","parameters":[{"name":"tabId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"The Custom Tabs and extensions as viewed by organization and location tabs"},"404":{"description":"The Custom Tab could not be found"}}}},"/v2/tab/{tabId}/role/{roleId}":{"get":{"tags":["Custom Tabs"],"summary":"Retrieve the requested tab along with any extensions based on the supplied roleId","description":"Retrieve the requested tab along with any extensions based on the supplied roleId","operationId":"getTabHierarchyForRole","parameters":[{"name":"tabId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"roleId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"The Custom Tabs and extensions as viewed by the specified role"},"404":{"description":"The Custom Tab or Role could not be found"}}}},"/v2/tab/summary/end-user":{"get":{"tags":["Custom Tabs"],"summary":"Retrieve all of the custom tabs available to end user views","description":"Retrieve a summary of the tabs available to end user views","operationId":"getTabSummaryForEndUser","responses":{"200":{"description":"Returns a list of the available custom tabs available to end user views"}}}},"/v2/tab/summary/global":{"get":{"tags":["Custom Tabs"],"summary":"Retrieve all of the custom tabs available for global scope","description":"Retrieve a summary of the tabs available for division-wide custom attributes","operationId":"getTabSummaryForGlobal","responses":{"200":{"description":"Returns a list of the available custom tabs for global scope"}}}},"/v2/tab/summary/organization":{"get":{"tags":["Custom Tabs"],"summary":"Retrieve all of the custom tabs available to organizations and locations","description":"Retrieve a summary of the tabs available to organizations and locations","operationId":"getTabSummaryForOrganization","responses":{"200":{"description":"Returns a list of the available custom tabs available to organizations and locations"}}}},"/v2/tab/summary/role/{roleId}":{"get":{"tags":["Custom Tabs"],"summary":"Retrieve all of the custom tabs that would appear for the given role","description":"Retrieve a summary of the tabs available to a given role","operationId":"getTabSummaryForRole","parameters":[{"name":"roleId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns a list of the available custom tabs for the specified role, and the role hierarchy (used for sorting, if desired)"},"404":{"description":"The RoleId could not be found"}}}},"/v2/tab/rename":{"patch":{"tags":["Custom Tabs"],"summary":"Rename a Custom Tab","description":"Renames a Custom Tab","operationId":"renameCustomTabPublicApi","requestBody":{"description":"Tab id and new name for the tab","content":{"application/json":{"schema":{"required":["name"],"type":"object","properties":{"tabId":{"minimum":1,"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"maxLength":250,"minLength":0,"type":"string"}}}}}},"responses":{"200":{"description":"The Custom Tab was successfully rename"},"404":{"description":"The Custom Tab could not be found"}}}},"/v2/tab/role/{roleId}/visibility":{"patch":{"tags":["Custom Tabs"],"summary":"Set the tab visibility of the specified tab","description":"Using this API it is possible to configure tabs to be hidden for roles and their children","operationId":"updateCustomTabsDisplay","parameters":[{"name":"roleId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Payload specifying the tab visibility changes","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"tabId":{"type":"integer","format":"int32"},"hidden":{"type":"boolean"}}}}}}},"responses":{"200":{"description":"Returns a list of the affected tabs (as CustomTabLabelPublicApiDTO) with updated visibility data"}}}},"/v2/tab/end-user/order":{"patch":{"tags":["Custom Tabs"],"summary":"Update the order of custom tabs for end-user tabs","description":"Update the order of custom tabs for end-user tabs. NOTE: All tabs defined for end-users must be specified in the payload","operationId":"updateEndUserCustomTabsOrder","requestBody":{"description":"Payload specifying the tab ordering","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"tabId":{"type":"integer","format":"int32"},"position":{"type":"integer","format":"int32"}}}}}}},"responses":{"200":{"description":"Returns a list of the affected tabs (as CustomTabLabelPublicApiDTO) with updated order data"}}}},"/v2/tab/global/order":{"patch":{"tags":["Custom Tabs"],"summary":"Update the order of custom tabs for global scope","description":"Update the order of custom tabs for division-wide custom attributes. NOTE: All tabs defined for global scope must be specified in the payload","operationId":"updateGlobalCustomTabsOrder","requestBody":{"description":"Payload specifying the tab ordering","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"tabId":{"type":"integer","format":"int32"},"position":{"type":"integer","format":"int32"}}}}}}},"responses":{"200":{"description":"Returns a list of the affected tabs (as CustomTabLabelPublicApiDTO) with updated order data"}}}},"/v2/tab/organization/order":{"patch":{"tags":["Custom Tabs"],"summary":"Update the order of custom tabs for organizations and locations","description":"Update the order of custom tabs for organizations and locations. NOTE: All tabs defined for organizations must be specified in the payload","operationId":"updateOrganizationCustomTabsOrder","requestBody":{"description":"Payload specifying the tab ordering","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"tabId":{"type":"integer","format":"int32"},"position":{"type":"integer","format":"int32"}}}}}}},"responses":{"200":{"description":"Returns a list of the affected tabs (as CustomTabLabelPublicApiDTO) with updated order data"}}}},"/v2/tab/role/{roleId}/order":{"patch":{"tags":["Custom Tabs"],"summary":"Update the order of custom tabs for a specific role","description":"Update the order of custom tabs for a specific role. NOTE: Only tabs created on this role can be ordered. All tabs defined on the role must be specified in the payload","operationId":"updateRoleCustomTabsOrder","parameters":[{"name":"roleId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Payload specifying the tab ordering","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"tabId":{"type":"integer","format":"int32"},"position":{"type":"integer","format":"int32"}}}}}}},"responses":{"200":{"description":"Returns a list of the affected tabs (as CustomTabLabelPublicApiDTO) with updated order data"}}}},"/v2/ticketing/ticket":{"post":{"tags":["ticketing"],"summary":"Create ticket","description":"Create a new ticket, does not accept files","operationId":"create_2","requestBody":{"description":"NewTicket object that needs to be added to the store","content":{"application/json":{"schema":{"required":["clientId","status","subject","ticketFormId"],"type":"object","properties":{"clientId":{"type":"integer","description":"Client (Organization) identifier","format":"int32","example":1},"ticketFormId":{"type":"integer","description":"Ticket form identifier","format":"int32","example":1},"locationId":{"type":"integer","description":"Location identifier","format":"int32","nullable":true,"example":1},"nodeId":{"type":"integer","description":"Device identifier","format":"int32","nullable":true,"example":1},"subject":{"maxLength":200,"minLength":0,"type":"string","example":"CPU with problems"},"description":{"required":["public"],"type":"object","properties":{"public":{"type":"boolean","default":true},"body":{"type":"string","nullable":true,"example":"new comment"},"htmlBody":{"type":"string","nullable":true,"example":"<p>new comment</p>"},"timeTracked":{"type":"integer","description":"time in seconds","format":"int32","nullable":true,"example":60},"duplicateInIncidents":{"type":"boolean"}}},"status":{"type":"string","default":"1000"},"type":{"type":"string","description":"Type of ticket","nullable":true,"example":"PROBLEM","enum":["PROBLEM","QUESTION","INCIDENT","TASK","CHANGE_REQUEST","SERVICE_REQUEST","PROJECT","APPOINTMENT","MISCELLANEOUS"]},"cc":{"type":"object","properties":{"uids":{"uniqueItems":true,"type":"array","description":"List of user uids to be carbon-copied","nullable":true,"example":["1fa74a18-a329-40d8-b5b7-0a22624f7800","b0558cb6-3c4e-438c-b8fd-5247c648bbbe"],"items":{"type":"string","description":"List of user uids to be carbon-copied","format":"uuid","nullable":true}},"emails":{"uniqueItems":true,"type":"array","description":"emails","nullable":true,"example":["example1@example.com","example2@example.com"],"items":{"type":"string","description":"emails","nullable":true,"example":"[\"example1@example.com\",\"example2@example.com\"]"}}},"nullable":true},"assignedAppUserId":{"type":"integer","format":"int32","nullable":true},"requesterUid":{"type":"string","format":"uuid"},"severity":{"type":"string","nullable":true,"enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"],"default":"NONE"},"priority":{"type":"string","nullable":true,"enum":["NONE","LOW","MEDIUM","HIGH"],"default":"NONE"},"parentTicketId":{"type":"integer","description":"Ticket parent identifier","format":"int32","nullable":true,"example":1},"tags":{"type":"array","nullable":true,"example":["tag1","tag2"],"items":{"type":"string","nullable":true,"example":"[\"tag1\",\"tag2\"]"}},"attributes":{"type":"array","nullable":true,"items":{"required":["attributeId","value"],"type":"object","properties":{"id":{"type":"integer","format":"int32","nullable":true,"example":1},"attributeId":{"type":"integer","description":"Attribute identifier","format":"int32","example":1},"value":{"type":"string","description":"Attribute value"}},"nullable":true}},"additionalAssignedTechnicianIds":{"uniqueItems":true,"type":"array","description":"Additional assigned technician identifiers","nullable":true,"example":[300,789],"items":{"type":"integer","description":"Additional assigned technician identifiers","format":"int32","nullable":true}},"followupTime":{"type":"number","description":"Follow-up time for the ticket in epoch seconds","format":"double","nullable":true}}}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"version":{"type":"integer","format":"int32"},"nodeId":{"type":"integer","format":"int32"},"clientId":{"type":"integer","format":"int32"},"locationId":{"type":"integer","format":"int32"},"assignedAppUserId":{"type":"integer","format":"int32"},"requesterUid":{"type":"string","format":"uuid"},"subject":{"type":"string"},"status":{"type":"object","properties":{"name":{"type":"string"},"displayName":{"type":"string"},"parentId":{"type":"integer","format":"int32"},"statusId":{"type":"integer","format":"int32"}}},"type":{"type":"string","enum":["PROBLEM","QUESTION","INCIDENT","TASK","CHANGE_REQUEST","SERVICE_REQUEST","PROJECT","APPOINTMENT","MISCELLANEOUS"]},"priority":{"type":"string","enum":["NONE","LOW","MEDIUM","HIGH"]},"severity":{"type":"string","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"]},"ticketFormId":{"type":"integer","format":"int32"},"source":{"type":"string","enum":["TECHNICIAN","EMAIL","WEB_FORM","HELP_REQUEST","END_USER","CONDITION","SCHEDULED_SCRIPT","ACTIVITY"]},"tags":{"type":"array","items":{"type":"string"}},"ccList":{"type":"object","properties":{"uids":{"uniqueItems":true,"type":"array","items":{"type":"string","format":"uuid"}},"emails":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"createTime":{"type":"number","format":"double"},"deleted":{"type":"boolean"},"attributeValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"attributeId":{"type":"integer","format":"int32"},"value":{"type":"object"}}}},"additionalAssignedTechnicianIds":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"followupTime":{"type":"number","format":"double"}}}}}}}}},"/v2/ticketing/ticket/{ticketId}/comment":{"post":{"tags":["ticketing"],"summary":"Add comment to ticket","description":"Add a new comment to a ticket, allows files","operationId":"createComment","parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"comment":{"required":["public"],"type":"object","properties":{"public":{"type":"boolean","default":true},"body":{"type":"string","nullable":true,"example":"new comment"},"htmlBody":{"type":"string","nullable":true,"example":"<p>new comment</p>"},"timeTracked":{"type":"integer","description":"time in seconds","format":"int32","nullable":true,"example":60},"duplicateInIncidents":{"type":"boolean"}}},"files":{"type":"array","items":{"type":"string","format":"binary","nullable":true}}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/v2/ticketing/ticket/{ticketId}":{"get":{"tags":["ticketing"],"summary":"Ticket","description":"Returns a ticket","operationId":"getTicketById","parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"version":{"type":"integer","format":"int32"},"nodeId":{"type":"integer","format":"int32"},"clientId":{"type":"integer","format":"int32"},"locationId":{"type":"integer","format":"int32"},"assignedAppUserId":{"type":"integer","format":"int32"},"requesterUid":{"type":"string","format":"uuid"},"subject":{"type":"string"},"status":{"type":"object","properties":{"name":{"type":"string"},"displayName":{"type":"string"},"parentId":{"type":"integer","format":"int32"},"statusId":{"type":"integer","format":"int32"}}},"type":{"type":"string","enum":["PROBLEM","QUESTION","INCIDENT","TASK","CHANGE_REQUEST","SERVICE_REQUEST","PROJECT","APPOINTMENT","MISCELLANEOUS"]},"priority":{"type":"string","enum":["NONE","LOW","MEDIUM","HIGH"]},"severity":{"type":"string","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"]},"ticketFormId":{"type":"integer","format":"int32"},"source":{"type":"string","enum":["TECHNICIAN","EMAIL","WEB_FORM","HELP_REQUEST","END_USER","CONDITION","SCHEDULED_SCRIPT","ACTIVITY"]},"tags":{"type":"array","items":{"type":"string"}},"ccList":{"type":"object","properties":{"uids":{"uniqueItems":true,"type":"array","items":{"type":"string","format":"uuid"}},"emails":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"createTime":{"type":"number","format":"double"},"deleted":{"type":"boolean"},"attributeValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"attributeId":{"type":"integer","format":"int32"},"value":{"type":"object"}}}},"additionalAssignedTechnicianIds":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"followupTime":{"type":"number","format":"double"}}}}}}}},"put":{"tags":["ticketing"],"summary":"Update ticket","description":"Change ticket fields. Does not accept comments","operationId":"update_2","parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"UpdateTicket object that needs to be updated to the store","content":{"application/json":{"schema":{"required":["clientId","requesterUid","status","subject","ticketFormId","version"],"type":"object","properties":{"version":{"type":"integer","description":"ticket version","format":"int32","example":1},"clientId":{"type":"integer","description":"Client (Organization) identifier","format":"int32","example":1},"ticketFormId":{"type":"integer","description":"Ticket form identifier","format":"int32","example":1},"locationId":{"type":"integer","description":"Location identifier","format":"int32","nullable":true,"example":1},"nodeId":{"type":"integer","description":"Device identifier","format":"int32","nullable":true,"example":1},"subject":{"maxLength":200,"minLength":0,"type":"string","example":"CPU with problems"},"status":{"type":"string","default":"1000"},"type":{"type":"string","description":"Type of ticket","nullable":true,"example":"PROBLEM","enum":["PROBLEM","QUESTION","INCIDENT","TASK","CHANGE_REQUEST","SERVICE_REQUEST","PROJECT","APPOINTMENT","MISCELLANEOUS"]},"cc":{"type":"object","properties":{"uids":{"uniqueItems":true,"type":"array","description":"List of user uids to be carbon-copied","nullable":true,"example":["1fa74a18-a329-40d8-b5b7-0a22624f7800","b0558cb6-3c4e-438c-b8fd-5247c648bbbe"],"items":{"type":"string","description":"List of user uids to be carbon-copied","format":"uuid","nullable":true}},"emails":{"uniqueItems":true,"type":"array","description":"emails","nullable":true,"example":["example1@example.com","example2@example.com"],"items":{"type":"string","description":"emails","nullable":true,"example":"[\"example1@example.com\",\"example2@example.com\"]"}}},"nullable":true},"assignedAppUserId":{"type":"integer","format":"int32","nullable":true},"requesterUid":{"type":"string","format":"uuid"},"severity":{"type":"string","nullable":true,"enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"],"default":"NONE"},"priority":{"type":"string","nullable":true,"enum":["NONE","LOW","MEDIUM","HIGH"],"default":"NONE"},"parentTicketId":{"type":"integer","description":"Ticket parent identifier","format":"int32","nullable":true,"example":1},"tags":{"type":"array","nullable":true,"example":["tag1","tag2"],"items":{"type":"string","nullable":true,"example":"[\"tag1\",\"tag2\"]"}},"attributes":{"type":"array","nullable":true,"items":{"required":["attributeId","value"],"type":"object","properties":{"id":{"type":"integer","format":"int32","nullable":true,"example":1},"attributeId":{"type":"integer","description":"Attribute identifier","format":"int32","example":1},"value":{"type":"string","description":"Attribute value"}},"nullable":true}},"additionalAssignedTechnicianIds":{"uniqueItems":true,"type":"array","description":"Additional assigned technician identifiers","nullable":true,"example":[300,789],"items":{"type":"integer","description":"Additional assigned technician identifiers","format":"int32","nullable":true}},"followupTime":{"type":"number","description":"Follow-up time for the ticket in epoch seconds","format":"double","nullable":true}}}}},"required":true},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"version":{"type":"integer","format":"int32"},"nodeId":{"type":"integer","format":"int32"},"clientId":{"type":"integer","format":"int32"},"locationId":{"type":"integer","format":"int32"},"assignedAppUserId":{"type":"integer","format":"int32"},"requesterUid":{"type":"string","format":"uuid"},"subject":{"type":"string"},"status":{"type":"object","properties":{"name":{"type":"string"},"displayName":{"type":"string"},"parentId":{"type":"integer","format":"int32"},"statusId":{"type":"integer","format":"int32"}}},"type":{"type":"string","enum":["PROBLEM","QUESTION","INCIDENT","TASK","CHANGE_REQUEST","SERVICE_REQUEST","PROJECT","APPOINTMENT","MISCELLANEOUS"]},"priority":{"type":"string","enum":["NONE","LOW","MEDIUM","HIGH"]},"severity":{"type":"string","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"]},"ticketFormId":{"type":"integer","format":"int32"},"source":{"type":"string","enum":["TECHNICIAN","EMAIL","WEB_FORM","HELP_REQUEST","END_USER","CONDITION","SCHEDULED_SCRIPT","ACTIVITY"]},"tags":{"type":"array","items":{"type":"string"}},"ccList":{"type":"object","properties":{"uids":{"uniqueItems":true,"type":"array","items":{"type":"string","format":"uuid"}},"emails":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"createTime":{"type":"number","format":"double"},"deleted":{"type":"boolean"},"attributeValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"attributeId":{"type":"integer","format":"int32"},"value":{"type":"object"}}}},"additionalAssignedTechnicianIds":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"followupTime":{"type":"number","format":"double"}}}}}}}}},"/v2/ticketing/ticket/{ticketId}/log-entry":{"get":{"tags":["ticketing"],"summary":"List ticket log entries","description":"Returns list of the ticket log entries for a ticket","operationId":"getTicketLogEntriesByTicketId","parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"type","in":"query","schema":{"type":"array","items":{"type":"string","enum":["DESCRIPTION","COMMENT","CONDITION","SAVE","DELETE","PRODUCT","INFO"]}}},{"name":"createTime","in":"query","schema":{"type":"string"}},{"name":"anchorId","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","schema":{"type":"integer","format":"int32","default":500}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"appUserContactUid":{"type":"string","format":"uuid"},"appUserContactId":{"type":"integer","format":"int32"},"appUserContactType":{"type":"string","enum":["TECHNICIAN","END_USER","CONTACT"]},"type":{"type":"string","enum":["DESCRIPTION","COMMENT","CONDITION","SAVE","DELETE","PRODUCT","INFO"]},"body":{"type":"string"},"htmlBody":{"type":"string"},"fullEmailBody":{"type":"string"},"publicEntry":{"type":"boolean"},"system":{"type":"boolean"},"createTime":{"type":"number","format":"double"},"changeDiff":{"type":"object"},"activityId":{"type":"integer","format":"int64"},"timeTracked":{"type":"integer","format":"int32"},"technicianTagged":{"type":"array","items":{"type":"integer","format":"int32"}},"techniciansTaggedMetadata":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"email":{"type":"string"},"displayName":{"type":"string"},"deleted":{"type":"boolean"},"permitted":{"type":"boolean"}}}},"automation":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"system":{"type":"boolean"},"type":{"type":"string"}}},"ticketTimeEntry":{"type":"object","properties":{"ticketLogEntryId":{"type":"integer","format":"int64"},"startDate":{"type":"integer","format":"int64"},"remote":{"type":"boolean"},"timeTracked":{"type":"integer","format":"int32"},"inHours":{"type":"object","properties":{"price":{"type":"number"},"timeTracked":{"type":"integer","format":"int32"},"billing":{"type":"string","enum":["BILLABLE","NOT_BILLABLE","NO_CHARGE"]},"billingStatus":{"type":"string","enum":["BILLED","PENDING","NOT_BILLABLE","UNASSIGNED"]},"agreementOriginType":{"type":"string","enum":["NONE","SELF","TICKET"]},"agreementProduct":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"agreement":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"invoiceId":{"type":"integer","format":"int32"}}},"offHours":{"type":"object","properties":{"price":{"type":"number"},"timeTracked":{"type":"integer","format":"int32"},"billing":{"type":"string","enum":["BILLABLE","NOT_BILLABLE","NO_CHARGE"]},"billingStatus":{"type":"string","enum":["BILLED","PENDING","NOT_BILLABLE","UNASSIGNED"]},"agreementOriginType":{"type":"string","enum":["NONE","SELF","TICKET"]},"agreementProduct":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"agreement":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"invoiceId":{"type":"integer","format":"int32"}}},"billingNote":{"type":"string"}}},"emailResponse":{"type":"boolean"}}}}}}}}}},"/v2/vulnerability/scan-groups":{"get":{"tags":["Vulnerability Management"],"summary":"Fetch all Scan Groups","description":"Fetches all Scan Groups.","operationId":"fetchAllScanGroups","responses":{"200":{"description":"Scan Groups were found successfully.","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"groupName":{"type":"string"},"fileName":{"type":"string"},"status":{"type":"string","enum":["COMPLETE","IN_PROGRESS","FAILED"]},"vendor":{"type":"string"},"thirdPartyApiTile":{"type":"string"},"deviceIdHeader":{"type":"string"},"deviceInternalMapping":{"type":"string"},"cveIdHeader":{"type":"string"},"lastFileUploadDate":{"type":"string"},"recordsProcessed":{"type":"integer","format":"int32"}}}}}}}}}},"/v2/vulnerability/scan-groups/{scan-group-id}":{"get":{"tags":["Vulnerability Management"],"summary":"Fetch Scan Group","description":"Fetches a single Scan Group by ID.","operationId":"fetchScanGroupById","parameters":[{"name":"scan-group-id","in":"path","description":"Unique ID of the scan group to upload CSV to","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Scan Group was found successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"groupName":{"type":"string"},"fileName":{"type":"string"},"status":{"type":"string","enum":["COMPLETE","IN_PROGRESS","FAILED"]},"vendor":{"type":"string"},"thirdPartyApiTile":{"type":"string"},"deviceIdHeader":{"type":"string"},"deviceInternalMapping":{"type":"string"},"cveIdHeader":{"type":"string"},"lastFileUploadDate":{"type":"string"},"recordsProcessed":{"type":"integer","format":"int32"}}}}}},"404":{"description":"The Scan group was not found by the given scan-group-id."}}}},"/v2/vulnerability/scan-groups/{scan-group-id}/upload":{"post":{"tags":["Vulnerability Management"],"summary":"Upload CSV","description":"Upload CSV to an existing scan group. The uploaded CSV must contain the columns defined in the \nscan group which map to the Ninja machine identifier (hostname, IP address, or MAC address) and the CVE ID.","operationId":"updateScanGroup","parameters":[{"name":"scan-group-id","in":"path","description":"Unique ID of the scan group to upload CSV to","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"description":"Multi-part form data which contains the CSV file to upload. Field uses key \"csv\" in request body.","content":{"multipart/form-data":{"schema":{"required":["csv"],"type":"object","properties":{"csv":{"type":"string","description":"The CSV file containing vulnerability data. The maximum file size is 200MB.","format":"binary"}}},"encoding":{"csv":{"contentType":"text/csv"}}}}},"responses":{"200":{"description":"Upload was accepted and is being processed","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"groupName":{"type":"string"},"fileName":{"type":"string"},"status":{"type":"string","enum":["COMPLETE","IN_PROGRESS","FAILED"]},"vendor":{"type":"string"},"thirdPartyApiTile":{"type":"string"},"deviceIdHeader":{"type":"string"},"deviceInternalMapping":{"type":"string"},"cveIdHeader":{"type":"string"},"lastFileUploadDate":{"type":"string"},"recordsProcessed":{"type":"integer","format":"int32"}}}}}},"404":{"description":"Scan group was not found by the given scan-group-id"}}}},"/v2/device/{id}/maintenance":{"put":{"tags":["management"],"summary":"Schedule maintenance","description":"Schedule maintenance window for device","operationId":"updateDeviceMaintenance","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"disabledFeatures":{"type":"array","description":"List of features that will be disabled during maintenance","items":{"type":"string","description":"List of features that will be disabled during maintenance","enum":["ALERTS","PATCHING","AVSCANS","TASKS"]}},"start":{"type":"number","description":"Maintenance window start (optional, defaults to now). Allowed formats: ISO-8601 date-time string or epoch milliseconds.","format":"double"},"end":{"type":"number","description":"Maintenance window end. Allowed formats: ISO-8601 date-time string or epoch milliseconds.","format":"double"},"reasonMessage":{"type":"string","description":"Reason for maintenance window"}}}}}},"responses":{"default":{"description":"default response","content":{"*/*":{}}}}},"delete":{"tags":["management"],"summary":"Cancel maintenance","description":"Cancel pending or active maintenance for device","operationId":"cancelDeviceMaintenance","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/v2/device/{id}/windows-service/{serviceId}/control":{"post":{"tags":["management"],"summary":"Windows service control","description":"Start/Stop/Restart Windows Service on a device","operationId":"controlWindowsService","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"serviceId","in":"path","description":"Service identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"action":{"type":"string","description":"Action","enum":["START","PAUSE","STOP","RESTART"]}}}}}},"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/v2/device/{id}/decommission":{"post":{"tags":["management"],"summary":"Decommission device","description":"Decommission device","operationId":"decommissionDevice","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"The device was successfully decommissioned"},"400":{"description":"Request validation failed"},"403":{"description":"Insufficient permissions to perform operation"},"404":{"description":"A device with the provided nodeId was not found"}},"security":[{"oauth2":["management"]}]}},"/v2/device/{id}":{"get":{"tags":["devices"],"summary":"Device details","description":"Returns device details","operationId":"getDevice","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Device information","content":{"application/json":{"schema":{"description":"Polymorphic response. (Device-specific schema)","oneOf":[{"title":"Agent device","required":["deviceType"],"type":"object","description":"Device with an installed agent","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"os":{"type":"object","properties":{"manufacturer":{"type":"string","description":"Manufacturer"},"name":{"type":"string","description":"Name"},"architecture":{"type":"string","description":"Architecture"},"lastBootTime":{"type":"number","description":"Last boot time","format":"double"},"buildNumber":{"type":"string","description":"Build number"},"releaseId":{"type":"string","description":"Release ID"},"servicePackMajorVersion":{"type":"integer","description":"Service Pack Major Version","format":"int32"},"servicePackMinorVersion":{"type":"integer","description":"Service Pack Minor Version","format":"int32"},"locale":{"type":"string","description":"Locale"},"language":{"type":"string","description":"Language"},"needsReboot":{"type":"boolean","description":"Operating system has pending reboot requests"}},"description":"Operating System"},"system":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"manufacturer":{"type":"string","description":"Manufacturer"},"model":{"type":"string","description":"Model"},"biosSerialNumber":{"type":"string","description":"Bios Serial Number"},"serialNumber":{"type":"string","description":"Serial Number"},"assetSerialNumber":{"type":"string","description":"Asset Serial Number"},"domain":{"type":"string"},"domainRole":{"type":"string"},"numberOfProcessors":{"type":"integer","format":"int32"},"totalPhysicalMemory":{"type":"integer","format":"int64"},"virtualMachine":{"type":"boolean"},"chassisType":{"type":"string"}},"description":"Computer System (Chassis)"},"memory":{"type":"object","properties":{"capacity":{"type":"integer","description":"Capacity","format":"int64"}},"description":"Memory information"},"processors":{"type":"array","description":"Processors","items":{"type":"object","properties":{"architecture":{"type":"string","description":"Architecture"},"maxClockSpeed":{"type":"integer","description":"Max Clock Speed","format":"int64"},"clockSpeed":{"type":"integer","description":"Current Clock Speed","format":"int64"},"name":{"type":"string","description":"Name"},"numCores":{"type":"integer","description":"Number of Cores","format":"int32"},"numLogicalCores":{"type":"integer","description":"Number of Logical Cores]","format":"int32"}},"description":"Processors"}},"volumes":{"type":"array","description":"Disk Volumes","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"driveLetter":{"type":"string","description":"Drive Letter"},"label":{"type":"string","description":"Volume Label"},"deviceType":{"type":"string","description":"Device Type"},"fileSystem":{"type":"string","description":"File System Type"},"autoMount":{"type":"boolean","description":"Automatically Mounted"},"compressed":{"type":"boolean","description":"Compressed"},"capacity":{"type":"integer","description":"Capacity (bytes)","format":"int64"},"freeSpace":{"type":"integer","description":"Free Space (bytes)","format":"int64"},"serialNumber":{"type":"string","description":"Serial Number"},"bitLockerStatus":{"type":"object","properties":{"conversionStatus":{"type":"string","description":"Volume encryption or decryption status.","enum":["FULLY_DECRYPTED","FULLY_ENCRYPTED","ENCRYPTION_IN_PROGRESS","DECRYPTION_IN_PROGRESS","ENCRYPTION_PAUSED","DECRYPTION_PAUSED","UNKNOWN"]},"encryptionMethod":{"type":"string","description":"Indicated the encryption algorithm and key size used on the volume","enum":["NONE","AES_128_WITH_DIFFUSER","AES_256_WITH_DIFFUSER","AES_128","AES_256","HARDWARE_ENCRYPTION","XTS_AES_128","XTS_AES_256","UNKNOWN"]},"protectionStatus":{"type":"string","description":" indicates whether the volume and its encryption key (if any) are secured.","enum":["UNPROTECTED","PROTECTED","UNKNOWN","PENDING"]},"lockStatus":{"type":"string","description":"Indicates whether the contents of the volume are accessible from Windows","enum":["UNKNOWN","UNLOCKED","LOCKED"]},"initializedForProtection":{"type":"boolean","description":"Is initialized for protection"}},"description":"BitLocker Status"}},"description":"Disk Volumes"}},"lastLoggedInUser":{"type":"string","description":"Username that logged in most recently"},"deviceType":{"type":"string","description":"Device type","enum":["AgentDevice"]}}}]},{"title":"Cloud monitor: Ping","required":["deviceType"],"type":"object","description":"Cloud monitor that checks a target with ping","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is enabled?"},"interval":{"type":"integer","description":"Monitoring interval (seconds)","format":"int32"},"timeout":{"type":"integer","description":"Timeout (seconds)","format":"int32"},"target":{"type":"string","description":"Monitoring target (hostname, IP address or URL)"},"deviceType":{"type":"string","description":"Device type","enum":["CloudMonitorPing"]}}}]},{"title":"Cloud monitor: DNS","required":["deviceType"],"type":"object","description":"Cloud monitor that checks DNS resolution","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is enabled?"},"interval":{"type":"integer","description":"Monitoring interval (seconds)","format":"int32"},"timeout":{"type":"integer","description":"Timeout (seconds)","format":"int32"},"target":{"type":"string","description":"Monitoring target (hostname, IP address or URL)"},"deviceType":{"type":"string","description":"Device type","enum":["CloudMonitorDNS"]}}}]},{"title":"Cloud monitor: HTTP","required":["deviceType"],"type":"object","description":"Cloud monitor that checks an HTTP/HTTPS endpoint","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is enabled?"},"interval":{"type":"integer","description":"Monitoring interval (seconds)","format":"int32"},"timeout":{"type":"integer","description":"Timeout (seconds)","format":"int32"},"target":{"type":"string","description":"Monitoring target (hostname, IP address or URL)"},"deviceType":{"type":"string","description":"Device type","enum":["CloudMonitorHTTP"]}}}]},{"title":"Cloud monitor: Port scan","required":["deviceType"],"type":"object","description":"Cloud monitor that checks open ports on a target","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is enabled?"},"interval":{"type":"integer","description":"Monitoring interval (seconds)","format":"int32"},"timeout":{"type":"integer","description":"Timeout (seconds)","format":"int32"},"target":{"type":"string","description":"Monitoring target (hostname, IP address or URL)"},"deviceType":{"type":"string","description":"Device type","enum":["CloudMonitorPortScan"]}}}]},{"title":"Cloud monitor: Email server","required":["deviceType"],"type":"object","description":"Cloud monitor that checks an email server","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is enabled?"},"interval":{"type":"integer","description":"Monitoring interval (seconds)","format":"int32"},"timeout":{"type":"integer","description":"Timeout (seconds)","format":"int32"},"target":{"type":"string","description":"SMTP Host (hostname or IP address)"},"smtpPort":{"type":"integer","description":"SMTP Port","format":"int32"},"senderEmail":{"type":"string","description":"Sender's email (FROM)"},"recipientEmail":{"type":"string","description":"Recipient's email (TO)"},"deviceType":{"type":"string","description":"Device type","enum":["CloudMonitorEmailServer"]}}}]},{"title":"NMS server","required":["deviceType"],"type":"object","description":"Network management system server","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"deviceType":{"type":"string","description":"Device type","enum":["NMSServer"]}}}]},{"title":"NMS target","required":["deviceType"],"type":"object","description":"Network device monitored by an NMS server","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"deviceType":{"type":"string","description":"Device type","enum":["NMSTarget"]}}}]},{"title":"VM host","required":["deviceType"],"type":"object","description":"Virtualization host (VMware or Hyper-V)","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"cpuMhz":{"type":"integer","description":"CPU Frequency","format":"int64"},"cpuModel":{"type":"string","description":"CPU Model"},"htActive":{"type":"boolean","description":"Is Hyper-Threading active?"},"htAvailable":{"type":"boolean","description":"Is Hyper-Threading available?"},"lastBootTime":{"type":"number","description":"Last toot time","format":"double"},"memorySize":{"type":"integer","description":"Total memory size (bytes)","format":"int64"},"model":{"type":"string","description":"Model"},"name":{"type":"string","description":"Name"},"cpuCores":{"type":"integer","description":"Number of CPU Cores","format":"int32"},"cpuPackages":{"type":"integer","description":"Number of CPUs","format":"int32"},"cpuThreads":{"type":"integer","description":"Total number of logical CPU cores","format":"int32"},"serviceTag":{"type":"string","description":"Service Tag"},"vendor":{"type":"string","description":"Vendor"},"releaseName":{"type":"string","description":"Release Name"},"version":{"type":"string","description":"Version"},"buildNumber":{"type":"string","description":"Build number"},"deviceType":{"type":"string","description":"Device type","enum":["VMHost"]}}}]},{"title":"VM guest","required":["deviceType"],"type":"object","description":"Virtual machine guest (VMware or Hyper-V)","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"files":{"type":"string","description":"Guest VM Files"},"fullName":{"type":"string","description":"Full Name"},"lastBootTime":{"type":"number","description":"Last VM Boot Time","format":"double"},"memorySize":{"type":"integer","description":"VM Memory size (bytes)","format":"int64"},"coresPerSocket":{"type":"integer","description":"Number of Cores per Socket","format":"int32"},"cpuCores":{"type":"integer","description":"Total Number of CPU Cores","format":"int32"},"powerState":{"type":"string","description":"Current power state"},"toolsInstallType":{"type":"string","description":"Guest tools installation type"},"toolStatus":{"type":"string","description":"Guest tools status"},"toolsVersion":{"type":"string","description":"Guest tools version"},"guestOSFullName":{"type":"string","description":"Guest OS full name"},"guestOSFamily":{"type":"string","description":"Guest OS family"},"guestOSId":{"type":"string","description":"Guest OS identifier"},"toolsVersionStatus":{"type":"string","description":"Guest tools version status"},"snapshotCount":{"type":"integer","description":"Number of snapshots","format":"int32"},"snapshotTotalSize":{"type":"integer","description":"Total snapshot size (bytes)","format":"int64"},"deviceType":{"type":"string","description":"Device type","enum":["VMGuest"]}}}]},{"title":"MDM device","required":["deviceType"],"type":"object","description":"Mobile device managed through MDM","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"system":{"type":"object","properties":{"displayName":{"type":"string","description":"Display Name"},"name":{"type":"string","description":"Name"},"manufacturer":{"type":"string","description":"Manufacturer"},"model":{"type":"string","description":"Model"},"serialNumber":{"type":"string","description":"Serial Number"},"build":{"type":"string","description":"Build"}},"description":"Mdm System"},"memory":{"type":"object","properties":{"capacity":{"type":"integer","description":"Capacity","format":"int64"}},"description":"Memory information"},"network":{"type":"array","description":"Network information","items":{"type":"object","properties":{"imei":{"type":"string","description":"International Mobile Equipment Identity"},"eid":{"type":"string","description":"eUICC Identifier"},"meid":{"type":"string","description":"Mobile Equipment Identifier"},"phoneNumber":{"type":"string","description":"Device phone number"},"carrier":{"type":"string","description":"Network carrier name"},"iccId":{"type":"string","description":"Integrated Circuit Card Identifier"}},"description":"Network information"}},"volumes":{"type":"array","description":"Disk Volumes","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"driveLetter":{"type":"string","description":"Drive Letter"},"label":{"type":"string","description":"Volume Label"},"deviceType":{"type":"string","description":"Device Type"},"fileSystem":{"type":"string","description":"File System Type"},"autoMount":{"type":"boolean","description":"Automatically Mounted"},"compressed":{"type":"boolean","description":"Compressed"},"capacity":{"type":"integer","description":"Capacity (bytes)","format":"int64"},"freeSpace":{"type":"integer","description":"Free Space (bytes)","format":"int64"},"serialNumber":{"type":"string","description":"Serial Number"},"bitLockerStatus":{"type":"object","properties":{"conversionStatus":{"type":"string","description":"Volume encryption or decryption status.","enum":["FULLY_DECRYPTED","FULLY_ENCRYPTED","ENCRYPTION_IN_PROGRESS","DECRYPTION_IN_PROGRESS","ENCRYPTION_PAUSED","DECRYPTION_PAUSED","UNKNOWN"]},"encryptionMethod":{"type":"string","description":"Indicated the encryption algorithm and key size used on the volume","enum":["NONE","AES_128_WITH_DIFFUSER","AES_256_WITH_DIFFUSER","AES_128","AES_256","HARDWARE_ENCRYPTION","XTS_AES_128","XTS_AES_256","UNKNOWN"]},"protectionStatus":{"type":"string","description":" indicates whether the volume and its encryption key (if any) are secured.","enum":["UNPROTECTED","PROTECTED","UNKNOWN","PENDING"]},"lockStatus":{"type":"string","description":"Indicates whether the contents of the volume are accessible from Windows","enum":["UNKNOWN","UNLOCKED","LOCKED"]},"initializedForProtection":{"type":"boolean","description":"Is initialized for protection"}},"description":"BitLocker Status"}},"description":"Disk Volumes"}},"lastLoggedInUser":{"type":"string","description":"Last logged in user"},"deviceType":{"type":"string","description":"Device type","enum":["MdmDevice"]}}}]},{"title":"Unmanaged device","required":["deviceType"],"type":"object","description":"Device tracked without an agent or monitor","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"deviceType":{"type":"string","description":"Device type","enum":["UnmanagedDevice"]}}}]}]}}}}}},"patch":{"tags":["management"],"summary":"Update device information","description":"Change device friendly name, user data, etc.","operationId":"updateDevice","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"displayName":{"type":"string","description":"Display name (User assigned)"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization policy mapping, or reverts to organization policy if Null)","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"}}}}}},"responses":{"default":{"description":"default response","content":{"*/*":{}}}},"security":[{"oauth2":["management"]}]}},"/v2/device/{id}/jobs":{"get":{"tags":["devices"],"summary":"Device currently running (active) jobs","description":"Returns currently running jobs for device","operationId":"getDeviceActiveJobs","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"lang","in":"query","schema":{"type":"string","description":"Language tag"}},{"name":"tz","in":"query","description":"Time Zone","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"uid":{"type":"string","description":"Task/Job UID (activity series UID)","format":"uuid"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"message":{"type":"string","description":"Job message"},"createTime":{"type":"number","description":"Job start timestamp","format":"double"},"updateTime":{"type":"number","description":"Job last updated","format":"double"},"sourceType":{"type":"string","description":"Job origin","enum":["AGENT_OFFLINE","CONDITION_AGENT_CPU","CONDITION_AGENT_MEMORY","CONDITION_AGENT_NETWORK","CONDITION_AGENT_DISK_IO","CONDITION_AGENT_DISK_FREE_SPACE","CONDITION_AGENT_DISK_USAGE","CONDITION_AGENT_CVSS_SCORE","CONDITION_AGENT_PATCH_LAST_INSTALLED","CONDITION_NMS_CPU","CONDITION_NMS_MEMORY","CONDITION_NMS_NETWORK_TRAFFIC_BITS","CONDITION_NMS_NETWORK_ADAPTER_STATUS","CONDITION_NMS_NETWORK_TRAFFIC_PERCENT","CONDITION_NMS_NETWORK_STATUS","CONDITION_NMS_NETWORK_STATUS_CHANGE","CONDITION_NMS_SYSTEM_UPTIME","CONDITION_PING","CONDITION_PING_LATENCY","CONDITION_PING_PACKET_LOSS","CONDITION_PING_RESPONSE","CONDITION_SYSTEM_UPTIME","CONDITION_SMART_STATUS_DEGRATED","CONDITION_RAID_HEALTH_STATUS","CONDITION_SCRIPT_RESULT","CONDITION_HTTP","CONDITION_HTTP_RESPONSE","CONDITION_PORT","CONDITION_PORT_SCAN","CONDITION_SYSLOG","CONDITION_CONFIGURATION_FILE","CONDITION_SNMPTRAP","CONDITION_CRITICAL_EVENT","CONDITION_BATTERY_MONITORING","CONDITION_DNS","CONDITION_EMAIL","CONDITION_CUSTOM_SNMP","CONDITION_COMPOUND","SHADOWPROTECT_BACKUPJOB_CREATE","SHADOWPROTECT_BACKUPJOB_UPDATE","SHADOWPROTECT_BACKUPJOB_DELETE","SHADOWPROTECT_BACKUPJOB_EXECUTE","IMAGEMANAGER_MANAGEDFOLDER_CREATE","IMAGEMANAGER_MANAGEDFOLDER_UPDATE","IMAGEMANAGER_MANAGEDFOLDER_DELETE","IMAGEMANAGER_MANAGEDFOLDER_EXECUTE","TEAMVIEWER_CONNECTION","RETRIEVE_AGENT_LOGS","SCHEDULED_TASK","CONDITION_WINDOWS_EVENT_LOG_TRIGGERED","CONDITION_WINDOWS_SERVICE_STATE_CHANGED","UI_MESSAGE_ACTION_REBOOT","UI_MESSAGE_BD_INSTALLATION_ISSUES","GRAVITYZONE_UI_MESSAGE_INSTALLATION_ISSUES","AV_QUARANTINE_THREAT","AV_RESTORE_THREAT","AV_DELETE_THREAT","AV_REMOVE_THREAT","BITDEFENDER_RESTORE_THREAT","BITDEFENDER_DELETE_THREAT","CONDITION_BITLOCKER_STATUS","CONDITION_FILEVAULT_STATUS","CONDITION_LINUX_PROCESS","CONDITION_LINUX_Daemon","CONDITION_LINUX_PROCESS_RESOURCE","CONDITION_LINUX_PROCESS_RESOURCE_CPU","CONDITION_LINUX_PROCESS_RESOURCE_MEMORY","CONDITION_LINUX_DISK_FREE_SPACE","CONDITION_LINUX_DISK_USAGE","CONDITION_VM_AGGREGATE_CPU_USAGE","CONDITION_VM_DISK_USAGE","CONDITION_VM_HOST_DATASTORE","CONDITION_VM_HOST_UPTIME","CONDITION_VM_HOST_DEVICE_DOWN","CONDITION_VM_HOST_BAD_SENSORS","CONDITION_VM_HOST_SENSOR_HEALTH","CONDITION_VM_GUEST_GUEST_OPERATIONAL_MODE","CONDITION_VM_GUEST_SNAPSHOT_SIZE","CONDITION_VM_GUEST_SNAPSHOT_LIFESPAN","CONDITION_VM_GUEST_TOOLS_NOT_RUNNING","CONDITION_HV_GUEST_CHECKPOINT_SIZE","CONDITION_HV_GUEST_CHECKPOINT_LIFESPAN","CONDITION_SOFTWARE","CONDITION_WINDOWS_PROCESS_STATE","CONDITION_WINDOWS_PROCESS_RESOURCE_CPU","CONDITION_WINDOWS_PROCESS_RESOURCE_MEMORY","CONDITION_MAC_PROCESS_STATE","CONDITION_MAC_PROCESS_RESOURCE_CPU","CONDITION_MAC_PROCESS_RESOURCE_MEMORY","CONDITION_MAC_DEAMON","CONDITION_CUSTOM_FIELD","CONDITION_PENDING_REBOOT","CONDITION_LOCKHART_LAST_SUCCESSFUL_BACKUP"]},"sourceConfigUid":{"type":"string","description":"Source configuration/policy element reference","format":"uuid"},"sourceName":{"type":"string","description":"Source configuration/policy element name"},"subject":{"type":"string","description":"Job subject"},"userId":{"type":"integer","description":"User identifier","format":"int32"},"psaTicketId":{"type":"object","description":"Related PSA ticket ID"},"ticketTemplateId":{"type":"integer","description":"PSA ticket template","format":"int32"},"data":{"type":"object","additionalProperties":true,"description":"Job data"},"device":{"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"}},"description":"Device information."},"jobStatus":{"type":"string","description":"Job Status","enum":["START_REQUESTED","STARTED","IN_PROCESS","COMPLETED","CANCEL_REQUESTED","CANCELLED","WAITING_FOR_USER_RESPONSE","SUPERSEDED","TRIGGERED","RESET","ACKNOWLEDGED","DISABLED"]},"jobResult":{"type":"string","description":"Job result","enum":["SUCCESS","FAILURE","UNSUPPORTED","UNCOMPLETED","MISSED"]},"jobType":{"type":"string","description":"Job Type","enum":["ACTIONSET","ACTION","CONDITION","CONDITION_ACTIONSET","CONDITION_ACTION","ANTIVIRUS","PATCH_MANAGEMENT","TEAMVIEWER","MONITOR","SYSTEM","COMMENT","SHADOWPROTECT","IMAGEMANAGER","HELP_REQUEST","SOFTWARE_PATCH_MANAGEMENT","SPLASHTOP","CLOUDBERRY","CLOUDBERRY_BACKUP","SCHEDULED_TASK","RDP","SCRIPTING","SECURITY","REMOTE_TOOLS","VIRTUALIZATION","PSA","MDM","NINJA_REMOTE","NINJA_QUICK_CONNECT","NINJA_NETWORK_DISCOVERY","NINJA_BACKUP","NINJA_TICKETING","KNOWLEDGE_BASE","RELATED_ITEM","CLIENT_CHECKLIST","CHECKLIST_TEMPLATE","DOCUMENTATION","MICROSOFT_INTUNE","DYNAMIC_POLICY","MAINTENANCE_MODE","AOSP_ACTION","AOSP_POLICY","AOSP"]}}}}}}}}}},"/v2/device/{id}/activities":{"get":{"tags":["devices"],"summary":"Device activities","description":"Returns activity log for device","operationId":"getDeviceActivities","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"olderThan","in":"query","description":"Return activities recorded that are newer than specified activity ID","schema":{"type":"integer","format":"int32"}},{"name":"newerThan","in":"query","description":"Return activities recorded that are older than specified activity ID","schema":{"type":"integer","format":"int32"}},{"name":"activityType","in":"query","description":"Return activities of type","schema":{"type":"string"}},{"name":"status","in":"query","description":"Return activities with status(es)","schema":{"type":"string"}},{"name":"seriesUid","in":"query","description":"Return activities related to alert (series)","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of activities to return","schema":{"maximum":1000,"minimum":10,"type":"integer","format":"int32","default":200}},{"name":"lang","in":"query","description":"Language tag","schema":{"type":"string"}},{"name":"tz","in":"query","description":"Time Zone","schema":{"type":"string"}},{"name":"startTime","in":"query","description":"Start time for filtering activities (ISO-8601 format)","schema":{"type":"string"}},{"name":"endTime","in":"query","description":"End time for filtering activities (ISO-8601 format)","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"lastActivityId":{"type":"integer","description":"Last recorded activity ID for account","format":"int64"},"activities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Activity identifier","format":"int64"},"activityTime":{"type":"number","description":"Activity timestamp","format":"double"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"severity":{"type":"string","description":"Severity","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"]},"priority":{"type":"string","description":"Priority","enum":["NONE","LOW","MEDIUM","HIGH"]},"seriesUid":{"type":"string","description":"Activity series UID (job/condition UID)","format":"uuid"},"activityType":{"type":"string","description":"Activity type code","enum":["ACTIONSET","ACTION","CONDITION","CONDITION_ACTIONSET","CONDITION_ACTION","ANTIVIRUS","PATCH_MANAGEMENT","TEAMVIEWER","MONITOR","SYSTEM","COMMENT","SHADOWPROTECT","IMAGEMANAGER","HELP_REQUEST","SOFTWARE_PATCH_MANAGEMENT","SPLASHTOP","CLOUDBERRY","CLOUDBERRY_BACKUP","SCHEDULED_TASK","RDP","SCRIPTING","SECURITY","REMOTE_TOOLS","VIRTUALIZATION","PSA","MDM","NINJA_REMOTE","NINJA_QUICK_CONNECT","NINJA_NETWORK_DISCOVERY","NINJA_BACKUP","NINJA_TICKETING","KNOWLEDGE_BASE","RELATED_ITEM","CLIENT_CHECKLIST","CHECKLIST_TEMPLATE","DOCUMENTATION","MICROSOFT_INTUNE","DYNAMIC_POLICY","MAINTENANCE_MODE","AOSP_ACTION","AOSP_POLICY","AOSP"]},"statusCode":{"type":"string","description":"Activity status code","enum":["START_REQUESTED","STARTED","IN_PROCESS","COMPLETED","CANCEL_REQUESTED","CANCELLED","BLOCKED","QUEUED","TRIGGERED","RESET","ACKNOWLEDGED","DISABLED","EVALUATION_FAILURE","CLIENT_CREATED","CLIENT_UPDATED","CLIENT_DELETED","CREDENTIAL_CREATED","CREDENTIAL_UPDATED","CREDENTIAL_DELETED","LOCATION_CREATED","LOCATION_UPDATED","LOCATION_DELETED","POLICY_CREATED","POLICY_UPDATED","POLICY_DELETED","NODE_CREATED","NODE_UPDATED","NODE_DELETED","NODE_RE_ENROLLED","NODE_ACCESS_GRANTED","NODE_ACCESS_DENIED","NODE_REGISTRATION_REJECTED","NODE_IDENTIFICATION_UPDATED","NODE_CLONING_DETECTED","NODE_CLONE_ADVISED_TO_REGISTER","NODE_MANUALLY_APPROVED","NODE_AUTOMATICALLY_APPROVED","NODE_MANUALLY_REJECTED","NODE_AUTOMATICALLY_REJECTED","REJECTED_NODE_CLEARED","REJECTED_NODE_DELETED","MOBILE_DEVICE_UNREGISTERED","APP_USER_CREATED","APP_USER_UPDATED","APP_USER_DELETED","APP_USER_LOGGED_IN","APP_USER_LOGGED_OUT","APP_USER_MFA_SETUP","APP_USER_MFA_DELETED","APP_USER_CRITICAL_ACTION","APP_USER_AUDIT_FAILED_LOGIN","APP_USER_AUTO_ASSIGN_CHANGED","END_USER_CREATED","END_USER_CREATED_API","END_USER_UPDATED","END_USER_UPDATED_API","END_USER_DELETED","END_USER_DELETED_API","END_USER_LOGGED_IN","END_USER_LOGGED_OUT","END_USER_MFA_SETUP","END_USER_MFA_DELETED","END_USER_AUDIT_FAILED_LOGIN","END_USER_CRITICAL_ACTION","CONTACT_CREATED","CONTACT_CREATED_API","CONTACT_UPDATED","CONTACT_UPDATED_API","CONTACT_DELETED","CONTACT_DELETED_API","DEVICE_GROUP_CREATED","DEVICE_GROUP_UPDATED","DEVICE_GROUP_DELETED","TICKET_TEMPLATE_CREATED","TICKET_TEMPLATE_UPDATED","TICKET_TEMPLATE_DELETED","CUSTOM_HEALTH_STATUS_CHANGED","CUSTOM_HEALTH_STATUS_RESET","PSA_TICKET_CREATION_FAILED","PSA_TICKET_CREATION_SUCCEEDED","RESET_BY_PSA_TICKET_CALLBACK","PSA_TICKET_CREATION_TEST","PSA_ENABLED","PSA_DISABLED","PSA_CREDENTIALS_FAILED","CONNECTWISE_AGREEMENTS_SYNC_COMPLETED","CONNECTWISE_AGREEMENTS_SYNC_STARTED","CONNECTWISE_NODE_SYNC_COMPLETED","CONNECTWISE_NODE_SYNC_STARTED","CONNECTWISE_NODE_SYNC_NODE_CREATED","CONNECTWISE_NODE_SYNC_NODE_UPDATED","CONNECTWISE_NODE_SYNC_NODE_DELETED","CONNECTWISE_UPDATED","CONNECTWISECONTROL_ATTEMPT","AUTOTASK_NODE_SYNC_STARTED","AUTOTASK_NODE_SYNC_COMPLETED","AUTOTASK_NODE_SYNC_NODE_CREATED","AUTOTASK_NODE_SYNC_NODE_UPDATED","AUTOTASK_NODE_SYNC_NODE_DELETED","AUTOTASK_UPDATED","AUTOTASK_ATTACHMENT_FAILURE","PSA_TICKET_UPDATED_FAILED","PSA_TICKET_UPDATED_SUCCEEDED","REPORT_CREATED","REPORT_UPDATED","REPORT_DELETED","TIME_ZONE_UPDATED","LANGUAGE_TAG_UPDATED","NODE_ROLE_CREATED","NODE_ROLE_UPDATED","NODE_ROLE_DELETED","COMMENT","VIPREAV_INSTALLED","VIPREAV_INSTALL_FAILED","VIPREAV_UNINSTALLED","VIPREAV_UNINSTALL_FAILED","VIPREAV_SCAN_THREAT_QUARANTINED","VIPREAV_ACTIVEPROTECTION_THREAT_QUARANTINED","VIPREAV_USERINITIATED_THREAT_QUARANTINED","VIPREAV_QUARANTINED_THREAT_REMOVED","VIPREAV_REBOOT_REQUIRED","VIPREAV_SCAN_STARTED","VIPREAV_SCAN_COMPLETED","VIPREAV_SCAN_ABORTED","VIPREAV_SCAN_FAILED","VIPREAV_SCAN_PAUSED","VIPREAV_DISABLED","WEBROOT_COMMAND_SUBMITTED","WEBROOT_THREAT_DETECTED","WEBROOT_INSTALL_FAILED","BITDEFENDER_SCAN_STARTED","BITDEFENDER_SCAN_COMPLETED","BITDEFENDER_THREAT_DELETE_FROM_QUARANTINE","BITDEFENDER_THREAT_RESTORE_FROM_QUARANTINE","BITDEFENDER_SCAN_FAILED","BITDEFENDER_THREAT_DELETE_FROM_QUARANTINE_FAILED","BITDEFENDER_THREAT_RESTORE_FROM_QUARANTINE_FAILED","BITDEFENDER_DOWNLOAD_STARTED","BITDEFENDER_DOWNLOAD_SUCCEEDED","BITDEFENDER_DOWNLOAD_FAILED","BITDEFENDER_INSTALLATION_STARTED","BITDEFENDER_INSTALLATION_SUCCEEDED","BITDEFENDER_INSTALLATION_FAILED","BITDEFENDER_UNINSTALLATION_STARTED","BITDEFENDER_UNINSTALLATION_SUCCEEDED","BITDEFENDER_UNINSTALLATION_FAILED","BITDEFENDER_UNPACKING_FAILED","BDAS_BITDEFENDER_THREAT_IGNORED","BDAS_BITDEFENDER_THREAT_PRESENT","BDAS_BITDEFENDER_THREAT_DELETED","BDAS_BITDEFENDER_THREAT_BLOCKED","BDAS_BITDEFENDER_THREAT_QUARANTINED","BDAS_BITDEFENDER_THREAT_CLEANED","BDAS_BITDEFENDER_PURGE_QUARANTINE_FAILED","BDAS_BITDEFENDER_PURGE_QUARANTINE_SUCCESS","BDAS_BITDEFENDER_THREAT_QUARANTINE_RESTORED","BDAS_BITDEFENDER_THREAT_QUARANTINE_RESTORED_CUSTOMPATH","BDAS_BITDEFENDER_THREAT_QUARANTINE_DELETED","BITDEFENDER_RETRY_INSTALL_COMPLETED","BITDEFENDER_DISABLED","BITDEFENDER_EXISTING_PRODUCT_UNINSTALL","COMPETITOR_EXISTING_PRODUCT_UNINSTALL","SCHEDULE_INSTALL_OPTION_CHANGED","SECURITY_CREDENTIAL_ACCESS_GRANTED","SECURITY_CREDENTIAL_ACCESS_DENIED","PATCH_MANAGEMENT_SCAN_STARTED","PATCH_MANAGEMENT_SCAN_COMPLETED","PATCH_MANAGEMENT_APPLY_PATCH_STARTED","PATCH_MANAGEMENT_APPLY_PATCH_COMPLETED","PATCH_MANAGEMENT_INSTALLED","PATCH_MANAGEMENT_INSTALL_FAILED","PATCH_MANAGEMENT_MESSAGE","PATCH_MANAGEMENT_FAILURE","PATCH_MANAGEMENT_ROLLBACK_PATCH_REQUESTED","PATCH_MANAGEMENT_ROLLBACK_PATCH_STARTED","PATCH_MANAGEMENT_ROLLBACK_PATCH_COMPLETED","PATCH_MANAGEMENT_PATCH_APPROVED","PATCH_MANAGEMENT_PATCH_REJECTED","SOFTWARE_PATCH_MANAGEMENT_SCAN_STARTED","SOFTWARE_PATCH_MANAGEMENT_SCAN_COMPLETED","SOFTWARE_PATCH_MANAGEMENT_APPLY_PATCH_STARTED","SOFTWARE_PATCH_MANAGEMENT_APPLY_PATCH_COMPLETED","SOFTWARE_PATCH_MANAGEMENT_INSTALLED","SOFTWARE_PATCH_MANAGEMENT_INSTALL_FAILED","SOFTWARE_PATCH_MANAGEMENT_MESSAGE","SOFTWARE_PATCH_MANAGEMENT_PATCH_APPROVED","SOFTWARE_PATCH_MANAGEMENT_PATCH_REJECTED","SPLASHTOP_CONNECTION_INITIATED","SPLASHTOP_CONNECTION_ESTABLISHED","SPLASHTOP_CONNECTION_TERMINATED","REMOTE_TOOLS_UPLOAD_FILE_INITIATED","REMOTE_TOOLS_DOWNLOAD_FILE_INITIATED","REMOTE_TOOLS_COMPRESS_FILE_INITIATED","REMOTE_TOOLS_COMPRESS_FILE_SUCCESS","REMOTE_TOOLS_COMPRESS_FILE_FAILED","REMOTE_TOOLS_CREATE_DIRECTORY_INITIATED","REMOTE_TOOLS_RENAME_FILE_INITIATED","REMOTE_TOOLS_DELETE_FILE_INITIATED","REMOTE_TOOLS_MODIFY_OBJECT_SUCCESS","REMOTE_TOOLS_MODIFY_OBJECT_FAILED","REMOTE_TOOLS_COPY_OBJECT_SUCCESS","REMOTE_TOOLS_COPY_OBJECT_FAILED","REMOTE_TOOLS_MOVE_OBJECT_SUCCESS","REMOTE_TOOLS_MOVE_OBJECT_FAILED","REMOTE_TOOLS_DELETE_OBJECT_SUCCESS","REMOTE_TOOLS_DELETE_OBJECT_FAILED","REMOTE_TOOLS_CREATE_DIRECTORY_SUCCESS","REMOTE_TOOLS_CREATE_DIRECTORY_FAILED","REMOTE_TOOLS_FILE_TRANSFER_SUCCESS","REMOTE_TOOLS_FILE_TRANSFER_FAILED","REMOTE_TOOLS_SERVICE_CONTROL_INITIATED","REMOTE_TOOLS_START_SERVICE_SUCCESS","REMOTE_TOOLS_START_SERVICE_FAILED","REMOTE_TOOLS_STOP_SERVICE_SUCCESS","REMOTE_TOOLS_STOP_SERVICE_FAILED","REMOTE_TOOLS_RESTART_SERVICE_SUCCESS","REMOTE_TOOLS_RESTART_SERVICE_FAILED","REMOTE_TOOLS_START_TYPE_CHANGE_SUCCESS","REMOTE_TOOLS_START_TYPE_CHANGE_FAILED","REMOTE_TOOLS_PROCESS_CONTROL_INITIATED","REMOTE_TOOLS_SET_PROCESS_PRIORITY_SUCESS","REMOTE_TOOLS_SET_PROCESS_PRIORITY_FAILED","REMOTE_TOOLS_TERMINATE_PROCESS_SUCCESS","REMOTE_TOOLS_TERMINATE_PROCESS_FAILED","REMOTE_TOOLS_TERMINATE_PROCESS_TREE_SUCCESS","REMOTE_TOOLS_TERMINATE_PROCESS_TREE_FAILED","REMOTE_TOOLS_REGISTRY_CONTROL_INITIATED","REMOTE_TOOLS_CREATE_KEY_SUCCESS","REMOTE_TOOLS_CREATE_KEY_FAILED","REMOTE_TOOLS_RENAME_KEY_SUCCESS","REMOTE_TOOLS_RENAME_KEY_FAILED","REMOTE_TOOLS_DELETE_KEY_SUCCESS","REMOTE_TOOLS_DELETE_KEY_FAILED","REMOTE_TOOLS_CREATE_PARAMETER_SUCCESS","REMOTE_TOOLS_CREATE_PARAMETER_FAILED","REMOTE_TOOLS_RENAME_PARAMETER_SUCCESS","REMOTE_TOOLS_RENAME_PARAMETER_FAILED","REMOTE_TOOLS_DELETE_PARAMETER_SUCCESS","REMOTE_TOOLS_DELETE_PARAMETER_FAILED","REMOTE_TOOLS_MODIFY_PARAMETER_SUCCESS","REMOTE_TOOLS_MODIFY_PARAMETER_FAILED","REMOTE_TOOLS_ACTIVE_DIRECTORY_INITIATED","ADAPTER_ADDED","ADAPTER_REMOVED","ADAPTER_CONFIG_CHANGED","ADAPTER_STATUS_CHANGED","CPU_ADDED","CPU_REMOVED","MEMORY_ADDED","MEMORY_REMOVED","DISK_DRIVE_ADDED","DISK_DRIVE_REMOVED","USER_LOGGED_IN","USER_LOGGED_OUT","PORT_OPENED","PORT_CLOSED","WINDOWS_SERVICE_STARTED","WINDOWS_SERVICE_STOPPED","MAC_DAEMON_STARTED","MAC_DAEMON_STOPPED","USER_ACCOUNT_ADDED","USER_ACCOUNT_REMOVED","PROCESS_STARTED","PROCESS_STOPPED","SYSTEM_REBOOTED","SOFTWARE_ADDED","SOFTWARE_REMOVED","SOFTWARE_UPDATED","SOFTWARE_OS_UPDATED","DISK_PARTITION_ADDED","DISK_PARTITION_REMOVED","DISK_VOLUME_ADDED","DISK_VOLUME_REMOVED","CREDENTIALS_CHANGED","RAID_CONTROLLER_ADDED","RAID_CONTROLLER_REMOVED","RAID_PHYSICAL_DRIVE_ADDED","RAID_PHYSICAL_DRIVE_REMOVED","RAID_LOGICAL_DISK_ADDED","RAID_LOGICAL_DISK_REMOVED","BITLOCKER_ENABLED","BITLOCKER_DISABLED","FILEVAULT_ENABLED","FILEVAULT_DISABLED","TRUSTED_PLATFORM_MODULE_ENABLED","TRUSTED_PLATFORM_MODULE_DISABLED","TRUSTED_PLATFORM_MODULE_INSTALLED","TRUSTED_PLATFORM_MODULE_UNINSTALLED","SHADOWPROTECT_INSTALLED","SHADOWPROTECT_INSTALL_FAILED","SHADOWPROTECT_UNINSTALLED","SHADOWPROTECT_UNINSTALL_FAILED","SHADOWPROTECT_BACKUPJOB_FAILED","SHADOWPROTECT_BACKUPJOB_ABORTED","SHADOWPROTECT_LICENSE_PROVISIONED","SHADOWPROTECT_LICENSE_PROVISION_FAILED","SHADOWPROTECT_LICENSE_ACTIVATED","SHADOWPROTECT_LICENSE_ACTIVATION_FAILED","SHADOWPROTECT_LICENSE_DEACTIVATED","SHADOWPROTECT_LICENSE_DEACTIVATION_FAILED","IMAGEMANAGER_INSTALLED","IMAGEMANAGER_INSTALL_FAILED","IMAGEMANAGER_UNINSTALLED","IMAGEMANAGER_UNINSTALL_FAILED","IMAGEMANAGER_LICENSE_PROVISIONED","IMAGEMANAGER_LICENSE_PROVISION_FAILED","IMAGEMANAGER_LICENSE_ACTIVATED","IMAGEMANAGER_LICENSE_ACTIVATION_FAILED","IMAGEMANAGER_LICENSE_DEACTIVATED","IMAGEMANAGER_LICENSE_DEACTIVATION_FAILED","IMAGEMANAGER_CONSOLIDATION_FAILED","IMAGEMANAGER_VERIFICATION_FAILED","HELP_REQUEST_SUBMITTED","CLOUDBERRY_INSTALLED","CLOUDBERRY_INSTALL_FAILED","CLOUDBERRY_UNINSTALLED","CLOUDBERRY_UNINSTALL_FAILED","CLOUDBERRY_BACKUPPLAN_CREATED","CLOUDBERRY_BACKUPPLAN_EDITED","CLOUDBERRY_BACKUPPLAN_DELETED","CLOUDBERRY_BACKUPPLAN_CREATION_FAILED","CLOUDBERRY_BACKUPJOB_STARTED","CLOUDBERRY_BACKUPJOB_SUCCEEDED","CLOUDBERRY_BACKUPJOB_FAILED","CLOUDBERRY_BACKUPJOB_COMPLETED_WITH_WARNING","CLOUDBERRY_USER_CREATED","CLOUDBERRY_NETWORK_CREDENTIAL_CREATED","CLOUDBERRY_NETWORK_CREDENTIAL_CREATION_FAILED","RDP_CONNECTION_INITIATED","RDP_AUTO_PROVISION","SCHEDULED_TASK_CREATED","SCHEDULED_TASK_UPDATED","SCHEDULED_TASK_DELETED","SCRIPT_CREATED","SCRIPT_UPDATED","SCRIPT_DELETED","NINJA_BACKUP_BACKUPJOB_START_REQUESTED","NINJA_BACKUP_BACKUPJOB_STARTED","NINJA_BACKUP_BACKUPJOB_IN_PROCESS","NINJA_BACKUP_BACKUPJOB_COMPLETED","NINJA_BACKUP_BACKUPJOB_FAILED","NINJA_BACKUP_RESTOREJOB_START_REQUESTED","NINJA_BACKUP_RESTOREJOB_STARTED","NINJA_BACKUP_RESTOREJOB_IN_PROCESS","NINJA_BACKUP_RESTOREJOB_COMPLETED","NINJA_BACKUP_RESTOREJOB_FAILED","NINJA_BACKUP_BACKUPJOB_COMPLETED_WITH_WARNING","NINJA_BACKUP_BACKUP_DOWNLOADED","NINJA_BACKUP_BACKUPPLAN_ADDED","NINJA_BACKUP_BACKUPPLAN_EDITED","NINJA_BACKUP_BACKUPPLAN_DELETED","NINJA_BACKUP_BACKUPJOB_CANCELLED","NINJA_BACKUP_BACKUPJOB_PROCESSING","NINJA_BACKUP_INSTALL_FAILED","NINJA_BACKUP_UNINSTALL_FAILED","NINJA_BACKUP_INSTALLED","NINJA_BACKUP_UNINSTALLED","NINJA_BACKUP_RESTOREJOB_CANCELLED","NINJA_BACKUP_BACKUPPLAN_CREATION_FAILED","NINJA_BACKUP_BACKUP_CONFIGURE_FAILED","NINJA_BACKUP_FILE_DOWNLOAD","NINJA_BACKUP_FOLDER_DOWNLOAD","NINJA_BACKUP_UPSYNCJOB_START_REQUESTED","NINJA_BACKUP_UPSYNCJOB_PROCESSING","NINJA_BACKUP_UPSYNCJOB_IN_PROCESS","NINJA_BACKUP_UPSYNCJOB_STARTED","NINJA_BACKUP_UPSYNCJOB_COMPLETED","NINJA_BACKUP_UPSYNCJOB_CANCELLED","NINJA_BACKUP_UPSYNCJOB_FAILED","NINJA_BACKUP_BACKUP_NAS_ACCESS_FAILED","NINJA_BACKUP_IMAGE_RESTORE_STARTED","NINJA_BACKUP_IMAGE_RESTORE_COMPLETED","NINJA_BACKUP_IMAGE_RESTORE_FAILED","NINJA_BACKUP_IMAGE_DOWNLOAD_STARTED","NINJA_BACKUP_IMAGE_DOWNLOAD_COMPLETED","NINJA_BACKUP_IMAGE_DOWNLOAD_FAILED","NINJA_BACKUP_IMAGE_DOWNLOAD_FILE_STARTED","NINJA_BACKUP_IMAGE_DOWNLOAD_FILE_COMPLETED","NINJA_BACKUP_IMAGE_DOWNLOAD_FILE_FAILED","NINJA_BACKUP_IMAGE_MOUNT_COMPLETED","NINJA_BACKUP_IMAGE_MOUNT_FAILED","NINJA_BACKUP_INTEGRITY_CHECK_START_REQUESTED","NINJA_BACKUP_INTEGRITY_CHECK_STARTED","NINJA_BACKUP_INTEGRITY_CHECK_IN_PROCESS","NINJA_BACKUP_INTEGRITY_CHECK_COMPLETED","NINJA_BACKUP_INTEGRITY_CHECK_FAILED","NINJA_BACKUP_INTEGRITY_CHECK_CANCELLED","NINJA_BACKUP_IMAGE_DOWNLOAD_FOLDER_STARTED","NINJA_BACKUP_IMAGE_DOWNLOAD_FOLDER_COMPLETED","NINJA_BACKUP_IMAGE_DOWNLOAD_FOLDER_FAILED","BACKUP_IMAGE_RESTORE_CANCELED","BACKUP_IMAGE_DOWNLOAD_CANCELED","QC_INVITATION_CREATED","QC_INVITATION_DISABLED","QC_EXPIRED_INVITATION_BLOCKED","QC_INVITATION_UPDATED","QC_DEVICE_DELETED","QC_DEVICE_AGENT_INSTALL_REQUESTED","QC_SESSION_STARTED","QC_SESSION_TERMINATED","QC_SESSION_REPORT_SUBMITTED","REMOTE_SUPPORT_CREATED","REMOTE_SUPPORT_UPDATED","REMOTE_SUPPORT_DELETED","MDM_LOCK_DEVICE_STATUS_CREATED","MDM_REBOOT_DEVICE_STATUS_CREATED","MDM_RESET_PASSCODE_DEVICE_STATUS_CREATED","MDM_RELINQUISH_OWNERSHIP_DEVICE_STATUS_CREATED","MDM_LOCK_DEVICE_STATUS_UPDATED","MDM_REBOOT_DEVICE_STATUS_UPDATED","MDM_RESET_PASSCODE_DEVICE_STATUS_UPDATED","MDM_RELINQUISH_OWNERSHIP_DEVICE_STATUS_UPDATED","MDM_CLEAR_PASSCODE_STATUS_CREATED","MDM_CLEAR_PASSCODE_STATUS_UPDATED","MDM_ERASE_STATUS_CREATED","MDM_ERASE_STATUS_UPDATED","MDM_UPDATE_POLICY_STATUS_CREATED","MDM_UPDATE_POLICY_STATUS_UPDATED","MDM_ASSIGN_POLICY_STATUS_CREATED","MDM_ASSIGN_POLICY_STATUS_UPDATED","MDM_DIVISION_CONFIG_ENABLED","MDM_DIVISION_CONFIG_DISABLED","MDM_DIVISION_CONFIG_UPDATED","MDM_APN_CERTIFICATE_UPLOADED","MDM_ACTION_DEVICE_STATUS_FAILED","MDM_DISOWN_STATUS_FORBIDDEN","MDM_DISOWN_STATUS_COMPLETED","MDM_ADE_TOKEN_UPLOADED","MDM_ADE_TOKEN_RENEWED","MDM_RENEW_ENROLLMENT_PROFILE_STATUS_CREATED","MDM_RENEW_ENROLLMENT_PROFILE_STATUS_UPDATED","MDM_INSTALL_APP_STATUS_CREATED","MDM_APN_CERTIFICATE_RENEWED","MDM_CONNECTION_ANDROID_ENTERPRISE_RENAME_SUCCESS","MDM_CLEAR_APP_DATA_STATUS_CREATED","MDM_CLEAR_APP_DATA_STATUS_UPDATED","AOSP_ERASE_DEVICE_STATUS_CREATED","AOSP_ERASE_DEVICE_STATUS_COMPLETED","AOSP_LOCK_DEVICE_STATUS_CREATED","AOSP_LOCK_DEVICE_STATUS_UPDATED","AOSP_REBOOT_DEVICE_STATUS_CREATED","AOSP_REBOOT_DEVICE_STATUS_COMPLETED","AOSP_RESET_PASSCODE_DEVICE_STATUS_CREATED","AOSP_RESET_PASSCODE_DEVICE_STATUS_COMPLETED","AOSP_UPDATE_POLICY_STATUS_UPDATED","AOSP_NC_SESSION_REQUESTED","AOSP_NC_SESSION_STARTED","AOSP_NC_SESSION_TERMINATED","REPORT_TEMPLATE_CREATED","REPORT_TEMPLATE_UPDATED","REPORT_TEMPLATE_DELETED","REPORT_SCHEDULE_CREATED","REPORT_SCHEDULE_UPDATED","REPORT_SCHEDULE_DELETED","REPORT_TEMPLATE_DUPLICATED","REPORT_SCHEDULE_DUPLICATED","GRAVITYZONE_ENABLED","GRAVITYZONE_DISABLED","GRAVITYZONE_SCAN_STARTED","GRAVITYZONE_SCAN_COMPLETED","GRAVITYZONE_SCAN_FAILED","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE_FAILED","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE_FAILED","GRAVITYZONE_INSTALLATION_SUCCEEDED","GRAVITYZONE_INSTALLATION_SUCCEEDED_WITH_WARNINGS","GRAVITYZONE_INSTALLATION_FAILED","GRAVITYZONE_THREAT_IGNORED","GRAVITYZONE_THREAT_PRESENT","GRAVITYZONE_THREAT_DELETED","GRAVITYZONE_THREAT_BLOCKED","GRAVITYZONE_THREAT_REPORTED","GRAVITYZONE_THREAT_QUARANTINED","GRAVITYZONE_THREAT_CLEANED","GRAVITYZONE_PURGE_QUARANTINE_FAILED","GRAVITYZONE_PURGE_QUARANTINE_SUCCESS","GRAVITYZONE_THREAT_RESTORE_AND_EXCLUDED_FROM_QUARANTINE","GRAVITYZONE_THREAT_RESTORE_AND_EXCLUDED_FROM_QUARANTINE_FAILED","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE_COMPLETED","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE_COMPLETED","GRAVITYZONE_PROVISION_COMPLETED","GRAVITYZONE_PROVISION_FAILED","GRAVITYZONE_RETRY_INSTALL_COMPLETED","GRAVITYZONE_PARTNER_ASSIST_DISABLED","GRAVITYZONE_SCAN_ATTEMPT_COMPLETED","GRAVITYZONE_RESET_INACCESSIBLE_LICENSE_COMPLETED","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE_REQUESTED","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE_REQUESTED","GRAVITYZONE_THREAT_RESTORE_AND_EXCLUDED_FROM_QUARANTINE_REQUESTED","GRAVITYZONE_INSTALLATION_STARTED","GRAVITYZONE_DOWNLOAD_FAILED","GRAVITYZONE_INSTALLATION_RETRY_STARTED","GRAVITYZONE_SCAN_CANCELLED","GRAVITYZONE_DISABLING_FAILED","GRAVITYZONE_INSTALLATION_EXISTS_DETECTED","GRAVITYZONE_THREAT_BLOCKED_FROM_ACTIVE_REQUESTED","GRAVITYZONE_THREAT_BLOCKED_FROM_ACTIVE_COMPLETED","GRAVITYZONE_THREAT_BLOCKED_FROM_ACTIVE_FAILED","GRAVITYZONE_DEVICE_MANAGED","GRAVITYZONE_DEVICE_UNMANAGED","GRAVITYZONE_COMPANY_CANNOT_BE_ACCESSED","GRAVITYZONE_QUARANTINED_THREAT_DELETED_OR_RESTORED","GRAVITYZONE_SUCCEEDED_TO_REQUEST_RECONFIGURE_TASK","GRAVITYZONE_FAILED_TO_REQUEST_RECONFIGURE_TASK","GRAVITYZONE_ADVANCED_THREAT_DISINFECTED","GRAVITYZONE_ADVANCED_THREAT_BLOCKED","GRAVITYZONE_INCIDENT_REPORTED","GRAVITYZONE_INCIDENT_VISIBILITY_FLAG_UPDATED","GRAVITYZONE_EXTENDED_INCIDENT_REPORTED","GRAVITYZONE_THREAT_STILL_PRESENT_AFTER_SCAN","ATTACHMENT_FILE_SUSPICIOUS","SMTP_SEND_ERROR","TECHNICIAN_ROLE_CREATED","TECHNICIAN_ROLE_UPDATED","TECHNICIAN_ROLE_DELETED","TECHNICIAN_ROLE_ASSIGNMENT_CHANGED","TECHNICIAN_PERMISSIONS_CHANGED","END_USER_ROLE_CREATED","END_USER_ROLE_UPDATED","END_USER_ROLE_DELETED","END_USER_ROLE_ASSIGNMENT_CHANGED","END_USER_PERMISSIONS_CHANGED","SENTINEL_ONE_AGENT_ENABLED","SENTINEL_ONE_AGENT_DISABLED","SENTINEL_ONE_AGENT_STARTED","SENTINEL_ONE_AGENT_UPGRADED","SENTINEL_ONE_AGENT_SHUT_DOWN","SENTINEL_ONE_AGENT_INSTALLATION_SUCCEEDED","SENTINEL_ONE_INSTALLATION_ANOTHER_AV_DETECTED","SENTINEL_ONE_AGENT_INSTALLATION_FAILED","SENTINEL_ONE_POLICY_CHANGED","SENTINEL_ONE_LOCAL_CONFIG_CHANGE_FAILED","SENTINEL_ONE_REGISTRATION_SUCCEEDED","SENTINEL_ONE_REGISTRATION_FAILED","SENTINEL_ONE_REMEDIATION_SUCCEEDED","SENTINEL_ONE_REMEDIATION_FAILED","SENTINEL_ONE_MITIGATION_SUCCEEDED","SENTINEL_ONE_MITIGATION_FAILED","SENTINEL_ONE_MITIGATION_REQUIRE_REBOOT","SENTINEL_ONE_MITIGATION_CANNOT_KILL","SENTINEL_ONE_MITIGATION_FAILED_TO_KILL","SENTINEL_ONE_QUARANTINE_SUCCEEDED","SENTINEL_ONE_QUARANTINE_FAILED","SENTINEL_ONE_UNQUARANTINE_SUCCEEDED","SENTINEL_ONE_UNQUARANTINE_FAILED","SENTINEL_ONE_THREAT_DETECTED","SENTINEL_ONE_SCAN_STARTED","SENTINEL_ONE_SCAN_COMPLETED","SENTINEL_ONE_SCAN_FAILED","SENTINEL_ONE_SCAN_ABORTED","SENTINEL_ONE_COMMAND_RECEIVED","SENTINEL_ONE_COMMAND_FAILED","SENTINEL_ONE_AGENT_UPGRADE_SUCCEEDED","SENTINEL_ONE_SITE_TOKEN_REGENERATED","SENTINEL_ONE_ON_DEMAND_SCAN_STARTED","SENTINEL_ONE_ON_DEMAND_SCAN_COMPLETED","SENTINEL_ONE_ON_DEMAND_SCAN_ABORTED","SENTINEL_ONE_RETRY_INSTALL_COMPLETED","SENTINEL_ONE_REFRESH_API_TOKEN_SUCCEEDED","SENTINEL_ONE_REFRESH_API_TOKEN_FAILED","SENTINEL_ONE_INTEGRATION_ENABLED","SENTINEL_ONE_INTEGRATION_DISABLED","SENTINEL_ONE_INTEGRATION_CREDENTIALS_UPDATED","SENTINEL_ONE_INTEGRATION_RESYNC_INITIATED","SENTINEL_ONE_INTEGRATION_RESYNC_REQUIRED","SENTINEL_ONE_EXISTING_INSTALLATION_DETECTED","SENTINEL_ONE_AGENT_SYNC_SUCCESS","SENTINEL_ONE_AGENT_SYNC_FAILED_RETRY","SENTINEL_ONE_AGENT_SYNC_FAILED","SENTINEL_ONE_AGENT_SYNC_CANCELLED","SENTINEL_ONE_AGENT_SYNC_MAPPING_FAILED","OAUTH2_CREATED","OAUTH2_UPDATED","OAUTH2_DELETED","CROWDSTRIKE_SENSOR_ENABLED","CROWDSTRIKE_SENSOR_DISABLED","CROWDSTRIKE_SENSOR_STARTED","CROWDSTRIKE_SENSOR_UPGRADED","CROWDSTRIKE_SENSOR_SHUT_DOWN","CROWDSTRIKE_SENSOR_INSTALLATION_SUCCEEDED","CROWDSTRIKE_SENSOR_INSTALLATION_FAILED","CROWDSTRIKE_REGISTRATION_SUCCEEDED","CROWDSTRIKE_REGISTRATION_FAILED","CROWDSTRIKE_REMEDIATION_SUCCEEDED","CROWDSTRIKE_REMEDIATION_FAILED","CROWDSTRIKE_MITIGATION_SUCCEEDED","CROWDSTRIKE_MITIGATION_FAILED","CROWDSTRIKE_QUARANTINE_SUCCEEDED","CROWDSTRIKE_QUARANTINE_FAILED","CROWDSTRIKE_THREAT_DETECTED","CROWDSTRIKE_MISSING_PERMISSIONS","CROWDSTRIKE_CREDENTIAL_INVALID","CROWDSTRIKE_INSTALLATION_ANOTHER_AV_DETECTED","CROWDSTRIKE_ENABLED","CROWDSTRIKE_DISABLED","CROWDSTRIKE_CREDENTIALS_UPDATED","CROWDSTRIKE_EXISTING_INSTALLATION_DETECTED","CROWDSTRIKE_RETRY_INSTALL_COMPLETED","CROWDSTRIKE_MISSING_API_CLIENT_SCOPE","CROWDSTRIKE_PARTNER_PROVISION_IN_PROGRESS","CROWDSTRIKE_PARTNER_PROVISION_COMPLETED","CROWDSTRIKE_PARTNER_PROVISION_FAILED","CROWDSTRIKE_CUSTOMER_PROVISION_IN_PROGRESS","CROWDSTRIKE_CUSTOMER_PROVISION_COMPLETED","CROWDSTRIKE_CUSTOMER_PROVISION_FAILED","CROWDSTRIKE_FALCON_COMPLETE_CREDENTIAL_INVALID","CROWDSTRIKE_MISSING_FALCON_COMPLETE_API_CLIENT_SCOPE","CROWDSTRIKE_UNMANAGED_INSTALLATION_DETECTED","CROWDSTRIKE_SENSOR_PROVISIONING","CROWDSTRIKE_SENSOR_MIGRATED","CROWDSTRIKE_CUSTOMER_BUNDLE_UPDATED","CROWDSTRIKE_CREDENTIAL_UNHEALTHY","CROWDSTRIKE_CREDENTIAL_VALIDATED","CROWDSTRIKE_FALCON_COMPLETE_CREDENTIAL_UNHEALTHY","CROWDSTRIKE_FALCON_COMPLETE_CREDENTIAL_VALIDATED","SERVICE_NOW_UPDATED","SERVICE_NOW_CONFIGURATION_ITEM_CLASS_MAPPING_CREATED","SERVICE_NOW_CONFIGURATION_ITEM_CLASS_MAPPING_UPDATED","SERVICE_NOW_CONFIGURATION_ITEM_CLASS_MAPPING_DELETED","SERVICE_NOW_RESET_AUTHENTICATION","SERVICE_NOW_NODE_SYNC_NODE_CREATED","SERVICE_NOW_NODE_SYNC_NODE_UPDATED","SERVICE_NOW_NODE_SYNC_NODE_ERROR","SERVICE_NOW_NODE_SYNC_BY_CLIENT_STARTED","SERVICE_NOW_NODE_SYNC_BY_CLIENT_COMPLETED","SERVICE_NOW_CLIENT_MAPPING_CREATED","SERVICE_NOW_CLIENT_MAPPING_UPDATED","SERVICE_NOW_CLIENT_MAPPING_DELETED","SERVICE_NOW_SYNC_CLIENT_ON_DEMAND","SERVICE_NOW_CLIENT_MAPPING_STATUS_UPDATED","ZENDESK_UPDATED","FRESHSERVICE_UPDATED","NINJA_TICKETING_CREATION_FAILED","NINJA_TICKETING_FORM_CREATED","NINJA_TICKETING_FORM_UPDATED","NINJA_TICKETING_FORM_ACTIVED","NINJA_TICKETING_FORM_DEACTIVED","NINJA_TICKETING_ATTRIBUTE_CREATED","NINJA_TICKETING_ATTRIBUTE_UPDATED","NINJA_TICKETING_ATTRIBUTE_ACTIVED","NINJA_TICKETING_ATTRIBUTE_DEACTIVATED","NINJA_TICKETING_RULESET_CREATED","NINJA_TICKETING_RULESET_UPDATED","NINJA_TICKETING_RULESET_DELETED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_CREATED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_UPDATED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_DELETED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_MAKE_DEFAULT","NINJA_TICKETING_TRIGGER_CREATED","NINJA_TICKETING_TRIGGER_UPDATED","NINJA_TICKETING_TRIGGER_DELETED","NINJA_TICKETING_TICKET_CREATED","NINJA_TICKETING_TICKET_DELETED","NINJA_TICKETING_PENDING_EMAIL_CREATION_APPROVED","NINJA_TICKETING_PENDING_EMAIL_UPDATE_APPROVED","NINJA_TICKETING_PENDING_EMAIL_REJECTED","NINJA_TICKETING_ENABLED","NINJA_TICKETING_DISABLED","NINJA_TICKETING_UPDATED","NINJA_TICKETING_FORM_MAKE_DEFAULT","NINJA_TICKETING_CONDITION_RULE_MAKE_DEFAULT","NINJA_TICKETING_SCRIPT_RULE_MAKE_DEFAULT","NINJA_TICKETING_PENDING_EMAIL_RECEIVED","NINJA_TICKETING_EMAIL_ALLOWLIST_ITEM_CREATED","NINJA_TICKETING_EMAIL_ALLOWLIST_ITEM_UPDATED","NINJA_TICKETING_EMAIL_ALLOWLIST_ITEM_DELETED","NINJA_TICKETING_EMAIL_BLOCKLIST_ITEM_CREATED","NINJA_TICKETING_EMAIL_BLOCKLIST_ITEM_UPDATED","NINJA_TICKETING_EMAIL_BLOCKLIST_ITEM_DELETED","NINJA_TICKETING_TICKET_REINSTATED","NINJA_TICKETING_STATUS_CREATED","NINJA_TICKETING_STATUS_UPDATED","NINJA_TICKETING_STATUS_DELETED","NINJA_TICKETING_AGREEMENT_BULK_UPDATED","KNOWLEDGE_BASE_DOCUMENT_CREATED","KNOWLEDGE_BASE_DOCUMENT_UPDATED","KNOWLEDGE_BASE_DOCUMENT_ARCHIVED","KNOWLEDGE_BASE_DOCUMENT_RESTORED","KNOWLEDGE_BASE_DOCUMENT_DELETED","KNOWLEDGE_BASE_FOLDER_CREATED","KNOWLEDGE_BASE_FOLDER_UPDATED","KNOWLEDGE_BASE_FOLDER_ARCHIVED","KNOWLEDGE_BASE_FOLDER_RESTORED","KNOWLEDGE_BASE_FOLDER_DELETED","KNOWLEDGE_BASE_PUBLIC_TEMPORARY_TOKEN_CREATED","KNOWLEDGE_BASE_PUBLIC_LINK_CREATED","KNOWLEDGE_BASE_PUBLIC_LINK_UPDATED","KNOWLEDGE_BASE_PUBLIC_LINK_DELETED","KNOWLEDGE_BASE_FOLDER_MOVED","KNOWLEDGE_BASE_DOCUMENT_MOVED","KNOWLEDGE_BASE_FOLDER_SHARED","KNOWLEDGE_BASE_FOLDER_ACCESS_RESTRICTED","DOCUMENT_TEMPLATE_CREATED","DOCUMENT_TEMPLATE_UPDATED","DOCUMENT_TEMPLATE_ARCHIVED","DOCUMENT_TEMPLATE_RESTORED","DOCUMENT_TEMPLATE_DELETED","CLIENT_DOCUMENT_CREATED","CLIENT_DOCUMENT_UPDATED","CLIENT_DOCUMENT_ARCHIVED","CLIENT_DOCUMENT_RESTORED","CLIENT_DOCUMENT_DELETED","CLIENT_DOCUMENT_ATTRIBUTE_VALUE_DECRYPTED","CLIENT_DOCUMENT_REVISION_DELETED","CLIENT_DOCUMENTATION_DELEGATE_NODE_RESPONSIBILITY_ADDED","CLIENT_DOCUMENTATION_DELEGATE_NODE_RESPONSIBILITY_REMOVED","CLIENT_DOCUMENT_ATTRIBUTE_TEMPORARY_PUBLIC_TOKEN_CREATED","CLIENT_CHECKLIST_CREATED","CLIENT_CHECKLIST_UPDATED","CLIENT_CHECKLIST_DELETED","CLIENT_CHECKLIST_PROMOTED","CLIENT_CHECKLIST_TEMPORARY_PUBLIC_TOKEN_CREATED","CLIENT_CHECKLIST_ARCHIVED","CLIENT_CHECKLIST_RESTORED","CHECKLIST_TEMPLATE_CREATED","CHECKLIST_TEMPLATE_UPDATED","CHECKLIST_TEMPLATE_DELETED","CHECKLIST_TEMPLATE_ARCHIVED","CHECKLIST_TEMPLATE_RESTORED","RELATED_ITEM_CREATED","RELATED_ITEM_UPDATED","RELATED_ITEM_DELETED","RELATED_ITEM_SECURE_VALUE_DECRYPTED","RELATED_ITEM_TEMPORARY_PUBLIC_TOKEN_CREATED","ANTIVIRUS_THREAT_MUTED","ANTIVIRUS_THREAT_UNMUTED","SUPPLIER_CREATED","SUPPLIER_UPDATED","SUPPLIER_DELETED","MAINTENANCE_MODE_CONFIGURED","MAINTENANCE_MODE_DELETED","MAINTENANCE_MODE_MODIFIED","MAINTENANCE_MODE_FAILED","MAINTENANCE_MODE_ACTIVE","MAINTENANCE_MODE_UPDATED","MAINTENANCE_MODE_COMPLETED","SIEM_EXPORTER_WEBHOOK_CREATED","SIEM_EXPORTER_WEBHOOK_DELETED","SIEM_EXPORTER_WEBHOOK_ENABLED","SIEM_EXPORTER_WEBHOOK_DISABLED","SIEM_EXPORTER_WEBHOOK_UPDATED","SIEM_EXPORTER_WEBHOOK_DISPATCH_FAILURE","SIEM_EXPORTER_ENABLED","SIEM_EXPORTER_DISABLED"]},"status":{"type":"string","description":"Status description"},"activityResult":{"type":"string","description":"Activity result","enum":["SUCCESS","FAILURE","UNSUPPORTED","UNCOMPLETED","MISSED"]},"sourceConfigUid":{"type":"string","description":"Source configuration/policy element reference","format":"uuid"},"sourceName":{"type":"string","description":"Source configuration/policy element name"},"subject":{"type":"string","description":"Activity subject"},"userId":{"type":"integer","description":"User identifier","format":"int32"},"message":{"type":"string","description":"Activity message"},"type":{"type":"string","description":"Activity type description"},"data":{"type":"object","additionalProperties":true,"description":"Activity data"}}}},"lastNodeActivityId":{"type":"integer","description":"Last recorded activity ID for device","format":"int64"}}}}}}}}},"/v2/device/{id}/alerts":{"get":{"tags":["devices"],"summary":"Device alerts (triggered conditions)","description":"Returns list of active alerts (triggered conditions) for device","operationId":"getDeviceAlerts","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"lang","in":"query","schema":{"type":"string","description":"Language tag"}},{"name":"tz","in":"query","description":"Time Zone","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"uid":{"type":"string","description":"Alert UID (activity series UID)","format":"uuid"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"message":{"type":"string","description":"Alert message"},"createTime":{"type":"number","description":"Alert creation timestamp","format":"double"},"updateTime":{"type":"number","description":"Alert last updated","format":"double"},"sourceType":{"type":"string","description":"Alert origin","enum":["AGENT_OFFLINE","CONDITION_AGENT_CPU","CONDITION_AGENT_MEMORY","CONDITION_AGENT_NETWORK","CONDITION_AGENT_DISK_IO","CONDITION_AGENT_DISK_FREE_SPACE","CONDITION_AGENT_DISK_USAGE","CONDITION_AGENT_CVSS_SCORE","CONDITION_AGENT_PATCH_LAST_INSTALLED","CONDITION_NMS_CPU","CONDITION_NMS_MEMORY","CONDITION_NMS_NETWORK_TRAFFIC_BITS","CONDITION_NMS_NETWORK_ADAPTER_STATUS","CONDITION_NMS_NETWORK_TRAFFIC_PERCENT","CONDITION_NMS_NETWORK_STATUS","CONDITION_NMS_NETWORK_STATUS_CHANGE","CONDITION_NMS_SYSTEM_UPTIME","CONDITION_PING","CONDITION_PING_LATENCY","CONDITION_PING_PACKET_LOSS","CONDITION_PING_RESPONSE","CONDITION_SYSTEM_UPTIME","CONDITION_SMART_STATUS_DEGRATED","CONDITION_RAID_HEALTH_STATUS","CONDITION_SCRIPT_RESULT","CONDITION_HTTP","CONDITION_HTTP_RESPONSE","CONDITION_PORT","CONDITION_PORT_SCAN","CONDITION_SYSLOG","CONDITION_CONFIGURATION_FILE","CONDITION_SNMPTRAP","CONDITION_CRITICAL_EVENT","CONDITION_BATTERY_MONITORING","CONDITION_DNS","CONDITION_EMAIL","CONDITION_CUSTOM_SNMP","CONDITION_COMPOUND","SHADOWPROTECT_BACKUPJOB_CREATE","SHADOWPROTECT_BACKUPJOB_UPDATE","SHADOWPROTECT_BACKUPJOB_DELETE","SHADOWPROTECT_BACKUPJOB_EXECUTE","IMAGEMANAGER_MANAGEDFOLDER_CREATE","IMAGEMANAGER_MANAGEDFOLDER_UPDATE","IMAGEMANAGER_MANAGEDFOLDER_DELETE","IMAGEMANAGER_MANAGEDFOLDER_EXECUTE","TEAMVIEWER_CONNECTION","RETRIEVE_AGENT_LOGS","SCHEDULED_TASK","CONDITION_WINDOWS_EVENT_LOG_TRIGGERED","CONDITION_WINDOWS_SERVICE_STATE_CHANGED","UI_MESSAGE_ACTION_REBOOT","UI_MESSAGE_BD_INSTALLATION_ISSUES","GRAVITYZONE_UI_MESSAGE_INSTALLATION_ISSUES","AV_QUARANTINE_THREAT","AV_RESTORE_THREAT","AV_DELETE_THREAT","AV_REMOVE_THREAT","BITDEFENDER_RESTORE_THREAT","BITDEFENDER_DELETE_THREAT","CONDITION_BITLOCKER_STATUS","CONDITION_FILEVAULT_STATUS","CONDITION_LINUX_PROCESS","CONDITION_LINUX_Daemon","CONDITION_LINUX_PROCESS_RESOURCE","CONDITION_LINUX_PROCESS_RESOURCE_CPU","CONDITION_LINUX_PROCESS_RESOURCE_MEMORY","CONDITION_LINUX_DISK_FREE_SPACE","CONDITION_LINUX_DISK_USAGE","CONDITION_VM_AGGREGATE_CPU_USAGE","CONDITION_VM_DISK_USAGE","CONDITION_VM_HOST_DATASTORE","CONDITION_VM_HOST_UPTIME","CONDITION_VM_HOST_DEVICE_DOWN","CONDITION_VM_HOST_BAD_SENSORS","CONDITION_VM_HOST_SENSOR_HEALTH","CONDITION_VM_GUEST_GUEST_OPERATIONAL_MODE","CONDITION_VM_GUEST_SNAPSHOT_SIZE","CONDITION_VM_GUEST_SNAPSHOT_LIFESPAN","CONDITION_VM_GUEST_TOOLS_NOT_RUNNING","CONDITION_HV_GUEST_CHECKPOINT_SIZE","CONDITION_HV_GUEST_CHECKPOINT_LIFESPAN","CONDITION_SOFTWARE","CONDITION_WINDOWS_PROCESS_STATE","CONDITION_WINDOWS_PROCESS_RESOURCE_CPU","CONDITION_WINDOWS_PROCESS_RESOURCE_MEMORY","CONDITION_MAC_PROCESS_STATE","CONDITION_MAC_PROCESS_RESOURCE_CPU","CONDITION_MAC_PROCESS_RESOURCE_MEMORY","CONDITION_MAC_DEAMON","CONDITION_CUSTOM_FIELD","CONDITION_PENDING_REBOOT","CONDITION_LOCKHART_LAST_SUCCESSFUL_BACKUP"]},"sourceConfigUid":{"type":"string","description":"Source configuration/policy element reference","format":"uuid"},"sourceName":{"type":"string","description":"Source configuration/policy element name"},"subject":{"type":"string","description":"Alert subject"},"userId":{"type":"integer","description":"User identifier","format":"int32"},"psaTicketId":{"type":"object","description":"Related PSA ticket ID"},"ticketTemplateId":{"type":"integer","description":"PSA ticket template","format":"int32"},"data":{"type":"object","additionalProperties":true,"description":"Alert data"},"device":{"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"}},"description":"Device information."},"priority":{"type":"string"},"severity":{"type":"string"},"conditionName":{"type":"string"},"conditionHealthStatus":{"type":"string","enum":["UNKNOWN","HEALTHY","NEEDS_ATTENTION","UNHEALTHY"]},"useGlobalHealthStatus":{"type":"boolean"}}}}}}}}}},"/v2/device/{id}/disks":{"get":{"tags":["devices"],"summary":"Device disk drives","description":"Returns device disks' details","operationId":"getDeviceDiskDrives","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"bytesPerSector":{"type":"integer","description":"Number of bytes per sector","format":"int32"},"description":{"type":"string","description":"Description"},"interfaceType":{"type":"string","description":"Interface type"},"manufacturer":{"type":"string","description":"Manufacturer"},"mediaType":{"type":"string","description":"Media Type"},"model":{"type":"string","description":"Model"},"name":{"type":"string","description":"Name"},"partitionCount":{"type":"integer","description":"Number of partitions","format":"int32"},"serialNumber":{"type":"string","description":"Serial number"},"size":{"type":"integer","description":"Size (Bytes)","format":"int64"},"smartCapable":{"type":"boolean","description":"Is S.M.A.R.T. capable?"},"status":{"type":"string","description":"Status"}}}}}}}}}},"/v2/device/{id}/geolocation/history":{"get":{"tags":["Geolocation"],"summary":"Device geolocation history","description":"Returns paginated geolocation history for a mobile device. Defaults to the last 7 days; the time window cannot exceed 7 days.","operationId":"getDeviceGeolocationHistory","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"after","in":"query","description":"Include records on or after this timestamp (epoch seconds). Defaults to 7 days ago.","schema":{"type":"number","format":"double"}},{"name":"before","in":"query","description":"Include records on or before this timestamp (epoch seconds). Defaults to now.","schema":{"type":"number","format":"double"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"maximum":500,"minimum":10,"type":"integer","format":"int32","default":100}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}}],"responses":{"200":{"description":"Geolocation history","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","description":"Geolocation records","items":{"type":"object","properties":{"latitude":{"type":"number","description":"Device latitude","format":"double","example":28.260770164828532},"longitude":{"type":"number","description":"Device longitude","format":"double","example":-82.18508102335356},"timestamp":{"type":"number","description":"Location timestamp, epoch seconds with millisecond precision","format":"double","example":1778938364.507}},"description":"Geolocation records"}},"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}}}}}}},"400":{"description":"Invalid parameters or cursor"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Device not found or not a mobile device"},"429":{"description":"Rate limit exceeded"}}}},"/v2/device/{id}/os-patch-installs":{"get":{"tags":["devices"],"summary":"OS Patch installation report for device","description":"Returns patch installation history records (successful and failed) for device","operationId":"getDeviceInstalledOSPatches","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"status","in":"query","description":"Patch Status filter (FAILED, INSTALLED)","schema":{"type":"string"}},{"name":"installedBefore","in":"query","description":"Include patches installed before specified date","schema":{"type":"string"}},{"name":"installedAfter","in":"query","description":"Include patches installed after specified date","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Name"},"severity":{"type":"string","description":"Severity"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Patch release date","format":"double"},"version":{"type":"string","description":"Patch version"},"os":{"type":"string","description":"Operating system family the patch applies to","enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"rebootRequired":{"type":"string","description":"Whether installing the patch requires a reboot","enum":["YES","NO","MAYBE"]},"installErrors":{"type":"array","description":"Install failure details; empty when the patch installed successfully","items":{"type":"object","properties":{"symbolicName":{"type":"string","description":"Vendor/OS-reported error's symbolic name, null if unknown"},"code":{"type":"string","description":"Vendor/OS-reported error code, null if unknown"},"message":{"type":"string","description":"Vendor/OS-reported error message, null if unknown"}},"description":"Install failure details; empty array when installed successfully or not applicable"}},"kbNumber":{"type":"string","description":"KB Number"}}}}}}}}}},"/v2/device/{id}/software-patch-installs":{"get":{"tags":["devices"],"summary":"Software Patch history for device","description":"Returns 3rd party software patch installation history records for device (successful and failed)","operationId":"getDeviceInstalledSoftwarePatches","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"type","in":"query","description":"Patch Type filter","schema":{"type":"string"}},{"name":"impact","in":"query","description":"Patch Impact filter","schema":{"type":"string"}},{"name":"status","in":"query","description":"Patch Status filter","schema":{"type":"string"}},{"name":"productIdentifier","in":"query","description":"Product Identifier","schema":{"type":"string"}},{"name":"installedBefore","in":"query","description":"Include patches installed before specified date","schema":{"type":"string"}},{"name":"installedAfter","in":"query","description":"Include patches installed after specified date","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"productIdentifier":{"type":"string","description":"Software product identifier","format":"uuid"},"title":{"type":"string","description":"Patch title"},"impact":{"type":"string","description":"Impact"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Patch type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Vendor's published release date, null if unknown","format":"double","nullable":true},"version":{"type":"string","description":"Vendor's own version string, null if not available","nullable":true},"architecture":{"type":"string","description":"Patch architecture, null if unknown","nullable":true,"enum":["X86","X64","ARM64","UNIVERSAL"]},"os":{"type":"string","description":"Operating system family, null if unknown","nullable":true,"enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"vendor":{"type":"string","description":"Vendor name, null if not available","nullable":true},"rebootRequired":{"type":"string","description":"Whether a reboot is required after installation, null if unknown","nullable":true,"enum":["YES","NO","MAYBE"]},"installErrors":{"type":"array","description":"Install failure details; empty array when installed successfully or not applicable","items":{"type":"object","properties":{"symbolicName":{"type":"string","description":"Vendor/OS-reported error's symbolic name, null if unknown"},"code":{"type":"string","description":"Vendor/OS-reported error code, null if unknown"},"message":{"type":"string","description":"Vendor/OS-reported error message, null if unknown"}},"description":"Install failure details; empty array when installed successfully or not applicable"}}}}}}}}}}},"/v2/device/{id}/last-logged-on-user":{"get":{"tags":["devices"],"summary":"Last logged-on user information","description":"Returns username that was last to login to device","operationId":"getDeviceLastLoggedOnUser","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"userName":{"type":"string","description":"User name"},"logonTime":{"type":"number","description":"Time of logon","format":"double"}}}}}}},"security":[{"oauth2":["monitoring"]}]}},"/v2/device/{id}/dashboard-url":{"get":{"tags":["management"],"summary":"Device link","description":"Returns link to device","operationId":"getDeviceLink","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"redirect","in":"query","description":"Return redirect response","schema":{"type":"boolean"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"URL"},"expires":{"type":"number","description":"Link expiration time","format":"double"}}}}}}}}},"/v2/device/{id}/network-interfaces":{"get":{"tags":["devices"],"summary":"Device network interfaces","description":"Returns device network interfaces' details","operationId":"getDeviceNetworkInterfaces","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"adapterName":{"type":"string","description":"Adapter Name"},"defaultGateway":{"type":"string","description":"Default Gateway"},"interfaceType":{"type":"string","description":"Interface Type"},"dnsHostName":{"type":"string","description":"DNS HostName"},"dnsServers":{"type":"string","description":"DNS Servers"},"interfaceIndex":{"type":"string","description":"Interface Index"},"interfaceName":{"type":"string","description":"Interface Name"},"ipAddress":{"type":"array","description":"IP Address","items":{"type":"string","description":"IP Address"}},"linkSpeed":{"type":"string","description":"Link Speed"},"macAddress":{"type":"array","description":"MAC Address","items":{"type":"string","description":"MAC Address"}},"mtu":{"type":"string","description":"MTU"},"status":{"type":"string","description":"Status"},"subnetMask":{"type":"string","description":"Subnet Mask"}}}}}}}}}},"/v2/device/{id}/os-patches":{"get":{"tags":["devices"],"summary":"OS Patches","description":"Returns list of pending/rejected/approved OS patches for device","operationId":"getDevicePendingFailedRejectedOSPatches","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"status","in":"query","description":"Patch Status filter","schema":{"type":"string"}},{"name":"type","in":"query","description":"Patch Type filter","schema":{"type":"string"}},{"name":"severity","in":"query","description":"Patch Severity filter","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Name"},"severity":{"type":"string","description":"Severity"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Patch release date","format":"double"},"version":{"type":"string","description":"Patch version"},"os":{"type":"string","description":"Operating system family the patch applies to","enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"rebootRequired":{"type":"string","description":"Whether installing the patch requires a reboot","enum":["YES","NO","MAYBE"]},"kbNumber":{"type":"string","description":"KB Number"}}}}}}}}}},"/v2/device/{id}/software-patches":{"get":{"tags":["devices"],"summary":"Pending, Failed and Rejected Software patches for device","description":"Returns list of 3rd party Software patches for a device (for which there were no installation attempts)","operationId":"getDevicePendingFailedRejectedSoftwarePatches","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"status","in":"query","description":"Patch Status filter","schema":{"type":"string"}},{"name":"productIdentifier","in":"query","description":"Product Identifier","schema":{"type":"string"}},{"name":"type","in":"query","description":"Patch Type filter","schema":{"type":"string"}},{"name":"impact","in":"query","description":"Patch Impact filter","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"productIdentifier":{"type":"string","description":"Software product identifier","format":"uuid"},"title":{"type":"string","description":"Patch title"},"impact":{"type":"string","description":"Impact"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Patch type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Vendor's published release date, null if unknown","format":"double","nullable":true},"version":{"type":"string","description":"Vendor's own version string, null if not available","nullable":true},"architecture":{"type":"string","description":"Patch architecture, null if unknown","nullable":true,"enum":["X86","X64","ARM64","UNIVERSAL"]},"os":{"type":"string","description":"Operating system family, null if unknown","nullable":true,"enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"vendor":{"type":"string","description":"Vendor name, null if not available","nullable":true},"rebootRequired":{"type":"string","description":"Whether a reboot is required after installation, null if unknown","nullable":true,"enum":["YES","NO","MAYBE"]}}}}}}}}}},"/v2/device/{id}/processors":{"get":{"tags":["devices"],"summary":"Device processors","description":"Returns list of device Processor details","operationId":"getDeviceProcessors","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"architecture":{"type":"string","description":"Architecture"},"maxClockSpeed":{"type":"integer","description":"Max Clock Speed","format":"int64"},"clockSpeed":{"type":"integer","description":"Current Clock Speed","format":"int64"},"name":{"type":"string","description":"Name"},"numCores":{"type":"integer","description":"Number of Cores","format":"int32"},"numLogicalCores":{"type":"integer","description":"Number of Logical Cores]","format":"int32"}},"description":"Processors"}}}}}}}},"/v2/device/{id}/windows-services":{"get":{"tags":["devices"],"summary":"Windows services","description":"Returns list of Windows Services and their statuses","operationId":"getDeviceServices","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"name","in":"query","description":"Service name","schema":{"type":"string"}},{"name":"state","in":"query","description":"Service state","schema":{"type":"string","enum":["UNKNOWN","STOPPED","START_PENDING","RUNNING","STOP_PENDING","PAUSE_PENDING","PAUSED","CONTINUE_PENDING"]}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"displayName":{"type":"string","description":"Display Name"},"description":{"type":"string","description":"Description"},"startType":{"type":"string","description":"Start Type","enum":["AUTO_START","AUTO_START_DELAYED","BOOT_START","DEMAND_START","DISABLED","SYSTEM_START"]},"userName":{"type":"string","description":"User Name"},"state":{"type":"string","description":"State","enum":["UNKNOWN","STOPPED","START_PENDING","RUNNING","STOP_PENDING","PAUSE_PENDING","PAUSED","CONTINUE_PENDING"]}}}}}}}}}},"/v2/device/{id}/software":{"get":{"tags":["devices"],"summary":"Device software inventory","description":"Returns list of software installed on device","operationId":"getDeviceSoftware","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"installDate":{"type":"string","description":"Installation Date","format":"date-time"},"location":{"type":"string","description":"Location"},"name":{"type":"string","description":"Product Name"},"publisher":{"type":"string","description":"Publisher"},"size":{"type":"integer","description":"Size on disk","format":"int64"},"version":{"type":"string","description":"Version"},"productCode":{"type":"string","description":"Product Code"},"isSystemComponent":{"type":"boolean","description":"Is System Component"}}}}}}}}}},"/v2/device/{id}/volumes":{"get":{"tags":["devices"],"summary":"Device storage volumes","description":"Returns device volumes' details","operationId":"getDeviceVolumes","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"include","in":"query","description":"Additional information to include (bl - BitLocker status)","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"driveLetter":{"type":"string","description":"Drive Letter"},"label":{"type":"string","description":"Volume Label"},"deviceType":{"type":"string","description":"Device Type"},"fileSystem":{"type":"string","description":"File System Type"},"autoMount":{"type":"boolean","description":"Automatically Mounted"},"compressed":{"type":"boolean","description":"Compressed"},"capacity":{"type":"integer","description":"Capacity (bytes)","format":"int64"},"freeSpace":{"type":"integer","description":"Free Space (bytes)","format":"int64"},"serialNumber":{"type":"string","description":"Serial Number"},"bitLockerStatus":{"type":"object","properties":{"conversionStatus":{"type":"string","description":"Volume encryption or decryption status.","enum":["FULLY_DECRYPTED","FULLY_ENCRYPTED","ENCRYPTION_IN_PROGRESS","DECRYPTION_IN_PROGRESS","ENCRYPTION_PAUSED","DECRYPTION_PAUSED","UNKNOWN"]},"encryptionMethod":{"type":"string","description":"Indicated the encryption algorithm and key size used on the volume","enum":["NONE","AES_128_WITH_DIFFUSER","AES_256_WITH_DIFFUSER","AES_128","AES_256","HARDWARE_ENCRYPTION","XTS_AES_128","XTS_AES_256","UNKNOWN"]},"protectionStatus":{"type":"string","description":" indicates whether the volume and its encryption key (if any) are secured.","enum":["UNPROTECTED","PROTECTED","UNKNOWN","PENDING"]},"lockStatus":{"type":"string","description":"Indicates whether the contents of the volume are accessible from Windows","enum":["UNKNOWN","UNLOCKED","LOCKED"]},"initializedForProtection":{"type":"boolean","description":"Is initialized for protection"}},"description":"BitLocker Status"}},"description":"Disk Volumes"}}}}}}}},"/v2/device/{id}/custom-fields":{"get":{"tags":["devices"],"summary":"Device custom fields","description":"Returns list of device custom fields","operationId":"getNodeCustomFields","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"withInheritance","in":"query","description":"Retrieve values using definition scope hierarchy","schema":{"type":"boolean"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}}}},"patch":{"tags":["devices"],"summary":"Update Field Values","description":"Update device custom field values.\n\n**Note:** setting or clearing TEXT_ENCRYPTED and TOTP fields requires an authorization_code access token from a signed-in user. With client_credentials tokens, a masked value sent back as read keeps the stored value, and any other value receives 403.","operationId":"updateNodeAttributeValues","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Custom fields values. See the [**documentation**](/apidocs-beta/core-resources/articles/customFields/customFieldsValues/custom-fields-values) for more information.","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example using a single custom field":{"description":"Example using a single custom field","value":{"customFieldNameInteger":1}},"Example using multiple custom fields":{"description":"Example using multiple custom fields","value":{"customFieldNameInteger":1,"customFieldNameText":"Sample Text","customFieldNameClientLocation":{"entityIds":[1,2],"type":"CLIENT_LOCATION"}}}}}}},"responses":{"204":{"description":"No Content"}}}},"/v2/device/{id}/policy/overrides":{"get":{"tags":["devices"],"summary":"Get summary of device policy overrides","description":"Returns list of overridden policy sections","operationId":"getPolicyOverrides","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"overrides":{"type":"array","description":"List of policy sections","items":{"type":"string","description":"List of policy sections"}}}}}}}}},"delete":{"tags":["management"],"summary":"Reset device policy overrides","description":"Submit request to remove device policy overrides","operationId":"resetPolicyOverrides","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{}}}}}},"/v2/device/{id}/reboot/{mode}":{"post":{"tags":["management"],"summary":"Reboot device","description":"Sends a command to restart the computer","operationId":"rebootDevices","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"mode","in":"path","description":"Reboot mode","required":true,"schema":{"type":"string","enum":["NORMAL","FORCED"]}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"reason":{"type":"string","description":"Stated reboot reason"}}}}}},"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/v2/device/{id}/owner":{"delete":{"tags":["management"],"summary":"Remove device owner","description":"Removes the owner of the device.","operationId":"removeDeviceOwner","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}},"security":[{"oauth2":["management"]}]}},"/v2/device/{id}/scripting/options":{"get":{"tags":["management"],"summary":"Device scripting options","description":"Returns scripting options (built-in actions, custom scripts) available for device","operationId":"requestScriptingOptions","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"lang","in":"query","description":"Language","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"internal":{"type":"boolean"}}}},"scripts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of script/action","enum":["ACTION","SCRIPT"]},"id":{"type":"integer","description":"Custom script identifier (Scripts)","format":"int32"},"uid":{"type":"string","description":"Built-in action identifier (Actions)","format":"uuid"},"name":{"type":"string","description":"Name"},"language":{"type":"string","description":"Script language"},"description":{"type":"string","description":"Description"},"architecture":{"uniqueItems":true,"type":"array","description":"Applicable architectures","items":{"type":"string","description":"Applicable architectures"}},"categoryId":{"type":"integer","description":"Script Category identifier","format":"int32"}}}},"credentials":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"string"}},"credentials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"type":{"type":"string","enum":["SNMPV12C","SNMPV3","TELNET_SSH","NETWORK_LOCATION","ENCRYPTION_KEY","BASIC","SNMPV1","SNMPV2"]}}}}}}}}}}}}}},"/v2/device/{id}/script/run":{"post":{"tags":["management"],"summary":"Run script or built-in action","description":"Run script or built-in action on a device","operationId":"runScriptOnDevice","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Type","enum":["ACTION","SCRIPT"]},"id":{"type":"integer","description":"Script identifier","format":"int32"},"uid":{"type":"string","description":"Built-in action identifier","format":"uuid"},"parameters":{"type":"string","description":"Action/Script parameters"},"runAs":{"type":"string","description":"Credential role/identifier"}}}}}},"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/v2/device/{id}/owner/{ownerUid}":{"post":{"tags":["management"],"summary":"Set device owner","description":"Sets the owner of the device.","operationId":"setDeviceOwner","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"ownerUid","in":"path","description":"Device owner identifier","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"default":{"description":"default response","content":{"*/*":{}}}},"security":[{"oauth2":["management"]}]}},"/v2/device/{id}/windows-service/{serviceId}/configure":{"post":{"tags":["management"],"summary":"Modify Windows Service configuration","description":"Configures Windows Service startup settings","operationId":"setWindowsServiceConfiguration","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"serviceId","in":"path","description":"Service identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"startType":{"type":"string","description":"Start Type","enum":["AUTO_START","AUTO_START_DELAYED","BOOT_START","DEMAND_START","DISABLED","SYSTEM_START"]},"userName":{"type":"string","description":"Username"}}}}}},"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/v2/device/{id}/patch/os/apply":{"post":{"tags":["management"],"summary":"Run OS patch apply","description":"Submit a job to start a device OS patch apply","operationId":"submitOSPatchApply","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Device is not applicable for os apply."}}}},"/v2/device/{id}/patch/os/scan":{"post":{"tags":["management"],"summary":"Run OS patch scan","description":"Submit a job to start a device OS patch scan","operationId":"submitOSPatchScan","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Device is not applicable for os scan."}}}},"/v2/device/{id}/patch/software/apply":{"post":{"tags":["management"],"summary":"Run Software patch apply","description":"Submit a job to start a device software patch apply","operationId":"submitSoftwarePatchApply","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Device is not applicable for software apply."}}}},"/v2/device/{id}/patch/software/scan":{"post":{"tags":["management"],"summary":"Run Software patch scan","description":"Submit a job to start a device software patch scan","operationId":"submitSoftwarePatchScan","parameters":[{"name":"id","in":"path","description":"Device identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Device is not applicable for software scan."}}}},"/v2/group/{id}/device-ids":{"get":{"tags":["groups"],"summary":"Group members","description":"Returns list of device identifiers that match group criteria","operationId":"getGroupDeviceIds","parameters":[{"name":"id","in":"path","description":"Group identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int32"}}}}}}}},"/v2/organization/{id}/locations":{"get":{"tags":["organization"],"summary":"Organization locations","description":"Returns list of locations for organization","operationId":"getOrganizationLocations","parameters":[{"name":"id","in":"path","description":"Organization identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"}}}}}}},"post":{"tags":["management"],"summary":"Add new location to organization","description":"Creates new location for organization","operationId":"createLocationForOrganization","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"}}}}}}},"/v2/organization/{id}/end-users":{"get":{"tags":["organization"],"summary":"List users","description":"Returns list of end-users for organization","operationId":"getEndUsers","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"includeRoles","in":"query","description":"Includes user role information","schema":{"type":"boolean","default":false}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"}}}}}}}},"/v2/organization/generate-installer":{"post":{"tags":["management"],"summary":"Generate installer","description":"Generates and returns URL for installer with specified settings","operationId":"getInstaller","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"installerType":{"type":"string","description":"Agent installer type","enum":["WINDOWS_MSI","WINDOWS_ARM64_MSI","MAC_DMG","MAC_PKG","LINUX_DEB","LINUX_RPM","LINUX_ARM64_DEB","LINUX_ARMV7A_DEB","LINUX_ARM64_RPM","LINUX_ARMV7A_RPM"]},"usageLimit":{"type":"integer","description":"Usage limit","format":"int32","readOnly":true},"content":{"type":"object","properties":{"nodeRoleId":{"type":"string","description":"Identifier for the nodeRole target of this installer. Acceptable values include integers, 'auto', or an empty string. If the value is omitted, or an empty string, it defaults to 'auto'.","default":"auto"}},"description":"content"}}},"examples":{"example with nodeRole param auto":{"description":"example with nodeRole param auto","value":{"organizationId":1,"locationId":1,"installerType":"WINDOWS_MSI","content":{"nodeRoleId":"auto"}}},"example with nodeRole param integer":{"description":"example with nodeRole param integer","value":{"organizationId":1,"locationId":1,"installerType":"WINDOWS_MSI","content":{"nodeRoleId":"201"}}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"URL"}}}}}}}}},"/v2/organization/{id}/location/{location_id}/installer/{installer_type}":{"get":{"tags":["management"],"summary":"Generate installer","description":"Generates and returns URL for installer for specified organization/location","operationId":"getInstallerForLocation","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"location_id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"installer_type","in":"path","required":true,"schema":{"type":"string","enum":["WINDOWS_MSI","WINDOWS_ARM64_MSI","MAC_DMG","MAC_PKG","LINUX_DEB","LINUX_RPM","LINUX_ARM64_DEB","LINUX_ARMV7A_DEB","LINUX_ARM64_RPM","LINUX_ARMV7A_RPM"]}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"URL"}}}}}}}}},"/v2/organization/{id}/locations/{locationId}/backup/usage":{"get":{"tags":["organization"],"summary":"Organization location backup usage","description":"Returns a location backup usage","operationId":"getLocationUsage","parameters":[{"name":"id","in":"path","description":"Organization identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"locationId","in":"path","description":"Location identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns a location backup usage","content":{"application/json":{"schema":{"type":"object","properties":{"locationId":{"type":"integer","description":"Device location id","format":"int32"},"locationName":{"type":"string","description":"Device location name"},"locationDescription":{"type":"string","description":"Device location description"},"revisionsCurrentSize":{"type":"integer","format":"int64"},"revisionsPreviousSize":{"type":"integer","format":"int64"},"revisionsDeletedSize":{"type":"integer","format":"int64"},"localFileFolderSize":{"type":"integer","format":"int64"},"localImageSize":{"type":"integer","format":"int64"},"localImageV2Size":{"type":"integer","format":"int64"},"cloudFileFolderSize":{"type":"integer","format":"int64"},"cloudImageSize":{"type":"integer","format":"int64"},"cloudImageV2Size":{"type":"integer","format":"int64"},"cloudNetworkShareSize":{"type":"integer","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","format":"double"},"lastFailedBackupJob":{"type":"number","format":"double"},"organizationId":{"type":"integer","format":"int32"},"organizationName":{"type":"string"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}}}}}}}}},"/v2/organization/{id}/custom-fields":{"get":{"tags":["organization"],"summary":"Organization custom fields","description":"Returns list of organization custom fields","operationId":"getNodeCustomFields_1","parameters":[{"name":"id","in":"path","description":"Organization identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}}}},"patch":{"tags":["organization"],"summary":"Update Field Values","description":"Update organization custom field values.\n\n**Note:** setting or clearing TEXT_ENCRYPTED and TOTP fields requires an authorization_code access token from a signed-in user. With client_credentials tokens, a masked value sent back as read keeps the stored value, and any other value receives 403.","operationId":"updateNodeAttributeValues_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Custom fields values. See the [**documentation**](/apidocs-beta/core-resources/articles/customFields/customFieldsValues/custom-fields-values) for more information.","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example using a single custom field":{"description":"Example using a single custom field","value":{"customFieldNameInteger":1}},"Example using multiple custom fields":{"description":"Example using multiple custom fields","value":{"customFieldNameInteger":1,"customFieldNameText":"Sample Text","customFieldNameClientLocation":{"entityIds":[1,2],"type":"CLIENT_LOCATION"}}}}}}},"responses":{"204":{"description":"No Content"}}}},"/v2/organization/{id}/location/{locationId}/custom-fields":{"get":{"tags":["Location"],"summary":"Location custom fields","description":"Returns list of location custom fields","operationId":"getNodeCustomFields_2","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"locationId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"withInheritance","in":"query","description":"Retrieve values using definition scope hierarchy","schema":{"type":"boolean"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}}}},"patch":{"tags":["Location"],"summary":"Update Field Values","description":"Update location custom field values.\n\n**Note:** setting or clearing TEXT_ENCRYPTED and TOTP fields requires an authorization_code access token from a signed-in user. With client_credentials tokens, a masked value sent back as read keeps the stored value, and any other value receives 403.","operationId":"updateNodeAttributeValues_2","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"locationId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Custom fields values. See the [**documentation**](/apidocs-beta/core-resources/articles/customFields/customFieldsValues/custom-fields-values) for more information.","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example using a single custom field":{"description":"Example using a single custom field","value":{"customFieldNameInteger":1}},"Example using multiple custom fields":{"description":"Example using multiple custom fields","value":{"customFieldNameInteger":1,"customFieldNameText":"Sample Text","customFieldNameClientLocation":{"entityIds":[1,2],"type":"CLIENT_LOCATION"}}}}}}},"responses":{"204":{"description":"No Content"}}}},"/v2/organization/{id}":{"get":{"tags":["organization"],"summary":"Organization information","description":"Returns organization details (policy mappings, locations)","operationId":"getOrganization","parameters":[{"name":"id","in":"path","description":"Organization identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"},"locations":{"type":"array","description":"List of locations","items":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"}},"policies":{"type":"array","description":"Node role policy assignments","items":{"type":"object","properties":{"nodeRoleId":{"type":"integer","description":"Node Role Identifier","format":"int32"},"policyId":{"type":"integer","description":"Policy Identifier","format":"int32"}},"description":"Node role policy assignments"}},"settings":{"type":"object","properties":{"trayicon":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"splashtop":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"teamviewer":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"backup":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"psa":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"}},"description":"Organization settings"}}}}}}}},"patch":{"tags":["management"],"summary":"Update organization","description":"Change organization name, description and policy mappings","operationId":"updateOrganization","parameters":[{"name":"id","in":"path","description":"Organization identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]}}}}}},"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/v2/organization/{id}/devices":{"get":{"tags":["organization"],"summary":"Organization devices","description":"Returns list of devices for organization","operationId":"getOrganizationDevices","parameters":[{"name":"id","in":"path","description":"Organization identifier","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"pageSize","in":"query","description":"Limit number of devices to return","schema":{"type":"integer","format":"int32"}},{"name":"after","in":"query","description":"Last Node ID from previous page","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"}},"description":"Device information."}}}}}}}},"/v2/organization/{id}/locations/backup/usage":{"get":{"tags":["organization"],"summary":"Organization locations backup usage","description":"Returns a list of locations backup usage","operationId":"getOrganizationLocationUsage","parameters":[{"name":"id","in":"path","description":"Organization identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns list of locations backup usage","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"locationId":{"type":"integer","description":"Device location id","format":"int32"},"locationName":{"type":"string","description":"Device location name"},"locationDescription":{"type":"string","description":"Device location description"},"revisionsCurrentSize":{"type":"integer","format":"int64"},"revisionsPreviousSize":{"type":"integer","format":"int64"},"revisionsDeletedSize":{"type":"integer","format":"int64"},"localFileFolderSize":{"type":"integer","format":"int64"},"localImageSize":{"type":"integer","format":"int64"},"localImageV2Size":{"type":"integer","format":"int64"},"cloudFileFolderSize":{"type":"integer","format":"int64"},"cloudImageSize":{"type":"integer","format":"int64"},"cloudImageV2Size":{"type":"integer","format":"int64"},"cloudNetworkShareSize":{"type":"integer","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","format":"double"},"lastFailedBackupJob":{"type":"number","format":"double"},"organizationId":{"type":"integer","format":"int32"},"organizationName":{"type":"string"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}}}}}}}}}},"/v2/organization/{id}/locations/{locationId}":{"patch":{"tags":["management"],"summary":"Update location","description":"Change location name, address, description, custom data","operationId":"updateLocation","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"locationId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"}}}}}}},"/v2/organization/{id}/policies":{"put":{"tags":["management"],"summary":"Change organization policy mappings","description":"Update policy assignment for node role(s). Returns list of affected device IDs","operationId":"updateNodeRolePolicyAssignmentForOrganization","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"nodeRoleId":{"type":"integer","description":"Node Role Identifier","format":"int32"},"policyId":{"type":"integer","description":"Policy Identifier","format":"int32"}},"description":"Node role policy assignments"}}}}},"responses":{"default":{"description":"default response","content":{"*/*":{"schema":{"type":"array","items":{"type":"integer","format":"int32"}}}}}}}},"/v2/queries/antivirus-status":{"get":{"tags":["queries"],"summary":"Antivirus status report","description":"Returns list of statues of antivirus software installed on devices","operationId":"getAntivirusStatusReport","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"ts","in":"query","description":"Monitoring timestamp filter","schema":{"type":"string"}},{"name":"productState","in":"query","description":"Product State filter","schema":{"type":"string"}},{"name":"productName","in":"query","description":"Product Name filter","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"productName":{"type":"string","description":"Product name"},"productState":{"type":"string","description":"Product state"},"definitionStatus":{"type":"string","description":"Definition Status"},"version":{"type":"string","description":"Product Version"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}}}}}}}},"/v2/queries/antivirus-threats":{"get":{"tags":["queries"],"summary":"Antivirus threats report","description":"Returns list of antivirus threats","operationId":"getAntivirusThreats","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"ts","in":"query","description":"Monitoring timestamp filter","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Threat name"},"productCode":{"type":"string","description":"AntiVirus vendor product code"},"quarantineId":{"type":"string","description":"Threat Quarantine ID"},"status":{"type":"string","description":"Threat Status (vendor specific)"},"type":{"type":"string","description":"Type of Threat"},"threatId":{"type":"integer","description":"Threat ID","format":"int64"},"category":{"type":"string","description":"Threat Category"},"level":{"type":"string","description":"Threat Level"},"detectionSource":{"type":"string","description":"Detection source"},"traceList":{"type":"string","description":"Trace list (Files, Cookies, etc. Vendor specific)"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}}}}}}}},"/v2/queries/computer-systems":{"get":{"tags":["queries"],"summary":"Computer systems report","description":"Returns computer systems information for devices","operationId":"getComputerSystems","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"ts","in":"query","description":"Monitoring timestamp filter","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"manufacturer":{"type":"string","description":"Manufacturer"},"model":{"type":"string","description":"Model"},"biosSerialNumber":{"type":"string","description":"Bios Serial Number"},"serialNumber":{"type":"string","description":"Serial Number"},"assetSerialNumber":{"type":"string","description":"Asset Serial Number"},"domain":{"type":"string"},"domainRole":{"type":"string"},"numberOfProcessors":{"type":"integer","format":"int32"},"totalPhysicalMemory":{"type":"integer","format":"int64"},"virtualMachine":{"type":"boolean"},"chassisType":{"type":"string"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}}}}}}}},"/v2/queries/custom-fields-detailed":{"get":{"tags":["queries"],"summary":"Custom fields detailed report","description":"Returns Custom Fields report with additional information about each field","operationId":"getCustomFieldsDetailedReport","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"maximum":10000,"minimum":10,"type":"integer","format":"int32","default":1000}},{"name":"updatedAfter","in":"query","description":"Custom fields updated after specified date","schema":{"type":"string"}},{"name":"fields","in":"query","description":"Comma-separated list of fields","schema":{"type":"string"}},{"name":"showSecureValues","in":"query","description":"Flag to indicate if secure values should be returned as plain text without encryption","schema":{"type":"boolean"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"deviceId":{"type":"integer","description":"Entity identifier","format":"int32","writeOnly":true},"entityType":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]},"fields":{"type":"array","description":"Field values","items":{"type":"object","properties":{"name":{"type":"string","description":"Field name"},"value":{"type":"object","description":"Field Value"},"updated":{"type":"number","description":"Last field update timestamp","format":"double","writeOnly":true},"updatedBy":{"type":"object","properties":{"source":{"type":"string","enum":["API","USER","SCRIPT","SYSTEM"]},"user":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"email":{"type":"string"}}}},"description":"Value source (who/what updated the value)"},"updateTime":{"type":"number","format":"double"}},"description":"Field values"}},"entityId":{"type":"integer","format":"int32"}}}}}}}}}}}},"/v2/queries/custom-fields":{"get":{"tags":["queries"],"summary":"Custom fields report","description":"Returns Custom Fields report","operationId":"getCustomFieldsReport","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"maximum":10000,"minimum":10,"type":"integer","format":"int32","default":1000}},{"name":"updatedAfter","in":"query","description":"Custom fields updated after specified date","schema":{"type":"string"}},{"name":"fields","in":"query","description":"Comma-separated list of fields","schema":{"type":"string"}},{"name":"showSecureValues","in":"query","description":"Flag to indicate if secure values should be returned as plain text without encryption","schema":{"type":"boolean"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"fields":{"type":"object","additionalProperties":{"type":"object","description":"Field values"},"description":"Field values"}}}}}}}}}}}},"/v2/queries/device-health":{"get":{"tags":["queries"],"summary":"Device health report","description":"Returns list of device health summary records","operationId":"getDeviceHealthReport","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"health","in":"query","description":"Health status filter","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"activeThreatsCount":{"type":"integer","description":"Active AV threats count","format":"int32"},"quarantinedThreatsCount":{"type":"integer","description":"Quarantined AV threats count","format":"int32"},"blockedThreatsCount":{"type":"integer","description":"Blocked AV threats count","format":"int32"},"failedOSPatchesCount":{"type":"integer","description":"Number of failed OS patches","format":"int32"},"pendingOSPatchesCount":{"type":"integer","description":"Number of pending OS patches","format":"int32"},"alertCount":{"type":"integer","description":"Alerts count","format":"int32"},"activeJobCount":{"type":"integer","description":"Alerts job count","format":"int32"},"failedSoftwarePatchesCount":{"type":"integer","description":"Number of failed software patches","format":"int32"},"pendingSoftwarePatchesCount":{"type":"integer","description":"Number of pending software patches","format":"int32"},"pendingRebootReason":{"type":"string","description":"Pending reboot reasons"},"avInstallStatus":{"type":"string","description":"Antivirus installation status","enum":["REQUESTED","DOWNLOAD_STARTED","DOWNLOADED","DOWNLOAD_FAILED","INSTALL_STARTED","INSTALLED","INSTALL_FAILED","UNINSTALL_REQUESTED","UNINSTALL_FAILED","UNINSTALLED"]},"productsInstallationStatuses":{"type":"object","additionalProperties":{"type":"string","description":"Integrated products' installation statuses","enum":["REQUESTED","DOWNLOAD_STARTED","DOWNLOADED","DOWNLOAD_FAILED","INSTALL_STARTED","INSTALLED","INSTALL_FAILED","UNINSTALL_REQUESTED","UNINSTALL_FAILED","UNINSTALLED"]},"description":"Integrated products' installation statuses"},"offline":{"type":"boolean","description":"Is device offline?"},"parentDeviceId":{"type":"integer","description":"Parent device identifier","format":"int32"},"parentOffline":{"type":"boolean","description":"Is parent device offline"},"healthStatus":{"type":"string","description":"Health status","enum":["UNKNOWN","HEALTHY","NEEDS_ATTENTION","UNHEALTHY"]},"criticalVulnerabilityCount":{"type":"integer","description":"Critical Vulnerability Count","format":"int32"},"highVulnerabilityCount":{"type":"integer","description":"High Vulnerability Count","format":"int32"},"mediumVulnerabilityCount":{"type":"integer","description":"Medium Vulnerability Count","format":"int32"},"lowVulnerabilityCount":{"type":"integer","description":"Low Vulnerability Count","format":"int32"},"installationIssuesCount":{"type":"integer","format":"int32"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"}}}}}}}}}}}},"/v2/queries/backup/usage":{"get":{"tags":["queries"],"summary":"Device backup usage","description":"Returns the backup usage by device","operationId":"getDeviceUsage","parameters":[{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"type":"integer","format":"int32"}},{"name":"includeDeletedDevices","in":"query","description":"Whether or not include deleted devices","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Returns a device backup usage report","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"}},"description":"Device information."}}}}}}}}}},"/v2/queries/disks":{"get":{"tags":["queries"],"summary":"Disk drives report","description":"Returns list of physical disks","operationId":"getDiskDrives","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"ts","in":"query","description":"Monitoring timestamp filter","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"bytesPerSector":{"type":"integer","description":"Number of bytes per sector","format":"int32"},"description":{"type":"string","description":"Description"},"interfaceType":{"type":"string","description":"Interface type"},"manufacturer":{"type":"string","description":"Manufacturer"},"mediaType":{"type":"string","description":"Media Type"},"model":{"type":"string","description":"Model"},"name":{"type":"string","description":"Name"},"partitionCount":{"type":"integer","description":"Number of partitions","format":"int32"},"serialNumber":{"type":"string","description":"Serial number"},"size":{"type":"integer","description":"Size (Bytes)","format":"int64"},"smartCapable":{"type":"boolean","description":"Is S.M.A.R.T. capable?"},"status":{"type":"string","description":"Status"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}}}}}}}},"/v2/queries/os-patch-installs":{"get":{"tags":["queries"],"summary":"OS Patch installation report","description":"Returns patch installation history records (successful and failed)","operationId":"getInstalledOSPatches","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"status","in":"query","description":"Patch Status filter (FAILED, INSTALLED)","schema":{"type":"string"}},{"name":"installedBefore","in":"query","description":"Include patches installed before specified date","schema":{"type":"string"}},{"name":"installedAfter","in":"query","description":"Include patches installed after specified date","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Name"},"severity":{"type":"string","description":"Severity"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Patch release date","format":"double"},"version":{"type":"string","description":"Patch version"},"os":{"type":"string","description":"Operating system family the patch applies to","enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"rebootRequired":{"type":"string","description":"Whether installing the patch requires a reboot","enum":["YES","NO","MAYBE"]},"installErrors":{"type":"array","description":"Install failure details; empty when the patch installed successfully","items":{"type":"object","properties":{"symbolicName":{"type":"string","description":"Vendor/OS-reported error's symbolic name, null if unknown"},"code":{"type":"string","description":"Vendor/OS-reported error code, null if unknown"},"message":{"type":"string","description":"Vendor/OS-reported error message, null if unknown"}},"description":"Install failure details; empty array when installed successfully or not applicable"}},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"},"kbNumber":{"type":"string","description":"KB Number"}}}}}}}}}}}},"/v2/queries/software-patch-installs":{"get":{"tags":["queries"],"summary":"Software Patch history report","description":"Returns 3rd party software patch installation history records (successful and failed)","operationId":"getInstalledSoftwarePatches","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"type","in":"query","description":"Patch Type filter","schema":{"type":"string"}},{"name":"impact","in":"query","description":"Patch Impact filter","schema":{"type":"string"}},{"name":"status","in":"query","description":"Patch Status filter","schema":{"type":"string"}},{"name":"productIdentifier","in":"query","description":"Product Identifier","schema":{"type":"string"}},{"name":"installedBefore","in":"query","description":"Include patches installed before specified date","schema":{"type":"string"}},{"name":"installedAfter","in":"query","description":"Include patches installed after specified date","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"productIdentifier":{"type":"string","description":"Software product identifier","format":"uuid"},"title":{"type":"string","description":"Patch title"},"impact":{"type":"string","description":"Impact"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Patch type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Vendor's published release date, null if unknown","format":"double","nullable":true},"version":{"type":"string","description":"Vendor's own version string, null if not available","nullable":true},"architecture":{"type":"string","description":"Patch architecture, null if unknown","nullable":true,"enum":["X86","X64","ARM64","UNIVERSAL"]},"os":{"type":"string","description":"Operating system family, null if unknown","nullable":true,"enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"vendor":{"type":"string","description":"Vendor name, null if not available","nullable":true},"rebootRequired":{"type":"string","description":"Whether a reboot is required after installation, null if unknown","nullable":true,"enum":["YES","NO","MAYBE"]},"installErrors":{"type":"array","description":"Install failure details; empty array when installed successfully or not applicable","items":{"type":"object","properties":{"symbolicName":{"type":"string","description":"Vendor/OS-reported error's symbolic name, null if unknown"},"code":{"type":"string","description":"Vendor/OS-reported error code, null if unknown"},"message":{"type":"string","description":"Vendor/OS-reported error message, null if unknown"}},"description":"Install failure details; empty array when installed successfully or not applicable"}},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}}}}}}}},"/v2/queries/logged-on-users":{"get":{"tags":["queries"],"summary":"Last logged-on user report","description":"Returns usernames and logon times ","operationId":"getLastLoggedOnUsersReport","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"maximum":10000,"minimum":10,"type":"integer","format":"int32","default":1000}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"userName":{"type":"string","description":"User name"},"logonTime":{"type":"number","description":"Time of logon","format":"double"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"}}}}}}}}}}}},"/v2/queries/network-interfaces":{"get":{"tags":["queries"],"summary":"List Network Interfaces","description":"Returns list of Network Interfaces for each device","operationId":"getNetworkInterfaces","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","schema":{"type":"integer","description":"Limit number of devices to return","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"adapterName":{"type":"string","description":"Adapter Name"},"defaultGateway":{"type":"string","description":"Default Gateway"},"interfaceType":{"type":"string","description":"Interface Type"},"dnsHostName":{"type":"string","description":"DNS HostName"},"dnsServers":{"type":"string","description":"DNS Servers"},"interfaceIndex":{"type":"string","description":"Interface Index"},"interfaceName":{"type":"string","description":"Interface Name"},"ipAddress":{"type":"array","description":"IP Address","items":{"type":"string","description":"IP Address"}},"linkSpeed":{"type":"string","description":"Link Speed"},"macAddress":{"type":"array","description":"MAC Address","items":{"type":"string","description":"MAC Address"}},"mtu":{"type":"string","description":"MTU"},"status":{"type":"string","description":"Status"},"subnetMask":{"type":"string","description":"Subnet Mask"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"}}}}}}}}}}}},"/v2/queries/operating-systems":{"get":{"tags":["queries"],"summary":"Operating systems report","description":"Returns operating systems' for devices","operationId":"getOperatingSystems","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"ts","in":"query","description":"Monitoring timestamp filter","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"manufacturer":{"type":"string","description":"Manufacturer"},"name":{"type":"string","description":"Name"},"architecture":{"type":"string","description":"Architecture"},"lastBootTime":{"type":"number","description":"Last boot time","format":"double"},"buildNumber":{"type":"string","description":"Build number"},"releaseId":{"type":"string","description":"Release ID"},"servicePackMajorVersion":{"type":"integer","description":"Service Pack Major Version","format":"int32"},"servicePackMinorVersion":{"type":"integer","description":"Service Pack Minor Version","format":"int32"},"locale":{"type":"string","description":"Locale"},"language":{"type":"string","description":"Language"},"needsReboot":{"type":"boolean","description":"Operating system has pending reboot requests"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}}}}}}}},"/v2/queries/os-patches":{"get":{"tags":["queries"],"summary":"Pending, Failed and Rejected OS patches report","description":"Returns list of OS patches for which there were no installation attempts","operationId":"getPendingFailedRejectedOSPatches","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"ts","in":"query","description":"Monitoring timestamp filter","schema":{"type":"string"}},{"name":"status","in":"query","description":"Patch Status filter","schema":{"type":"string"}},{"name":"type","in":"query","description":"Patch Type filter","schema":{"type":"string"}},{"name":"severity","in":"query","description":"Patch Severity filter","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Name"},"severity":{"type":"string","description":"Severity"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Patch release date","format":"double"},"version":{"type":"string","description":"Patch version"},"os":{"type":"string","description":"Operating system family the patch applies to","enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"rebootRequired":{"type":"string","description":"Whether installing the patch requires a reboot","enum":["YES","NO","MAYBE"]},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"},"kbNumber":{"type":"string","description":"KB Number"}}}}}}}}}}}},"/v2/queries/software-patches":{"get":{"tags":["queries"],"summary":"Pending, Failed and Rejected Software patches report","description":"Returns list of 3rd party Software patches for which there were no installation attempts","operationId":"getPendingFailedRejectedSoftwarePatches","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"ts","in":"query","description":"Monitoring timestamp filter","schema":{"type":"string"}},{"name":"status","in":"query","description":"Patch Status filter","schema":{"type":"string"}},{"name":"productIdentifier","in":"query","description":"Product Identifier","schema":{"type":"string"}},{"name":"type","in":"query","description":"Patch Type filter","schema":{"type":"string"}},{"name":"impact","in":"query","description":"Patch Impact filter","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"productIdentifier":{"type":"string","description":"Software product identifier","format":"uuid"},"title":{"type":"string","description":"Patch title"},"impact":{"type":"string","description":"Impact"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Patch type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Vendor's published release date, null if unknown","format":"double","nullable":true},"version":{"type":"string","description":"Vendor's own version string, null if not available","nullable":true},"architecture":{"type":"string","description":"Patch architecture, null if unknown","nullable":true,"enum":["X86","X64","ARM64","UNIVERSAL"]},"os":{"type":"string","description":"Operating system family, null if unknown","nullable":true,"enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"vendor":{"type":"string","description":"Vendor name, null if not available","nullable":true},"rebootRequired":{"type":"string","description":"Whether a reboot is required after installation, null if unknown","nullable":true,"enum":["YES","NO","MAYBE"]},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}}}}}}}},"/v2/queries/policy-overrides":{"get":{"tags":["queries"],"summary":"Get summary of device policy overrides","description":"Returns list of overridden policy sections for each device","operationId":"getPolicyOverrides_1","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"maximum":10000,"minimum":10,"type":"integer","format":"int32","default":1000}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"overrides":{"type":"array","description":"List of policy sections","items":{"type":"string","description":"List of policy sections"}},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"}}}}}}}}}}}},"/v2/queries/processors":{"get":{"tags":["queries"],"summary":"Processor report","description":"Returns list of processors","operationId":"getProcessors","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"ts","in":"query","description":"Monitoring timestamp filter","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"architecture":{"type":"string","description":"Architecture"},"maxClockSpeed":{"type":"integer","description":"Max Clock Speed","format":"int64"},"clockSpeed":{"type":"integer","description":"Current Clock Speed","format":"int64"},"name":{"type":"string","description":"Name"},"numCores":{"type":"integer","description":"Number of Cores","format":"int32"},"numLogicalCores":{"type":"integer","description":"Number of Logical Cores]","format":"int32"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}}}}}}}},"/v2/queries/raid-controllers":{"get":{"tags":["queries"],"summary":"RAID controller report","description":"Returns list of RAID controllers","operationId":"getRAIDControllerReport","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"ts","in":"query","description":"Monitoring timestamp filter","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"backupBatteryStatus":{"type":"string","description":"Backup Battery Status"},"batteryTemperature":{"type":"integer","description":"Battery Temperature","format":"int32"},"biosVersion":{"type":"string","description":"BIOS Version"},"cacheSize":{"type":"integer","description":"Cache size (bytes)","format":"int64"},"controllerIndex":{"type":"integer","description":"Controller Index","format":"int32"},"driverName":{"type":"string","description":"Device Driver Name"},"driverVersion":{"type":"string","description":"Driver Version"},"family":{"type":"string","description":"Family"},"firmwareVersion":{"type":"string","description":"Firmware Version"},"hardwareRevision":{"type":"string","description":"Hardware Revision"},"manufacturer":{"type":"string","description":"Manufacturer"},"manufacturingDate":{"type":"number","description":"Manufacturing date","format":"double"},"model":{"type":"string","description":"Model"},"physicalDriveCount":{"type":"integer","description":"Physical drive count","format":"int32"},"slot":{"type":"string","description":"Slot"},"systemHealthStatus":{"type":"string","description":"System Health Status"},"virtualDriveCount":{"type":"integer","description":"Virtual drive count","format":"int32"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}}}}}}}},"/v2/queries/raid-drives":{"get":{"tags":["queries"],"summary":"RAID drive report","description":"Returns list of drives connected to RAID controllers","operationId":"getRAIDDriveReport","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"ts","in":"query","description":"Monitoring timestamp filter","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"controllerIndex":{"type":"integer","description":"Controller index","format":"int32"},"driveGroup":{"type":"string","description":"Drive Group"},"driveId":{"type":"string","description":"Drive Identifier"},"interfaceType":{"type":"string","description":"Interface type"},"location":{"type":"string","description":"Location"},"mediaType":{"type":"string","description":"Media type"},"model":{"type":"string","description":"Model"},"protectionInfo":{"type":"string","description":"Protection Information"},"selfEncrypted":{"type":"boolean","description":"Is self encrypted?"},"serial":{"type":"string","description":"Serial number"},"size":{"type":"integer","description":"Size (bytes)","format":"int64"},"spun":{"type":"boolean","description":"Spun?"},"status":{"type":"string","description":"Status"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}}}}}}}},"/v2/queries/scoped-custom-fields-detailed":{"get":{"tags":["queries"],"summary":"Scoped custom fields detailed report","description":"Returns report for Custom Fields defined at different scopes (device, location, organization) with additional information about each field","operationId":"getScopedCustomFieldsDetailedReport","parameters":[{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"maximum":10000,"minimum":10,"type":"integer","format":"int32","default":1000}},{"name":"updatedAfter","in":"query","description":"Custom fields updated after specified date","schema":{"type":"string"}},{"name":"fields","in":"query","description":"Comma-separated list of fields","schema":{"type":"string"}},{"name":"scopes","in":"query","description":"Comma-separated list of scopes","schema":{"type":"string","default":"all"}},{"name":"showSecureValues","in":"query","description":"Flag to indicate if secure values should be returned as plain text without encryption","schema":{"type":"boolean"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"scope":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]},"entityId":{"type":"integer","description":"Entity identifier (device, organization, location)","format":"int32"},"fields":{"type":"array","description":"Field values","items":{"type":"object","properties":{"name":{"type":"string","description":"Field name"},"value":{"type":"object","description":"Field Value"},"updated":{"type":"number","description":"Last field update timestamp","format":"double","writeOnly":true},"updatedBy":{"type":"object","properties":{"source":{"type":"string","enum":["API","USER","SCRIPT","SYSTEM"]},"user":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"email":{"type":"string"}}}},"description":"Value source (who/what updated the value)"},"updateTime":{"type":"number","format":"double"}},"description":"Field values"}}}}}}}}}}}}},"/v2/queries/scoped-custom-fields":{"get":{"tags":["queries"],"summary":"Scoped custom fields report","description":"Returns report for Custom Fields defined at different scopes (device, location, organization)","operationId":"getScopedCustomFieldsReport","parameters":[{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"maximum":10000,"minimum":10,"type":"integer","format":"int32","default":1000}},{"name":"updatedAfter","in":"query","description":"Custom fields updated after specified date","schema":{"type":"string"}},{"name":"fields","in":"query","description":"Comma-separated list of fields","schema":{"type":"string"}},{"name":"scopes","in":"query","description":"Comma-separated list of scopes","schema":{"type":"string","default":"all"}},{"name":"showSecureValues","in":"query","description":"Flag to indicate if secure values should be returned as plain text without encryption","schema":{"type":"boolean"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"scope":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]},"entityId":{"type":"integer","description":"Entity identifier (device, organization, location)","format":"int32"},"fields":{"type":"object","additionalProperties":{"type":"object","description":"Field values"},"description":"Field values"}}}}}}}}}}}},"/v2/queries/software":{"get":{"tags":["queries"],"summary":"Software inventory","description":"Returns list software installed on devices","operationId":"getSoftware","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"type":"integer","format":"int32"}},{"name":"installedBefore","in":"query","description":"Include software installed before specified date","schema":{"type":"string"}},{"name":"installedAfter","in":"query","description":"Include software installed after specified date","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"installDate":{"type":"string","description":"Installation Date","format":"date-time"},"location":{"type":"string","description":"Location"},"name":{"type":"string","description":"Product Name"},"publisher":{"type":"string","description":"Publisher"},"size":{"type":"integer","description":"Size on disk","format":"int64"},"version":{"type":"string","description":"Version"},"productCode":{"type":"string","description":"Product Code"},"isSystemComponent":{"type":"boolean","description":"Is System Component"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}}}}}}}},"/v2/queries/volumes":{"get":{"tags":["queries"],"summary":"Disk volumes report","description":"Returns list of disk volumes","operationId":"getVolumes","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"ts","in":"query","description":"Monitoring timestamp filter","schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"type":"integer","format":"int32"}},{"name":"include","in":"query","description":"Additional information to include (bl - BitLocker status)","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"driveLetter":{"type":"string","description":"Drive Letter"},"label":{"type":"string","description":"Volume Label"},"deviceType":{"type":"string","description":"Device Type"},"fileSystem":{"type":"string","description":"File System Type"},"autoMount":{"type":"boolean","description":"Automatically Mounted"},"compressed":{"type":"boolean","description":"Compressed"},"capacity":{"type":"integer","description":"Capacity (bytes)","format":"int64"},"freeSpace":{"type":"integer","description":"Free Space (bytes)","format":"int64"},"serialNumber":{"type":"string","description":"Serial Number"},"bitLockerStatus":{"type":"object","properties":{"conversionStatus":{"type":"string","description":"Volume encryption or decryption status.","enum":["FULLY_DECRYPTED","FULLY_ENCRYPTED","ENCRYPTION_IN_PROGRESS","DECRYPTION_IN_PROGRESS","ENCRYPTION_PAUSED","DECRYPTION_PAUSED","UNKNOWN"]},"encryptionMethod":{"type":"string","description":"Indicated the encryption algorithm and key size used on the volume","enum":["NONE","AES_128_WITH_DIFFUSER","AES_256_WITH_DIFFUSER","AES_128","AES_256","HARDWARE_ENCRYPTION","XTS_AES_128","XTS_AES_256","UNKNOWN"]},"protectionStatus":{"type":"string","description":" indicates whether the volume and its encryption key (if any) are secured.","enum":["UNPROTECTED","PROTECTED","UNKNOWN","PENDING"]},"lockStatus":{"type":"string","description":"Indicates whether the contents of the volume are accessible from Windows","enum":["UNKNOWN","UNLOCKED","LOCKED"]},"initializedForProtection":{"type":"boolean","description":"Is initialized for protection"}},"description":"BitLocker Status"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}}}}}}}},"/v2/queries/windows-services":{"get":{"tags":["queries"],"summary":"Windows services report","description":"Returns list of Windows Services and their statuses","operationId":"getWindowsServicesReport","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"name","in":"query","description":"Service name","schema":{"type":"string"}},{"name":"state","in":"query","description":"Service state","schema":{"type":"string","enum":["UNKNOWN","STOPPED","START_PENDING","RUNNING","STOP_PENDING","PAUSE_PENDING","PAUSED","CONTINUE_PENDING"]}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"maximum":10000,"minimum":10,"type":"integer","format":"int32","default":1000}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"displayName":{"type":"string","description":"Display Name"},"description":{"type":"string","description":"Description"},"startType":{"type":"string","description":"Start Type","enum":["AUTO_START","AUTO_START_DELAYED","BOOT_START","DEMAND_START","DISABLED","SYSTEM_START"]},"userName":{"type":"string","description":"User Name"},"state":{"type":"string","description":"State","enum":["UNKNOWN","STOPPED","START_PENDING","RUNNING","STOP_PENDING","PAUSE_PENDING","PAUSED","CONTINUE_PENDING"]},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}}}}}}}},"/v2/policies":{"get":{"tags":["system"],"summary":"List policies","description":"Returns list of policies","operationId":"getPolicies","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"}}}}}}},"post":{"tags":["management"],"summary":"Creates new Policy","description":"Creates new policy using (New Root, Child, Copy)","operationId":"createPolicy","parameters":[{"name":"mode","in":"query","description":"Policy creation mode","schema":{"type":"string","enum":["NEW","CHILD","COPY"]}},{"name":"templatePolicyId","in":"query","description":"Template Policy identifier","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"enabled":{"type":"boolean","description":"Policy Enabled Flag","default":true}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"}}}}}}},"/v2/jobs":{"get":{"tags":["system"],"summary":"List active jobs","description":"Returns list of running jobs","operationId":"getActiveJobs","parameters":[{"name":"jobType","in":"query","description":"Job Type filter","schema":{"type":"string"}},{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"lang","in":"query","description":"Language tag","schema":{"type":"string"}},{"name":"tz","in":"query","description":"Time Zone","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"uid":{"type":"string","description":"Task/Job UID (activity series UID)","format":"uuid"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"message":{"type":"string","description":"Job message"},"createTime":{"type":"number","description":"Job start timestamp","format":"double"},"updateTime":{"type":"number","description":"Job last updated","format":"double"},"sourceType":{"type":"string","description":"Job origin","enum":["AGENT_OFFLINE","CONDITION_AGENT_CPU","CONDITION_AGENT_MEMORY","CONDITION_AGENT_NETWORK","CONDITION_AGENT_DISK_IO","CONDITION_AGENT_DISK_FREE_SPACE","CONDITION_AGENT_DISK_USAGE","CONDITION_AGENT_CVSS_SCORE","CONDITION_AGENT_PATCH_LAST_INSTALLED","CONDITION_NMS_CPU","CONDITION_NMS_MEMORY","CONDITION_NMS_NETWORK_TRAFFIC_BITS","CONDITION_NMS_NETWORK_ADAPTER_STATUS","CONDITION_NMS_NETWORK_TRAFFIC_PERCENT","CONDITION_NMS_NETWORK_STATUS","CONDITION_NMS_NETWORK_STATUS_CHANGE","CONDITION_NMS_SYSTEM_UPTIME","CONDITION_PING","CONDITION_PING_LATENCY","CONDITION_PING_PACKET_LOSS","CONDITION_PING_RESPONSE","CONDITION_SYSTEM_UPTIME","CONDITION_SMART_STATUS_DEGRATED","CONDITION_RAID_HEALTH_STATUS","CONDITION_SCRIPT_RESULT","CONDITION_HTTP","CONDITION_HTTP_RESPONSE","CONDITION_PORT","CONDITION_PORT_SCAN","CONDITION_SYSLOG","CONDITION_CONFIGURATION_FILE","CONDITION_SNMPTRAP","CONDITION_CRITICAL_EVENT","CONDITION_BATTERY_MONITORING","CONDITION_DNS","CONDITION_EMAIL","CONDITION_CUSTOM_SNMP","CONDITION_COMPOUND","SHADOWPROTECT_BACKUPJOB_CREATE","SHADOWPROTECT_BACKUPJOB_UPDATE","SHADOWPROTECT_BACKUPJOB_DELETE","SHADOWPROTECT_BACKUPJOB_EXECUTE","IMAGEMANAGER_MANAGEDFOLDER_CREATE","IMAGEMANAGER_MANAGEDFOLDER_UPDATE","IMAGEMANAGER_MANAGEDFOLDER_DELETE","IMAGEMANAGER_MANAGEDFOLDER_EXECUTE","TEAMVIEWER_CONNECTION","RETRIEVE_AGENT_LOGS","SCHEDULED_TASK","CONDITION_WINDOWS_EVENT_LOG_TRIGGERED","CONDITION_WINDOWS_SERVICE_STATE_CHANGED","UI_MESSAGE_ACTION_REBOOT","UI_MESSAGE_BD_INSTALLATION_ISSUES","GRAVITYZONE_UI_MESSAGE_INSTALLATION_ISSUES","AV_QUARANTINE_THREAT","AV_RESTORE_THREAT","AV_DELETE_THREAT","AV_REMOVE_THREAT","BITDEFENDER_RESTORE_THREAT","BITDEFENDER_DELETE_THREAT","CONDITION_BITLOCKER_STATUS","CONDITION_FILEVAULT_STATUS","CONDITION_LINUX_PROCESS","CONDITION_LINUX_Daemon","CONDITION_LINUX_PROCESS_RESOURCE","CONDITION_LINUX_PROCESS_RESOURCE_CPU","CONDITION_LINUX_PROCESS_RESOURCE_MEMORY","CONDITION_LINUX_DISK_FREE_SPACE","CONDITION_LINUX_DISK_USAGE","CONDITION_VM_AGGREGATE_CPU_USAGE","CONDITION_VM_DISK_USAGE","CONDITION_VM_HOST_DATASTORE","CONDITION_VM_HOST_UPTIME","CONDITION_VM_HOST_DEVICE_DOWN","CONDITION_VM_HOST_BAD_SENSORS","CONDITION_VM_HOST_SENSOR_HEALTH","CONDITION_VM_GUEST_GUEST_OPERATIONAL_MODE","CONDITION_VM_GUEST_SNAPSHOT_SIZE","CONDITION_VM_GUEST_SNAPSHOT_LIFESPAN","CONDITION_VM_GUEST_TOOLS_NOT_RUNNING","CONDITION_HV_GUEST_CHECKPOINT_SIZE","CONDITION_HV_GUEST_CHECKPOINT_LIFESPAN","CONDITION_SOFTWARE","CONDITION_WINDOWS_PROCESS_STATE","CONDITION_WINDOWS_PROCESS_RESOURCE_CPU","CONDITION_WINDOWS_PROCESS_RESOURCE_MEMORY","CONDITION_MAC_PROCESS_STATE","CONDITION_MAC_PROCESS_RESOURCE_CPU","CONDITION_MAC_PROCESS_RESOURCE_MEMORY","CONDITION_MAC_DEAMON","CONDITION_CUSTOM_FIELD","CONDITION_PENDING_REBOOT","CONDITION_LOCKHART_LAST_SUCCESSFUL_BACKUP"]},"sourceConfigUid":{"type":"string","description":"Source configuration/policy element reference","format":"uuid"},"sourceName":{"type":"string","description":"Source configuration/policy element name"},"subject":{"type":"string","description":"Job subject"},"userId":{"type":"integer","description":"User identifier","format":"int32"},"psaTicketId":{"type":"object","description":"Related PSA ticket ID"},"ticketTemplateId":{"type":"integer","description":"PSA ticket template","format":"int32"},"data":{"type":"object","additionalProperties":true,"description":"Job data"},"device":{"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"}},"description":"Device information."},"jobStatus":{"type":"string","description":"Job Status","enum":["START_REQUESTED","STARTED","IN_PROCESS","COMPLETED","CANCEL_REQUESTED","CANCELLED","WAITING_FOR_USER_RESPONSE","SUPERSEDED","TRIGGERED","RESET","ACKNOWLEDGED","DISABLED"]},"jobResult":{"type":"string","description":"Job result","enum":["SUCCESS","FAILURE","UNSUPPORTED","UNCOMPLETED","MISSED"]},"jobType":{"type":"string","description":"Job Type","enum":["ACTIONSET","ACTION","CONDITION","CONDITION_ACTIONSET","CONDITION_ACTION","ANTIVIRUS","PATCH_MANAGEMENT","TEAMVIEWER","MONITOR","SYSTEM","COMMENT","SHADOWPROTECT","IMAGEMANAGER","HELP_REQUEST","SOFTWARE_PATCH_MANAGEMENT","SPLASHTOP","CLOUDBERRY","CLOUDBERRY_BACKUP","SCHEDULED_TASK","RDP","SCRIPTING","SECURITY","REMOTE_TOOLS","VIRTUALIZATION","PSA","MDM","NINJA_REMOTE","NINJA_QUICK_CONNECT","NINJA_NETWORK_DISCOVERY","NINJA_BACKUP","NINJA_TICKETING","KNOWLEDGE_BASE","RELATED_ITEM","CLIENT_CHECKLIST","CHECKLIST_TEMPLATE","DOCUMENTATION","MICROSOFT_INTUNE","DYNAMIC_POLICY","MAINTENANCE_MODE","AOSP_ACTION","AOSP_POLICY","AOSP"]}}}}}}}}}},"/v2/activities":{"get":{"tags":["system"],"summary":"List activities","description":"Returns activity log in reverse chronological order","operationId":"getActivities","parameters":[{"name":"class","in":"query","description":"Activity Class (System/Device) filter","schema":{"type":"string","enum":["SYSTEM","DEVICE","USER","ALL"],"default":"ALL"}},{"name":"before","in":"query","description":"Return activities recorded prior to specified date","schema":{"type":"string"}},{"name":"after","in":"query","description":"Return activities recorded after to specified date","schema":{"type":"string"}},{"name":"olderThan","in":"query","description":"Return activities recorded that are newer than specified activity ID","schema":{"type":"integer","format":"int64"}},{"name":"newerThan","in":"query","description":"Return activities recorded that are older than specified activity ID","schema":{"type":"integer","format":"int64"}},{"name":"type","in":"query","description":"Return activities of type","schema":{"type":"string"}},{"name":"status","in":"query","description":"Return activities with status(es)","schema":{"type":"string"}},{"name":"user","in":"query","description":"Return activities for user(s)","schema":{"type":"string"}},{"name":"seriesUid","in":"query","description":"Return activities related to alert (series)","schema":{"type":"string"}},{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of activities to return","schema":{"maximum":1000,"minimum":10,"type":"integer","format":"int32","default":200}},{"name":"lang","in":"query","description":"Language tag","schema":{"type":"string"}},{"name":"tz","in":"query","description":"Time Zone","schema":{"type":"string"}},{"name":"startTime","in":"query","description":"Start timestamp (ISO-8601)","schema":{"type":"string"}},{"name":"endTime","in":"query","description":"End timestamp (ISO-8601)","schema":{"type":"string"}},{"name":"sourceConfigUid","in":"query","description":"Allows users to make a request directed to a specific script","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"lastActivityId":{"type":"integer","description":"Last recorded activity ID for account","format":"int64"},"activities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Activity identifier","format":"int64"},"activityTime":{"type":"number","description":"Activity timestamp","format":"double"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"severity":{"type":"string","description":"Severity","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"]},"priority":{"type":"string","description":"Priority","enum":["NONE","LOW","MEDIUM","HIGH"]},"seriesUid":{"type":"string","description":"Activity series UID (job/condition UID)","format":"uuid"},"activityType":{"type":"string","description":"Activity type code","enum":["ACTIONSET","ACTION","CONDITION","CONDITION_ACTIONSET","CONDITION_ACTION","ANTIVIRUS","PATCH_MANAGEMENT","TEAMVIEWER","MONITOR","SYSTEM","COMMENT","SHADOWPROTECT","IMAGEMANAGER","HELP_REQUEST","SOFTWARE_PATCH_MANAGEMENT","SPLASHTOP","CLOUDBERRY","CLOUDBERRY_BACKUP","SCHEDULED_TASK","RDP","SCRIPTING","SECURITY","REMOTE_TOOLS","VIRTUALIZATION","PSA","MDM","NINJA_REMOTE","NINJA_QUICK_CONNECT","NINJA_NETWORK_DISCOVERY","NINJA_BACKUP","NINJA_TICKETING","KNOWLEDGE_BASE","RELATED_ITEM","CLIENT_CHECKLIST","CHECKLIST_TEMPLATE","DOCUMENTATION","MICROSOFT_INTUNE","DYNAMIC_POLICY","MAINTENANCE_MODE","AOSP_ACTION","AOSP_POLICY","AOSP"]},"statusCode":{"type":"string","description":"Activity status code","enum":["START_REQUESTED","STARTED","IN_PROCESS","COMPLETED","CANCEL_REQUESTED","CANCELLED","BLOCKED","QUEUED","TRIGGERED","RESET","ACKNOWLEDGED","DISABLED","EVALUATION_FAILURE","CLIENT_CREATED","CLIENT_UPDATED","CLIENT_DELETED","CREDENTIAL_CREATED","CREDENTIAL_UPDATED","CREDENTIAL_DELETED","LOCATION_CREATED","LOCATION_UPDATED","LOCATION_DELETED","POLICY_CREATED","POLICY_UPDATED","POLICY_DELETED","NODE_CREATED","NODE_UPDATED","NODE_DELETED","NODE_RE_ENROLLED","NODE_ACCESS_GRANTED","NODE_ACCESS_DENIED","NODE_REGISTRATION_REJECTED","NODE_IDENTIFICATION_UPDATED","NODE_CLONING_DETECTED","NODE_CLONE_ADVISED_TO_REGISTER","NODE_MANUALLY_APPROVED","NODE_AUTOMATICALLY_APPROVED","NODE_MANUALLY_REJECTED","NODE_AUTOMATICALLY_REJECTED","REJECTED_NODE_CLEARED","REJECTED_NODE_DELETED","MOBILE_DEVICE_UNREGISTERED","APP_USER_CREATED","APP_USER_UPDATED","APP_USER_DELETED","APP_USER_LOGGED_IN","APP_USER_LOGGED_OUT","APP_USER_MFA_SETUP","APP_USER_MFA_DELETED","APP_USER_CRITICAL_ACTION","APP_USER_AUDIT_FAILED_LOGIN","APP_USER_AUTO_ASSIGN_CHANGED","END_USER_CREATED","END_USER_CREATED_API","END_USER_UPDATED","END_USER_UPDATED_API","END_USER_DELETED","END_USER_DELETED_API","END_USER_LOGGED_IN","END_USER_LOGGED_OUT","END_USER_MFA_SETUP","END_USER_MFA_DELETED","END_USER_AUDIT_FAILED_LOGIN","END_USER_CRITICAL_ACTION","CONTACT_CREATED","CONTACT_CREATED_API","CONTACT_UPDATED","CONTACT_UPDATED_API","CONTACT_DELETED","CONTACT_DELETED_API","DEVICE_GROUP_CREATED","DEVICE_GROUP_UPDATED","DEVICE_GROUP_DELETED","TICKET_TEMPLATE_CREATED","TICKET_TEMPLATE_UPDATED","TICKET_TEMPLATE_DELETED","CUSTOM_HEALTH_STATUS_CHANGED","CUSTOM_HEALTH_STATUS_RESET","PSA_TICKET_CREATION_FAILED","PSA_TICKET_CREATION_SUCCEEDED","RESET_BY_PSA_TICKET_CALLBACK","PSA_TICKET_CREATION_TEST","PSA_ENABLED","PSA_DISABLED","PSA_CREDENTIALS_FAILED","CONNECTWISE_AGREEMENTS_SYNC_COMPLETED","CONNECTWISE_AGREEMENTS_SYNC_STARTED","CONNECTWISE_NODE_SYNC_COMPLETED","CONNECTWISE_NODE_SYNC_STARTED","CONNECTWISE_NODE_SYNC_NODE_CREATED","CONNECTWISE_NODE_SYNC_NODE_UPDATED","CONNECTWISE_NODE_SYNC_NODE_DELETED","CONNECTWISE_UPDATED","CONNECTWISECONTROL_ATTEMPT","AUTOTASK_NODE_SYNC_STARTED","AUTOTASK_NODE_SYNC_COMPLETED","AUTOTASK_NODE_SYNC_NODE_CREATED","AUTOTASK_NODE_SYNC_NODE_UPDATED","AUTOTASK_NODE_SYNC_NODE_DELETED","AUTOTASK_UPDATED","AUTOTASK_ATTACHMENT_FAILURE","PSA_TICKET_UPDATED_FAILED","PSA_TICKET_UPDATED_SUCCEEDED","REPORT_CREATED","REPORT_UPDATED","REPORT_DELETED","TIME_ZONE_UPDATED","LANGUAGE_TAG_UPDATED","NODE_ROLE_CREATED","NODE_ROLE_UPDATED","NODE_ROLE_DELETED","COMMENT","VIPREAV_INSTALLED","VIPREAV_INSTALL_FAILED","VIPREAV_UNINSTALLED","VIPREAV_UNINSTALL_FAILED","VIPREAV_SCAN_THREAT_QUARANTINED","VIPREAV_ACTIVEPROTECTION_THREAT_QUARANTINED","VIPREAV_USERINITIATED_THREAT_QUARANTINED","VIPREAV_QUARANTINED_THREAT_REMOVED","VIPREAV_REBOOT_REQUIRED","VIPREAV_SCAN_STARTED","VIPREAV_SCAN_COMPLETED","VIPREAV_SCAN_ABORTED","VIPREAV_SCAN_FAILED","VIPREAV_SCAN_PAUSED","VIPREAV_DISABLED","WEBROOT_COMMAND_SUBMITTED","WEBROOT_THREAT_DETECTED","WEBROOT_INSTALL_FAILED","BITDEFENDER_SCAN_STARTED","BITDEFENDER_SCAN_COMPLETED","BITDEFENDER_THREAT_DELETE_FROM_QUARANTINE","BITDEFENDER_THREAT_RESTORE_FROM_QUARANTINE","BITDEFENDER_SCAN_FAILED","BITDEFENDER_THREAT_DELETE_FROM_QUARANTINE_FAILED","BITDEFENDER_THREAT_RESTORE_FROM_QUARANTINE_FAILED","BITDEFENDER_DOWNLOAD_STARTED","BITDEFENDER_DOWNLOAD_SUCCEEDED","BITDEFENDER_DOWNLOAD_FAILED","BITDEFENDER_INSTALLATION_STARTED","BITDEFENDER_INSTALLATION_SUCCEEDED","BITDEFENDER_INSTALLATION_FAILED","BITDEFENDER_UNINSTALLATION_STARTED","BITDEFENDER_UNINSTALLATION_SUCCEEDED","BITDEFENDER_UNINSTALLATION_FAILED","BITDEFENDER_UNPACKING_FAILED","BDAS_BITDEFENDER_THREAT_IGNORED","BDAS_BITDEFENDER_THREAT_PRESENT","BDAS_BITDEFENDER_THREAT_DELETED","BDAS_BITDEFENDER_THREAT_BLOCKED","BDAS_BITDEFENDER_THREAT_QUARANTINED","BDAS_BITDEFENDER_THREAT_CLEANED","BDAS_BITDEFENDER_PURGE_QUARANTINE_FAILED","BDAS_BITDEFENDER_PURGE_QUARANTINE_SUCCESS","BDAS_BITDEFENDER_THREAT_QUARANTINE_RESTORED","BDAS_BITDEFENDER_THREAT_QUARANTINE_RESTORED_CUSTOMPATH","BDAS_BITDEFENDER_THREAT_QUARANTINE_DELETED","BITDEFENDER_RETRY_INSTALL_COMPLETED","BITDEFENDER_DISABLED","BITDEFENDER_EXISTING_PRODUCT_UNINSTALL","COMPETITOR_EXISTING_PRODUCT_UNINSTALL","SCHEDULE_INSTALL_OPTION_CHANGED","SECURITY_CREDENTIAL_ACCESS_GRANTED","SECURITY_CREDENTIAL_ACCESS_DENIED","PATCH_MANAGEMENT_SCAN_STARTED","PATCH_MANAGEMENT_SCAN_COMPLETED","PATCH_MANAGEMENT_APPLY_PATCH_STARTED","PATCH_MANAGEMENT_APPLY_PATCH_COMPLETED","PATCH_MANAGEMENT_INSTALLED","PATCH_MANAGEMENT_INSTALL_FAILED","PATCH_MANAGEMENT_MESSAGE","PATCH_MANAGEMENT_FAILURE","PATCH_MANAGEMENT_ROLLBACK_PATCH_REQUESTED","PATCH_MANAGEMENT_ROLLBACK_PATCH_STARTED","PATCH_MANAGEMENT_ROLLBACK_PATCH_COMPLETED","PATCH_MANAGEMENT_PATCH_APPROVED","PATCH_MANAGEMENT_PATCH_REJECTED","SOFTWARE_PATCH_MANAGEMENT_SCAN_STARTED","SOFTWARE_PATCH_MANAGEMENT_SCAN_COMPLETED","SOFTWARE_PATCH_MANAGEMENT_APPLY_PATCH_STARTED","SOFTWARE_PATCH_MANAGEMENT_APPLY_PATCH_COMPLETED","SOFTWARE_PATCH_MANAGEMENT_INSTALLED","SOFTWARE_PATCH_MANAGEMENT_INSTALL_FAILED","SOFTWARE_PATCH_MANAGEMENT_MESSAGE","SOFTWARE_PATCH_MANAGEMENT_PATCH_APPROVED","SOFTWARE_PATCH_MANAGEMENT_PATCH_REJECTED","SPLASHTOP_CONNECTION_INITIATED","SPLASHTOP_CONNECTION_ESTABLISHED","SPLASHTOP_CONNECTION_TERMINATED","REMOTE_TOOLS_UPLOAD_FILE_INITIATED","REMOTE_TOOLS_DOWNLOAD_FILE_INITIATED","REMOTE_TOOLS_COMPRESS_FILE_INITIATED","REMOTE_TOOLS_COMPRESS_FILE_SUCCESS","REMOTE_TOOLS_COMPRESS_FILE_FAILED","REMOTE_TOOLS_CREATE_DIRECTORY_INITIATED","REMOTE_TOOLS_RENAME_FILE_INITIATED","REMOTE_TOOLS_DELETE_FILE_INITIATED","REMOTE_TOOLS_MODIFY_OBJECT_SUCCESS","REMOTE_TOOLS_MODIFY_OBJECT_FAILED","REMOTE_TOOLS_COPY_OBJECT_SUCCESS","REMOTE_TOOLS_COPY_OBJECT_FAILED","REMOTE_TOOLS_MOVE_OBJECT_SUCCESS","REMOTE_TOOLS_MOVE_OBJECT_FAILED","REMOTE_TOOLS_DELETE_OBJECT_SUCCESS","REMOTE_TOOLS_DELETE_OBJECT_FAILED","REMOTE_TOOLS_CREATE_DIRECTORY_SUCCESS","REMOTE_TOOLS_CREATE_DIRECTORY_FAILED","REMOTE_TOOLS_FILE_TRANSFER_SUCCESS","REMOTE_TOOLS_FILE_TRANSFER_FAILED","REMOTE_TOOLS_SERVICE_CONTROL_INITIATED","REMOTE_TOOLS_START_SERVICE_SUCCESS","REMOTE_TOOLS_START_SERVICE_FAILED","REMOTE_TOOLS_STOP_SERVICE_SUCCESS","REMOTE_TOOLS_STOP_SERVICE_FAILED","REMOTE_TOOLS_RESTART_SERVICE_SUCCESS","REMOTE_TOOLS_RESTART_SERVICE_FAILED","REMOTE_TOOLS_START_TYPE_CHANGE_SUCCESS","REMOTE_TOOLS_START_TYPE_CHANGE_FAILED","REMOTE_TOOLS_PROCESS_CONTROL_INITIATED","REMOTE_TOOLS_SET_PROCESS_PRIORITY_SUCESS","REMOTE_TOOLS_SET_PROCESS_PRIORITY_FAILED","REMOTE_TOOLS_TERMINATE_PROCESS_SUCCESS","REMOTE_TOOLS_TERMINATE_PROCESS_FAILED","REMOTE_TOOLS_TERMINATE_PROCESS_TREE_SUCCESS","REMOTE_TOOLS_TERMINATE_PROCESS_TREE_FAILED","REMOTE_TOOLS_REGISTRY_CONTROL_INITIATED","REMOTE_TOOLS_CREATE_KEY_SUCCESS","REMOTE_TOOLS_CREATE_KEY_FAILED","REMOTE_TOOLS_RENAME_KEY_SUCCESS","REMOTE_TOOLS_RENAME_KEY_FAILED","REMOTE_TOOLS_DELETE_KEY_SUCCESS","REMOTE_TOOLS_DELETE_KEY_FAILED","REMOTE_TOOLS_CREATE_PARAMETER_SUCCESS","REMOTE_TOOLS_CREATE_PARAMETER_FAILED","REMOTE_TOOLS_RENAME_PARAMETER_SUCCESS","REMOTE_TOOLS_RENAME_PARAMETER_FAILED","REMOTE_TOOLS_DELETE_PARAMETER_SUCCESS","REMOTE_TOOLS_DELETE_PARAMETER_FAILED","REMOTE_TOOLS_MODIFY_PARAMETER_SUCCESS","REMOTE_TOOLS_MODIFY_PARAMETER_FAILED","REMOTE_TOOLS_ACTIVE_DIRECTORY_INITIATED","ADAPTER_ADDED","ADAPTER_REMOVED","ADAPTER_CONFIG_CHANGED","ADAPTER_STATUS_CHANGED","CPU_ADDED","CPU_REMOVED","MEMORY_ADDED","MEMORY_REMOVED","DISK_DRIVE_ADDED","DISK_DRIVE_REMOVED","USER_LOGGED_IN","USER_LOGGED_OUT","PORT_OPENED","PORT_CLOSED","WINDOWS_SERVICE_STARTED","WINDOWS_SERVICE_STOPPED","MAC_DAEMON_STARTED","MAC_DAEMON_STOPPED","USER_ACCOUNT_ADDED","USER_ACCOUNT_REMOVED","PROCESS_STARTED","PROCESS_STOPPED","SYSTEM_REBOOTED","SOFTWARE_ADDED","SOFTWARE_REMOVED","SOFTWARE_UPDATED","SOFTWARE_OS_UPDATED","DISK_PARTITION_ADDED","DISK_PARTITION_REMOVED","DISK_VOLUME_ADDED","DISK_VOLUME_REMOVED","CREDENTIALS_CHANGED","RAID_CONTROLLER_ADDED","RAID_CONTROLLER_REMOVED","RAID_PHYSICAL_DRIVE_ADDED","RAID_PHYSICAL_DRIVE_REMOVED","RAID_LOGICAL_DISK_ADDED","RAID_LOGICAL_DISK_REMOVED","BITLOCKER_ENABLED","BITLOCKER_DISABLED","FILEVAULT_ENABLED","FILEVAULT_DISABLED","TRUSTED_PLATFORM_MODULE_ENABLED","TRUSTED_PLATFORM_MODULE_DISABLED","TRUSTED_PLATFORM_MODULE_INSTALLED","TRUSTED_PLATFORM_MODULE_UNINSTALLED","SHADOWPROTECT_INSTALLED","SHADOWPROTECT_INSTALL_FAILED","SHADOWPROTECT_UNINSTALLED","SHADOWPROTECT_UNINSTALL_FAILED","SHADOWPROTECT_BACKUPJOB_FAILED","SHADOWPROTECT_BACKUPJOB_ABORTED","SHADOWPROTECT_LICENSE_PROVISIONED","SHADOWPROTECT_LICENSE_PROVISION_FAILED","SHADOWPROTECT_LICENSE_ACTIVATED","SHADOWPROTECT_LICENSE_ACTIVATION_FAILED","SHADOWPROTECT_LICENSE_DEACTIVATED","SHADOWPROTECT_LICENSE_DEACTIVATION_FAILED","IMAGEMANAGER_INSTALLED","IMAGEMANAGER_INSTALL_FAILED","IMAGEMANAGER_UNINSTALLED","IMAGEMANAGER_UNINSTALL_FAILED","IMAGEMANAGER_LICENSE_PROVISIONED","IMAGEMANAGER_LICENSE_PROVISION_FAILED","IMAGEMANAGER_LICENSE_ACTIVATED","IMAGEMANAGER_LICENSE_ACTIVATION_FAILED","IMAGEMANAGER_LICENSE_DEACTIVATED","IMAGEMANAGER_LICENSE_DEACTIVATION_FAILED","IMAGEMANAGER_CONSOLIDATION_FAILED","IMAGEMANAGER_VERIFICATION_FAILED","HELP_REQUEST_SUBMITTED","CLOUDBERRY_INSTALLED","CLOUDBERRY_INSTALL_FAILED","CLOUDBERRY_UNINSTALLED","CLOUDBERRY_UNINSTALL_FAILED","CLOUDBERRY_BACKUPPLAN_CREATED","CLOUDBERRY_BACKUPPLAN_EDITED","CLOUDBERRY_BACKUPPLAN_DELETED","CLOUDBERRY_BACKUPPLAN_CREATION_FAILED","CLOUDBERRY_BACKUPJOB_STARTED","CLOUDBERRY_BACKUPJOB_SUCCEEDED","CLOUDBERRY_BACKUPJOB_FAILED","CLOUDBERRY_BACKUPJOB_COMPLETED_WITH_WARNING","CLOUDBERRY_USER_CREATED","CLOUDBERRY_NETWORK_CREDENTIAL_CREATED","CLOUDBERRY_NETWORK_CREDENTIAL_CREATION_FAILED","RDP_CONNECTION_INITIATED","RDP_AUTO_PROVISION","SCHEDULED_TASK_CREATED","SCHEDULED_TASK_UPDATED","SCHEDULED_TASK_DELETED","SCRIPT_CREATED","SCRIPT_UPDATED","SCRIPT_DELETED","NINJA_BACKUP_BACKUPJOB_START_REQUESTED","NINJA_BACKUP_BACKUPJOB_STARTED","NINJA_BACKUP_BACKUPJOB_IN_PROCESS","NINJA_BACKUP_BACKUPJOB_COMPLETED","NINJA_BACKUP_BACKUPJOB_FAILED","NINJA_BACKUP_RESTOREJOB_START_REQUESTED","NINJA_BACKUP_RESTOREJOB_STARTED","NINJA_BACKUP_RESTOREJOB_IN_PROCESS","NINJA_BACKUP_RESTOREJOB_COMPLETED","NINJA_BACKUP_RESTOREJOB_FAILED","NINJA_BACKUP_BACKUPJOB_COMPLETED_WITH_WARNING","NINJA_BACKUP_BACKUP_DOWNLOADED","NINJA_BACKUP_BACKUPPLAN_ADDED","NINJA_BACKUP_BACKUPPLAN_EDITED","NINJA_BACKUP_BACKUPPLAN_DELETED","NINJA_BACKUP_BACKUPJOB_CANCELLED","NINJA_BACKUP_BACKUPJOB_PROCESSING","NINJA_BACKUP_INSTALL_FAILED","NINJA_BACKUP_UNINSTALL_FAILED","NINJA_BACKUP_INSTALLED","NINJA_BACKUP_UNINSTALLED","NINJA_BACKUP_RESTOREJOB_CANCELLED","NINJA_BACKUP_BACKUPPLAN_CREATION_FAILED","NINJA_BACKUP_BACKUP_CONFIGURE_FAILED","NINJA_BACKUP_FILE_DOWNLOAD","NINJA_BACKUP_FOLDER_DOWNLOAD","NINJA_BACKUP_UPSYNCJOB_START_REQUESTED","NINJA_BACKUP_UPSYNCJOB_PROCESSING","NINJA_BACKUP_UPSYNCJOB_IN_PROCESS","NINJA_BACKUP_UPSYNCJOB_STARTED","NINJA_BACKUP_UPSYNCJOB_COMPLETED","NINJA_BACKUP_UPSYNCJOB_CANCELLED","NINJA_BACKUP_UPSYNCJOB_FAILED","NINJA_BACKUP_BACKUP_NAS_ACCESS_FAILED","NINJA_BACKUP_IMAGE_RESTORE_STARTED","NINJA_BACKUP_IMAGE_RESTORE_COMPLETED","NINJA_BACKUP_IMAGE_RESTORE_FAILED","NINJA_BACKUP_IMAGE_DOWNLOAD_STARTED","NINJA_BACKUP_IMAGE_DOWNLOAD_COMPLETED","NINJA_BACKUP_IMAGE_DOWNLOAD_FAILED","NINJA_BACKUP_IMAGE_DOWNLOAD_FILE_STARTED","NINJA_BACKUP_IMAGE_DOWNLOAD_FILE_COMPLETED","NINJA_BACKUP_IMAGE_DOWNLOAD_FILE_FAILED","NINJA_BACKUP_IMAGE_MOUNT_COMPLETED","NINJA_BACKUP_IMAGE_MOUNT_FAILED","NINJA_BACKUP_INTEGRITY_CHECK_START_REQUESTED","NINJA_BACKUP_INTEGRITY_CHECK_STARTED","NINJA_BACKUP_INTEGRITY_CHECK_IN_PROCESS","NINJA_BACKUP_INTEGRITY_CHECK_COMPLETED","NINJA_BACKUP_INTEGRITY_CHECK_FAILED","NINJA_BACKUP_INTEGRITY_CHECK_CANCELLED","NINJA_BACKUP_IMAGE_DOWNLOAD_FOLDER_STARTED","NINJA_BACKUP_IMAGE_DOWNLOAD_FOLDER_COMPLETED","NINJA_BACKUP_IMAGE_DOWNLOAD_FOLDER_FAILED","BACKUP_IMAGE_RESTORE_CANCELED","BACKUP_IMAGE_DOWNLOAD_CANCELED","QC_INVITATION_CREATED","QC_INVITATION_DISABLED","QC_EXPIRED_INVITATION_BLOCKED","QC_INVITATION_UPDATED","QC_DEVICE_DELETED","QC_DEVICE_AGENT_INSTALL_REQUESTED","QC_SESSION_STARTED","QC_SESSION_TERMINATED","QC_SESSION_REPORT_SUBMITTED","REMOTE_SUPPORT_CREATED","REMOTE_SUPPORT_UPDATED","REMOTE_SUPPORT_DELETED","MDM_LOCK_DEVICE_STATUS_CREATED","MDM_REBOOT_DEVICE_STATUS_CREATED","MDM_RESET_PASSCODE_DEVICE_STATUS_CREATED","MDM_RELINQUISH_OWNERSHIP_DEVICE_STATUS_CREATED","MDM_LOCK_DEVICE_STATUS_UPDATED","MDM_REBOOT_DEVICE_STATUS_UPDATED","MDM_RESET_PASSCODE_DEVICE_STATUS_UPDATED","MDM_RELINQUISH_OWNERSHIP_DEVICE_STATUS_UPDATED","MDM_CLEAR_PASSCODE_STATUS_CREATED","MDM_CLEAR_PASSCODE_STATUS_UPDATED","MDM_ERASE_STATUS_CREATED","MDM_ERASE_STATUS_UPDATED","MDM_UPDATE_POLICY_STATUS_CREATED","MDM_UPDATE_POLICY_STATUS_UPDATED","MDM_ASSIGN_POLICY_STATUS_CREATED","MDM_ASSIGN_POLICY_STATUS_UPDATED","MDM_DIVISION_CONFIG_ENABLED","MDM_DIVISION_CONFIG_DISABLED","MDM_DIVISION_CONFIG_UPDATED","MDM_APN_CERTIFICATE_UPLOADED","MDM_ACTION_DEVICE_STATUS_FAILED","MDM_DISOWN_STATUS_FORBIDDEN","MDM_DISOWN_STATUS_COMPLETED","MDM_ADE_TOKEN_UPLOADED","MDM_ADE_TOKEN_RENEWED","MDM_RENEW_ENROLLMENT_PROFILE_STATUS_CREATED","MDM_RENEW_ENROLLMENT_PROFILE_STATUS_UPDATED","MDM_INSTALL_APP_STATUS_CREATED","MDM_APN_CERTIFICATE_RENEWED","MDM_CONNECTION_ANDROID_ENTERPRISE_RENAME_SUCCESS","MDM_CLEAR_APP_DATA_STATUS_CREATED","MDM_CLEAR_APP_DATA_STATUS_UPDATED","AOSP_ERASE_DEVICE_STATUS_CREATED","AOSP_ERASE_DEVICE_STATUS_COMPLETED","AOSP_LOCK_DEVICE_STATUS_CREATED","AOSP_LOCK_DEVICE_STATUS_UPDATED","AOSP_REBOOT_DEVICE_STATUS_CREATED","AOSP_REBOOT_DEVICE_STATUS_COMPLETED","AOSP_RESET_PASSCODE_DEVICE_STATUS_CREATED","AOSP_RESET_PASSCODE_DEVICE_STATUS_COMPLETED","AOSP_UPDATE_POLICY_STATUS_UPDATED","AOSP_NC_SESSION_REQUESTED","AOSP_NC_SESSION_STARTED","AOSP_NC_SESSION_TERMINATED","REPORT_TEMPLATE_CREATED","REPORT_TEMPLATE_UPDATED","REPORT_TEMPLATE_DELETED","REPORT_SCHEDULE_CREATED","REPORT_SCHEDULE_UPDATED","REPORT_SCHEDULE_DELETED","REPORT_TEMPLATE_DUPLICATED","REPORT_SCHEDULE_DUPLICATED","GRAVITYZONE_ENABLED","GRAVITYZONE_DISABLED","GRAVITYZONE_SCAN_STARTED","GRAVITYZONE_SCAN_COMPLETED","GRAVITYZONE_SCAN_FAILED","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE_FAILED","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE_FAILED","GRAVITYZONE_INSTALLATION_SUCCEEDED","GRAVITYZONE_INSTALLATION_SUCCEEDED_WITH_WARNINGS","GRAVITYZONE_INSTALLATION_FAILED","GRAVITYZONE_THREAT_IGNORED","GRAVITYZONE_THREAT_PRESENT","GRAVITYZONE_THREAT_DELETED","GRAVITYZONE_THREAT_BLOCKED","GRAVITYZONE_THREAT_REPORTED","GRAVITYZONE_THREAT_QUARANTINED","GRAVITYZONE_THREAT_CLEANED","GRAVITYZONE_PURGE_QUARANTINE_FAILED","GRAVITYZONE_PURGE_QUARANTINE_SUCCESS","GRAVITYZONE_THREAT_RESTORE_AND_EXCLUDED_FROM_QUARANTINE","GRAVITYZONE_THREAT_RESTORE_AND_EXCLUDED_FROM_QUARANTINE_FAILED","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE_COMPLETED","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE_COMPLETED","GRAVITYZONE_PROVISION_COMPLETED","GRAVITYZONE_PROVISION_FAILED","GRAVITYZONE_RETRY_INSTALL_COMPLETED","GRAVITYZONE_PARTNER_ASSIST_DISABLED","GRAVITYZONE_SCAN_ATTEMPT_COMPLETED","GRAVITYZONE_RESET_INACCESSIBLE_LICENSE_COMPLETED","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE_REQUESTED","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE_REQUESTED","GRAVITYZONE_THREAT_RESTORE_AND_EXCLUDED_FROM_QUARANTINE_REQUESTED","GRAVITYZONE_INSTALLATION_STARTED","GRAVITYZONE_DOWNLOAD_FAILED","GRAVITYZONE_INSTALLATION_RETRY_STARTED","GRAVITYZONE_SCAN_CANCELLED","GRAVITYZONE_DISABLING_FAILED","GRAVITYZONE_INSTALLATION_EXISTS_DETECTED","GRAVITYZONE_THREAT_BLOCKED_FROM_ACTIVE_REQUESTED","GRAVITYZONE_THREAT_BLOCKED_FROM_ACTIVE_COMPLETED","GRAVITYZONE_THREAT_BLOCKED_FROM_ACTIVE_FAILED","GRAVITYZONE_DEVICE_MANAGED","GRAVITYZONE_DEVICE_UNMANAGED","GRAVITYZONE_COMPANY_CANNOT_BE_ACCESSED","GRAVITYZONE_QUARANTINED_THREAT_DELETED_OR_RESTORED","GRAVITYZONE_SUCCEEDED_TO_REQUEST_RECONFIGURE_TASK","GRAVITYZONE_FAILED_TO_REQUEST_RECONFIGURE_TASK","GRAVITYZONE_ADVANCED_THREAT_DISINFECTED","GRAVITYZONE_ADVANCED_THREAT_BLOCKED","GRAVITYZONE_INCIDENT_REPORTED","GRAVITYZONE_INCIDENT_VISIBILITY_FLAG_UPDATED","GRAVITYZONE_EXTENDED_INCIDENT_REPORTED","GRAVITYZONE_THREAT_STILL_PRESENT_AFTER_SCAN","ATTACHMENT_FILE_SUSPICIOUS","SMTP_SEND_ERROR","TECHNICIAN_ROLE_CREATED","TECHNICIAN_ROLE_UPDATED","TECHNICIAN_ROLE_DELETED","TECHNICIAN_ROLE_ASSIGNMENT_CHANGED","TECHNICIAN_PERMISSIONS_CHANGED","END_USER_ROLE_CREATED","END_USER_ROLE_UPDATED","END_USER_ROLE_DELETED","END_USER_ROLE_ASSIGNMENT_CHANGED","END_USER_PERMISSIONS_CHANGED","SENTINEL_ONE_AGENT_ENABLED","SENTINEL_ONE_AGENT_DISABLED","SENTINEL_ONE_AGENT_STARTED","SENTINEL_ONE_AGENT_UPGRADED","SENTINEL_ONE_AGENT_SHUT_DOWN","SENTINEL_ONE_AGENT_INSTALLATION_SUCCEEDED","SENTINEL_ONE_INSTALLATION_ANOTHER_AV_DETECTED","SENTINEL_ONE_AGENT_INSTALLATION_FAILED","SENTINEL_ONE_POLICY_CHANGED","SENTINEL_ONE_LOCAL_CONFIG_CHANGE_FAILED","SENTINEL_ONE_REGISTRATION_SUCCEEDED","SENTINEL_ONE_REGISTRATION_FAILED","SENTINEL_ONE_REMEDIATION_SUCCEEDED","SENTINEL_ONE_REMEDIATION_FAILED","SENTINEL_ONE_MITIGATION_SUCCEEDED","SENTINEL_ONE_MITIGATION_FAILED","SENTINEL_ONE_MITIGATION_REQUIRE_REBOOT","SENTINEL_ONE_MITIGATION_CANNOT_KILL","SENTINEL_ONE_MITIGATION_FAILED_TO_KILL","SENTINEL_ONE_QUARANTINE_SUCCEEDED","SENTINEL_ONE_QUARANTINE_FAILED","SENTINEL_ONE_UNQUARANTINE_SUCCEEDED","SENTINEL_ONE_UNQUARANTINE_FAILED","SENTINEL_ONE_THREAT_DETECTED","SENTINEL_ONE_SCAN_STARTED","SENTINEL_ONE_SCAN_COMPLETED","SENTINEL_ONE_SCAN_FAILED","SENTINEL_ONE_SCAN_ABORTED","SENTINEL_ONE_COMMAND_RECEIVED","SENTINEL_ONE_COMMAND_FAILED","SENTINEL_ONE_AGENT_UPGRADE_SUCCEEDED","SENTINEL_ONE_SITE_TOKEN_REGENERATED","SENTINEL_ONE_ON_DEMAND_SCAN_STARTED","SENTINEL_ONE_ON_DEMAND_SCAN_COMPLETED","SENTINEL_ONE_ON_DEMAND_SCAN_ABORTED","SENTINEL_ONE_RETRY_INSTALL_COMPLETED","SENTINEL_ONE_REFRESH_API_TOKEN_SUCCEEDED","SENTINEL_ONE_REFRESH_API_TOKEN_FAILED","SENTINEL_ONE_INTEGRATION_ENABLED","SENTINEL_ONE_INTEGRATION_DISABLED","SENTINEL_ONE_INTEGRATION_CREDENTIALS_UPDATED","SENTINEL_ONE_INTEGRATION_RESYNC_INITIATED","SENTINEL_ONE_INTEGRATION_RESYNC_REQUIRED","SENTINEL_ONE_EXISTING_INSTALLATION_DETECTED","SENTINEL_ONE_AGENT_SYNC_SUCCESS","SENTINEL_ONE_AGENT_SYNC_FAILED_RETRY","SENTINEL_ONE_AGENT_SYNC_FAILED","SENTINEL_ONE_AGENT_SYNC_CANCELLED","SENTINEL_ONE_AGENT_SYNC_MAPPING_FAILED","OAUTH2_CREATED","OAUTH2_UPDATED","OAUTH2_DELETED","CROWDSTRIKE_SENSOR_ENABLED","CROWDSTRIKE_SENSOR_DISABLED","CROWDSTRIKE_SENSOR_STARTED","CROWDSTRIKE_SENSOR_UPGRADED","CROWDSTRIKE_SENSOR_SHUT_DOWN","CROWDSTRIKE_SENSOR_INSTALLATION_SUCCEEDED","CROWDSTRIKE_SENSOR_INSTALLATION_FAILED","CROWDSTRIKE_REGISTRATION_SUCCEEDED","CROWDSTRIKE_REGISTRATION_FAILED","CROWDSTRIKE_REMEDIATION_SUCCEEDED","CROWDSTRIKE_REMEDIATION_FAILED","CROWDSTRIKE_MITIGATION_SUCCEEDED","CROWDSTRIKE_MITIGATION_FAILED","CROWDSTRIKE_QUARANTINE_SUCCEEDED","CROWDSTRIKE_QUARANTINE_FAILED","CROWDSTRIKE_THREAT_DETECTED","CROWDSTRIKE_MISSING_PERMISSIONS","CROWDSTRIKE_CREDENTIAL_INVALID","CROWDSTRIKE_INSTALLATION_ANOTHER_AV_DETECTED","CROWDSTRIKE_ENABLED","CROWDSTRIKE_DISABLED","CROWDSTRIKE_CREDENTIALS_UPDATED","CROWDSTRIKE_EXISTING_INSTALLATION_DETECTED","CROWDSTRIKE_RETRY_INSTALL_COMPLETED","CROWDSTRIKE_MISSING_API_CLIENT_SCOPE","CROWDSTRIKE_PARTNER_PROVISION_IN_PROGRESS","CROWDSTRIKE_PARTNER_PROVISION_COMPLETED","CROWDSTRIKE_PARTNER_PROVISION_FAILED","CROWDSTRIKE_CUSTOMER_PROVISION_IN_PROGRESS","CROWDSTRIKE_CUSTOMER_PROVISION_COMPLETED","CROWDSTRIKE_CUSTOMER_PROVISION_FAILED","CROWDSTRIKE_FALCON_COMPLETE_CREDENTIAL_INVALID","CROWDSTRIKE_MISSING_FALCON_COMPLETE_API_CLIENT_SCOPE","CROWDSTRIKE_UNMANAGED_INSTALLATION_DETECTED","CROWDSTRIKE_SENSOR_PROVISIONING","CROWDSTRIKE_SENSOR_MIGRATED","CROWDSTRIKE_CUSTOMER_BUNDLE_UPDATED","CROWDSTRIKE_CREDENTIAL_UNHEALTHY","CROWDSTRIKE_CREDENTIAL_VALIDATED","CROWDSTRIKE_FALCON_COMPLETE_CREDENTIAL_UNHEALTHY","CROWDSTRIKE_FALCON_COMPLETE_CREDENTIAL_VALIDATED","SERVICE_NOW_UPDATED","SERVICE_NOW_CONFIGURATION_ITEM_CLASS_MAPPING_CREATED","SERVICE_NOW_CONFIGURATION_ITEM_CLASS_MAPPING_UPDATED","SERVICE_NOW_CONFIGURATION_ITEM_CLASS_MAPPING_DELETED","SERVICE_NOW_RESET_AUTHENTICATION","SERVICE_NOW_NODE_SYNC_NODE_CREATED","SERVICE_NOW_NODE_SYNC_NODE_UPDATED","SERVICE_NOW_NODE_SYNC_NODE_ERROR","SERVICE_NOW_NODE_SYNC_BY_CLIENT_STARTED","SERVICE_NOW_NODE_SYNC_BY_CLIENT_COMPLETED","SERVICE_NOW_CLIENT_MAPPING_CREATED","SERVICE_NOW_CLIENT_MAPPING_UPDATED","SERVICE_NOW_CLIENT_MAPPING_DELETED","SERVICE_NOW_SYNC_CLIENT_ON_DEMAND","SERVICE_NOW_CLIENT_MAPPING_STATUS_UPDATED","ZENDESK_UPDATED","FRESHSERVICE_UPDATED","NINJA_TICKETING_CREATION_FAILED","NINJA_TICKETING_FORM_CREATED","NINJA_TICKETING_FORM_UPDATED","NINJA_TICKETING_FORM_ACTIVED","NINJA_TICKETING_FORM_DEACTIVED","NINJA_TICKETING_ATTRIBUTE_CREATED","NINJA_TICKETING_ATTRIBUTE_UPDATED","NINJA_TICKETING_ATTRIBUTE_ACTIVED","NINJA_TICKETING_ATTRIBUTE_DEACTIVATED","NINJA_TICKETING_RULESET_CREATED","NINJA_TICKETING_RULESET_UPDATED","NINJA_TICKETING_RULESET_DELETED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_CREATED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_UPDATED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_DELETED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_MAKE_DEFAULT","NINJA_TICKETING_TRIGGER_CREATED","NINJA_TICKETING_TRIGGER_UPDATED","NINJA_TICKETING_TRIGGER_DELETED","NINJA_TICKETING_TICKET_CREATED","NINJA_TICKETING_TICKET_DELETED","NINJA_TICKETING_PENDING_EMAIL_CREATION_APPROVED","NINJA_TICKETING_PENDING_EMAIL_UPDATE_APPROVED","NINJA_TICKETING_PENDING_EMAIL_REJECTED","NINJA_TICKETING_ENABLED","NINJA_TICKETING_DISABLED","NINJA_TICKETING_UPDATED","NINJA_TICKETING_FORM_MAKE_DEFAULT","NINJA_TICKETING_CONDITION_RULE_MAKE_DEFAULT","NINJA_TICKETING_SCRIPT_RULE_MAKE_DEFAULT","NINJA_TICKETING_PENDING_EMAIL_RECEIVED","NINJA_TICKETING_EMAIL_ALLOWLIST_ITEM_CREATED","NINJA_TICKETING_EMAIL_ALLOWLIST_ITEM_UPDATED","NINJA_TICKETING_EMAIL_ALLOWLIST_ITEM_DELETED","NINJA_TICKETING_EMAIL_BLOCKLIST_ITEM_CREATED","NINJA_TICKETING_EMAIL_BLOCKLIST_ITEM_UPDATED","NINJA_TICKETING_EMAIL_BLOCKLIST_ITEM_DELETED","NINJA_TICKETING_TICKET_REINSTATED","NINJA_TICKETING_STATUS_CREATED","NINJA_TICKETING_STATUS_UPDATED","NINJA_TICKETING_STATUS_DELETED","NINJA_TICKETING_AGREEMENT_BULK_UPDATED","KNOWLEDGE_BASE_DOCUMENT_CREATED","KNOWLEDGE_BASE_DOCUMENT_UPDATED","KNOWLEDGE_BASE_DOCUMENT_ARCHIVED","KNOWLEDGE_BASE_DOCUMENT_RESTORED","KNOWLEDGE_BASE_DOCUMENT_DELETED","KNOWLEDGE_BASE_FOLDER_CREATED","KNOWLEDGE_BASE_FOLDER_UPDATED","KNOWLEDGE_BASE_FOLDER_ARCHIVED","KNOWLEDGE_BASE_FOLDER_RESTORED","KNOWLEDGE_BASE_FOLDER_DELETED","KNOWLEDGE_BASE_PUBLIC_TEMPORARY_TOKEN_CREATED","KNOWLEDGE_BASE_PUBLIC_LINK_CREATED","KNOWLEDGE_BASE_PUBLIC_LINK_UPDATED","KNOWLEDGE_BASE_PUBLIC_LINK_DELETED","KNOWLEDGE_BASE_FOLDER_MOVED","KNOWLEDGE_BASE_DOCUMENT_MOVED","KNOWLEDGE_BASE_FOLDER_SHARED","KNOWLEDGE_BASE_FOLDER_ACCESS_RESTRICTED","DOCUMENT_TEMPLATE_CREATED","DOCUMENT_TEMPLATE_UPDATED","DOCUMENT_TEMPLATE_ARCHIVED","DOCUMENT_TEMPLATE_RESTORED","DOCUMENT_TEMPLATE_DELETED","CLIENT_DOCUMENT_CREATED","CLIENT_DOCUMENT_UPDATED","CLIENT_DOCUMENT_ARCHIVED","CLIENT_DOCUMENT_RESTORED","CLIENT_DOCUMENT_DELETED","CLIENT_DOCUMENT_ATTRIBUTE_VALUE_DECRYPTED","CLIENT_DOCUMENT_REVISION_DELETED","CLIENT_DOCUMENTATION_DELEGATE_NODE_RESPONSIBILITY_ADDED","CLIENT_DOCUMENTATION_DELEGATE_NODE_RESPONSIBILITY_REMOVED","CLIENT_DOCUMENT_ATTRIBUTE_TEMPORARY_PUBLIC_TOKEN_CREATED","CLIENT_CHECKLIST_CREATED","CLIENT_CHECKLIST_UPDATED","CLIENT_CHECKLIST_DELETED","CLIENT_CHECKLIST_PROMOTED","CLIENT_CHECKLIST_TEMPORARY_PUBLIC_TOKEN_CREATED","CLIENT_CHECKLIST_ARCHIVED","CLIENT_CHECKLIST_RESTORED","CHECKLIST_TEMPLATE_CREATED","CHECKLIST_TEMPLATE_UPDATED","CHECKLIST_TEMPLATE_DELETED","CHECKLIST_TEMPLATE_ARCHIVED","CHECKLIST_TEMPLATE_RESTORED","RELATED_ITEM_CREATED","RELATED_ITEM_UPDATED","RELATED_ITEM_DELETED","RELATED_ITEM_SECURE_VALUE_DECRYPTED","RELATED_ITEM_TEMPORARY_PUBLIC_TOKEN_CREATED","ANTIVIRUS_THREAT_MUTED","ANTIVIRUS_THREAT_UNMUTED","SUPPLIER_CREATED","SUPPLIER_UPDATED","SUPPLIER_DELETED","MAINTENANCE_MODE_CONFIGURED","MAINTENANCE_MODE_DELETED","MAINTENANCE_MODE_MODIFIED","MAINTENANCE_MODE_FAILED","MAINTENANCE_MODE_ACTIVE","MAINTENANCE_MODE_UPDATED","MAINTENANCE_MODE_COMPLETED","SIEM_EXPORTER_WEBHOOK_CREATED","SIEM_EXPORTER_WEBHOOK_DELETED","SIEM_EXPORTER_WEBHOOK_ENABLED","SIEM_EXPORTER_WEBHOOK_DISABLED","SIEM_EXPORTER_WEBHOOK_UPDATED","SIEM_EXPORTER_WEBHOOK_DISPATCH_FAILURE","SIEM_EXPORTER_ENABLED","SIEM_EXPORTER_DISABLED"]},"status":{"type":"string","description":"Status description"},"activityResult":{"type":"string","description":"Activity result","enum":["SUCCESS","FAILURE","UNSUPPORTED","UNCOMPLETED","MISSED"]},"sourceConfigUid":{"type":"string","description":"Source configuration/policy element reference","format":"uuid"},"sourceName":{"type":"string","description":"Source configuration/policy element name"},"subject":{"type":"string","description":"Activity subject"},"userId":{"type":"integer","description":"User identifier","format":"int32"},"message":{"type":"string","description":"Activity message"},"type":{"type":"string","description":"Activity type description"},"data":{"type":"object","additionalProperties":true,"description":"Activity data"}}}}}}}}}}}},"/v2/alerts":{"get":{"tags":["system"],"summary":"List active alerts (triggered conditions)","description":"Returns list of active alerts/triggered conditions","operationId":"getAlerts","parameters":[{"name":"sourceType","in":"query","schema":{"type":"string","description":"Alert Source filter"}},{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"lang","in":"query","description":"Language tag","schema":{"type":"string"}},{"name":"tz","in":"query","description":"Time Zone","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"uid":{"type":"string","description":"Alert UID (activity series UID)","format":"uuid"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"message":{"type":"string","description":"Alert message"},"createTime":{"type":"number","description":"Alert creation timestamp","format":"double"},"updateTime":{"type":"number","description":"Alert last updated","format":"double"},"sourceType":{"type":"string","description":"Alert origin","enum":["AGENT_OFFLINE","CONDITION_AGENT_CPU","CONDITION_AGENT_MEMORY","CONDITION_AGENT_NETWORK","CONDITION_AGENT_DISK_IO","CONDITION_AGENT_DISK_FREE_SPACE","CONDITION_AGENT_DISK_USAGE","CONDITION_AGENT_CVSS_SCORE","CONDITION_AGENT_PATCH_LAST_INSTALLED","CONDITION_NMS_CPU","CONDITION_NMS_MEMORY","CONDITION_NMS_NETWORK_TRAFFIC_BITS","CONDITION_NMS_NETWORK_ADAPTER_STATUS","CONDITION_NMS_NETWORK_TRAFFIC_PERCENT","CONDITION_NMS_NETWORK_STATUS","CONDITION_NMS_NETWORK_STATUS_CHANGE","CONDITION_NMS_SYSTEM_UPTIME","CONDITION_PING","CONDITION_PING_LATENCY","CONDITION_PING_PACKET_LOSS","CONDITION_PING_RESPONSE","CONDITION_SYSTEM_UPTIME","CONDITION_SMART_STATUS_DEGRATED","CONDITION_RAID_HEALTH_STATUS","CONDITION_SCRIPT_RESULT","CONDITION_HTTP","CONDITION_HTTP_RESPONSE","CONDITION_PORT","CONDITION_PORT_SCAN","CONDITION_SYSLOG","CONDITION_CONFIGURATION_FILE","CONDITION_SNMPTRAP","CONDITION_CRITICAL_EVENT","CONDITION_BATTERY_MONITORING","CONDITION_DNS","CONDITION_EMAIL","CONDITION_CUSTOM_SNMP","CONDITION_COMPOUND","SHADOWPROTECT_BACKUPJOB_CREATE","SHADOWPROTECT_BACKUPJOB_UPDATE","SHADOWPROTECT_BACKUPJOB_DELETE","SHADOWPROTECT_BACKUPJOB_EXECUTE","IMAGEMANAGER_MANAGEDFOLDER_CREATE","IMAGEMANAGER_MANAGEDFOLDER_UPDATE","IMAGEMANAGER_MANAGEDFOLDER_DELETE","IMAGEMANAGER_MANAGEDFOLDER_EXECUTE","TEAMVIEWER_CONNECTION","RETRIEVE_AGENT_LOGS","SCHEDULED_TASK","CONDITION_WINDOWS_EVENT_LOG_TRIGGERED","CONDITION_WINDOWS_SERVICE_STATE_CHANGED","UI_MESSAGE_ACTION_REBOOT","UI_MESSAGE_BD_INSTALLATION_ISSUES","GRAVITYZONE_UI_MESSAGE_INSTALLATION_ISSUES","AV_QUARANTINE_THREAT","AV_RESTORE_THREAT","AV_DELETE_THREAT","AV_REMOVE_THREAT","BITDEFENDER_RESTORE_THREAT","BITDEFENDER_DELETE_THREAT","CONDITION_BITLOCKER_STATUS","CONDITION_FILEVAULT_STATUS","CONDITION_LINUX_PROCESS","CONDITION_LINUX_Daemon","CONDITION_LINUX_PROCESS_RESOURCE","CONDITION_LINUX_PROCESS_RESOURCE_CPU","CONDITION_LINUX_PROCESS_RESOURCE_MEMORY","CONDITION_LINUX_DISK_FREE_SPACE","CONDITION_LINUX_DISK_USAGE","CONDITION_VM_AGGREGATE_CPU_USAGE","CONDITION_VM_DISK_USAGE","CONDITION_VM_HOST_DATASTORE","CONDITION_VM_HOST_UPTIME","CONDITION_VM_HOST_DEVICE_DOWN","CONDITION_VM_HOST_BAD_SENSORS","CONDITION_VM_HOST_SENSOR_HEALTH","CONDITION_VM_GUEST_GUEST_OPERATIONAL_MODE","CONDITION_VM_GUEST_SNAPSHOT_SIZE","CONDITION_VM_GUEST_SNAPSHOT_LIFESPAN","CONDITION_VM_GUEST_TOOLS_NOT_RUNNING","CONDITION_HV_GUEST_CHECKPOINT_SIZE","CONDITION_HV_GUEST_CHECKPOINT_LIFESPAN","CONDITION_SOFTWARE","CONDITION_WINDOWS_PROCESS_STATE","CONDITION_WINDOWS_PROCESS_RESOURCE_CPU","CONDITION_WINDOWS_PROCESS_RESOURCE_MEMORY","CONDITION_MAC_PROCESS_STATE","CONDITION_MAC_PROCESS_RESOURCE_CPU","CONDITION_MAC_PROCESS_RESOURCE_MEMORY","CONDITION_MAC_DEAMON","CONDITION_CUSTOM_FIELD","CONDITION_PENDING_REBOOT","CONDITION_LOCKHART_LAST_SUCCESSFUL_BACKUP"]},"sourceConfigUid":{"type":"string","description":"Source configuration/policy element reference","format":"uuid"},"sourceName":{"type":"string","description":"Source configuration/policy element name"},"subject":{"type":"string","description":"Alert subject"},"userId":{"type":"integer","description":"User identifier","format":"int32"},"psaTicketId":{"type":"object","description":"Related PSA ticket ID"},"ticketTemplateId":{"type":"integer","description":"PSA ticket template","format":"int32"},"data":{"type":"object","additionalProperties":true,"description":"Alert data"},"device":{"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"}},"description":"Device information."},"priority":{"type":"string"},"severity":{"type":"string"},"conditionName":{"type":"string"},"conditionHealthStatus":{"type":"string","enum":["UNKNOWN","HEALTHY","NEEDS_ATTENTION","UNHEALTHY"]},"useGlobalHealthStatus":{"type":"boolean"}}}}}}}}}},"/v2/automation/scripts":{"get":{"tags":["system"],"summary":"List all available automation scripts","description":"Returns list of all available automation scripts","operationId":"getAutomationScripts","parameters":[{"name":"lang","in":"query","description":"Language","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Script ID","format":"int32"},"name":{"type":"string","description":"Script Name"},"description":{"type":"string","description":"Script Description"},"active":{"type":"boolean","description":"Script is Active"},"language":{"type":"string","description":"Script Language"},"architecture":{"uniqueItems":true,"type":"array","description":"Applicable Architectures","items":{"type":"string","description":"Applicable Architectures"}},"operatingSystems":{"uniqueItems":true,"type":"array","description":"Applicable Operating Systems","items":{"type":"string","description":"Applicable Operating Systems"}},"scriptParameters":{"type":"array","description":"Script Parameters","items":{"type":"string","description":"Script Parameters"}},"scriptVariables":{"type":"array","description":"Script Variables","items":{"type":"object","properties":{"id":{"type":"string","description":"Script Variable ID"},"name":{"type":"string","description":"Script Variable Name"},"description":{"type":"string","description":"Script Variable Description"},"type":{"type":"string","description":"Script Variable Type","enum":["CHECKBOX","DATE","DATETIME","DECIMAL","INTEGER","IPADDRESS","DROPDOWN","TEXT","OTHER"]},"source":{"type":"string","description":"Script Variable Source","enum":["LITERAL","OTHER"]},"defaultValue":{"type":"string","description":"Script Variable Default Value"},"required":{"type":"boolean","description":"Script Variable is Required"},"valueList":{"type":"array","description":"Script Variable List of Possible Values","items":{"type":"string","description":"Script Variable List of Possible Values"}}},"description":"Script Variables"}},"createdBy":{"type":"string","description":"Script Created By"},"lastUpdatedBy":{"type":"string","description":"Script Last Updated By"},"createdOn":{"type":"number","description":"Script date of creation","format":"double"},"updatedOn":{"type":"number","description":"Script last updated date","format":"double"}}}}}}}}}},"/v2/device-custom-fields":{"get":{"tags":["system"],"summary":"Device Custom Fields","description":"Returns list of all custom fields","operationId":"getDeviceGlobalCustomFields","parameters":[{"name":"scopes","in":"query","description":"Comma-separated list of scopes","schema":{"type":"string","enum":["all,node,location,organization"]}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"entityType":{"type":"string","description":"Entity type that this custom field or operation applies to","enum":["USER","NODE","TICKET","DOCUMENT","INPUT_FIELD_FORM"]},"scope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition Scope","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"label":{"type":"string","description":"Label"},"description":{"type":"string","description":"Description"},"name":{"type":"string","description":"Name"},"defaultValue":{"type":"string","description":"Default Value"},"endUserPermission":{"type":"string","description":"End user access level for custom fields in the UI","enum":["HIDDEN","EDITABLE_OPTIONAL","EDITABLE_REQUIRED","READ_ONLY"]},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"content":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean"},"footerText":{"type":"string"},"tooltipText":{"type":"string"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}}},"system":{"type":"boolean","description":"System"},"active":{"type":"boolean","description":"Active"},"createTime":{"type":"number","description":"Create Time","format":"double"},"updateTime":{"type":"number","description":"Update Time","format":"double"}}}}}}}}}},"/v2/devices":{"get":{"tags":["system"],"summary":"List devices","description":"Returns list of devices (basic node information)","operationId":"getDevices","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of devices to return","schema":{"type":"integer","format":"int32"}},{"name":"after","in":"query","description":"Last Node ID from previous page","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"}},"description":"Device information."}}}}}}}},"/v2/devices-detailed":{"get":{"tags":["system"],"summary":"List devices (detailed)","description":"Returns list of devices with additional information","operationId":"getDevicesDetailed","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"pageSize","in":"query","schema":{"type":"integer","description":"Limit number of devices to return","format":"int32"}},{"name":"after","in":"query","schema":{"type":"integer","description":"Last Node ID from previous page","format":"int32"}}],"responses":{"200":{"description":"Devices information","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","description":"Polymorphic response. (Device-specific schema)","oneOf":[{"title":"Agent device","required":["deviceType"],"type":"object","description":"Device with an installed agent","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"os":{"type":"object","properties":{"manufacturer":{"type":"string","description":"Manufacturer"},"name":{"type":"string","description":"Name"},"architecture":{"type":"string","description":"Architecture"},"lastBootTime":{"type":"number","description":"Last boot time","format":"double"},"buildNumber":{"type":"string","description":"Build number"},"releaseId":{"type":"string","description":"Release ID"},"servicePackMajorVersion":{"type":"integer","description":"Service Pack Major Version","format":"int32"},"servicePackMinorVersion":{"type":"integer","description":"Service Pack Minor Version","format":"int32"},"locale":{"type":"string","description":"Locale"},"language":{"type":"string","description":"Language"},"needsReboot":{"type":"boolean","description":"Operating system has pending reboot requests"}},"description":"Operating System"},"system":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"manufacturer":{"type":"string","description":"Manufacturer"},"model":{"type":"string","description":"Model"},"biosSerialNumber":{"type":"string","description":"Bios Serial Number"},"serialNumber":{"type":"string","description":"Serial Number"},"assetSerialNumber":{"type":"string","description":"Asset Serial Number"},"domain":{"type":"string"},"domainRole":{"type":"string"},"numberOfProcessors":{"type":"integer","format":"int32"},"totalPhysicalMemory":{"type":"integer","format":"int64"},"virtualMachine":{"type":"boolean"},"chassisType":{"type":"string"}},"description":"Computer System (Chassis)"},"memory":{"type":"object","properties":{"capacity":{"type":"integer","description":"Capacity","format":"int64"}},"description":"Memory information"},"processors":{"type":"array","description":"Processors","items":{"type":"object","properties":{"architecture":{"type":"string","description":"Architecture"},"maxClockSpeed":{"type":"integer","description":"Max Clock Speed","format":"int64"},"clockSpeed":{"type":"integer","description":"Current Clock Speed","format":"int64"},"name":{"type":"string","description":"Name"},"numCores":{"type":"integer","description":"Number of Cores","format":"int32"},"numLogicalCores":{"type":"integer","description":"Number of Logical Cores]","format":"int32"}},"description":"Processors"}},"volumes":{"type":"array","description":"Disk Volumes","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"driveLetter":{"type":"string","description":"Drive Letter"},"label":{"type":"string","description":"Volume Label"},"deviceType":{"type":"string","description":"Device Type"},"fileSystem":{"type":"string","description":"File System Type"},"autoMount":{"type":"boolean","description":"Automatically Mounted"},"compressed":{"type":"boolean","description":"Compressed"},"capacity":{"type":"integer","description":"Capacity (bytes)","format":"int64"},"freeSpace":{"type":"integer","description":"Free Space (bytes)","format":"int64"},"serialNumber":{"type":"string","description":"Serial Number"},"bitLockerStatus":{"type":"object","properties":{"conversionStatus":{"type":"string","description":"Volume encryption or decryption status.","enum":["FULLY_DECRYPTED","FULLY_ENCRYPTED","ENCRYPTION_IN_PROGRESS","DECRYPTION_IN_PROGRESS","ENCRYPTION_PAUSED","DECRYPTION_PAUSED","UNKNOWN"]},"encryptionMethod":{"type":"string","description":"Indicated the encryption algorithm and key size used on the volume","enum":["NONE","AES_128_WITH_DIFFUSER","AES_256_WITH_DIFFUSER","AES_128","AES_256","HARDWARE_ENCRYPTION","XTS_AES_128","XTS_AES_256","UNKNOWN"]},"protectionStatus":{"type":"string","description":" indicates whether the volume and its encryption key (if any) are secured.","enum":["UNPROTECTED","PROTECTED","UNKNOWN","PENDING"]},"lockStatus":{"type":"string","description":"Indicates whether the contents of the volume are accessible from Windows","enum":["UNKNOWN","UNLOCKED","LOCKED"]},"initializedForProtection":{"type":"boolean","description":"Is initialized for protection"}},"description":"BitLocker Status"}},"description":"Disk Volumes"}},"lastLoggedInUser":{"type":"string","description":"Username that logged in most recently"},"deviceType":{"type":"string","description":"Device type","enum":["AgentDevice"]}}}]},{"title":"Cloud monitor: Ping","required":["deviceType"],"type":"object","description":"Cloud monitor that checks a target with ping","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is enabled?"},"interval":{"type":"integer","description":"Monitoring interval (seconds)","format":"int32"},"timeout":{"type":"integer","description":"Timeout (seconds)","format":"int32"},"target":{"type":"string","description":"Monitoring target (hostname, IP address or URL)"},"deviceType":{"type":"string","description":"Device type","enum":["CloudMonitorPing"]}}}]},{"title":"Cloud monitor: DNS","required":["deviceType"],"type":"object","description":"Cloud monitor that checks DNS resolution","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is enabled?"},"interval":{"type":"integer","description":"Monitoring interval (seconds)","format":"int32"},"timeout":{"type":"integer","description":"Timeout (seconds)","format":"int32"},"target":{"type":"string","description":"Monitoring target (hostname, IP address or URL)"},"deviceType":{"type":"string","description":"Device type","enum":["CloudMonitorDNS"]}}}]},{"title":"Cloud monitor: HTTP","required":["deviceType"],"type":"object","description":"Cloud monitor that checks an HTTP/HTTPS endpoint","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is enabled?"},"interval":{"type":"integer","description":"Monitoring interval (seconds)","format":"int32"},"timeout":{"type":"integer","description":"Timeout (seconds)","format":"int32"},"target":{"type":"string","description":"Monitoring target (hostname, IP address or URL)"},"deviceType":{"type":"string","description":"Device type","enum":["CloudMonitorHTTP"]}}}]},{"title":"Cloud monitor: Port scan","required":["deviceType"],"type":"object","description":"Cloud monitor that checks open ports on a target","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is enabled?"},"interval":{"type":"integer","description":"Monitoring interval (seconds)","format":"int32"},"timeout":{"type":"integer","description":"Timeout (seconds)","format":"int32"},"target":{"type":"string","description":"Monitoring target (hostname, IP address or URL)"},"deviceType":{"type":"string","description":"Device type","enum":["CloudMonitorPortScan"]}}}]},{"title":"Cloud monitor: Email server","required":["deviceType"],"type":"object","description":"Cloud monitor that checks an email server","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is enabled?"},"interval":{"type":"integer","description":"Monitoring interval (seconds)","format":"int32"},"timeout":{"type":"integer","description":"Timeout (seconds)","format":"int32"},"target":{"type":"string","description":"SMTP Host (hostname or IP address)"},"smtpPort":{"type":"integer","description":"SMTP Port","format":"int32"},"senderEmail":{"type":"string","description":"Sender's email (FROM)"},"recipientEmail":{"type":"string","description":"Recipient's email (TO)"},"deviceType":{"type":"string","description":"Device type","enum":["CloudMonitorEmailServer"]}}}]},{"title":"NMS server","required":["deviceType"],"type":"object","description":"Network management system server","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"deviceType":{"type":"string","description":"Device type","enum":["NMSServer"]}}}]},{"title":"NMS target","required":["deviceType"],"type":"object","description":"Network device monitored by an NMS server","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"deviceType":{"type":"string","description":"Device type","enum":["NMSTarget"]}}}]},{"title":"VM host","required":["deviceType"],"type":"object","description":"Virtualization host (VMware or Hyper-V)","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"cpuMhz":{"type":"integer","description":"CPU Frequency","format":"int64"},"cpuModel":{"type":"string","description":"CPU Model"},"htActive":{"type":"boolean","description":"Is Hyper-Threading active?"},"htAvailable":{"type":"boolean","description":"Is Hyper-Threading available?"},"lastBootTime":{"type":"number","description":"Last toot time","format":"double"},"memorySize":{"type":"integer","description":"Total memory size (bytes)","format":"int64"},"model":{"type":"string","description":"Model"},"name":{"type":"string","description":"Name"},"cpuCores":{"type":"integer","description":"Number of CPU Cores","format":"int32"},"cpuPackages":{"type":"integer","description":"Number of CPUs","format":"int32"},"cpuThreads":{"type":"integer","description":"Total number of logical CPU cores","format":"int32"},"serviceTag":{"type":"string","description":"Service Tag"},"vendor":{"type":"string","description":"Vendor"},"releaseName":{"type":"string","description":"Release Name"},"version":{"type":"string","description":"Version"},"buildNumber":{"type":"string","description":"Build number"},"deviceType":{"type":"string","description":"Device type","enum":["VMHost"]}}}]},{"title":"VM guest","required":["deviceType"],"type":"object","description":"Virtual machine guest (VMware or Hyper-V)","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"files":{"type":"string","description":"Guest VM Files"},"fullName":{"type":"string","description":"Full Name"},"lastBootTime":{"type":"number","description":"Last VM Boot Time","format":"double"},"memorySize":{"type":"integer","description":"VM Memory size (bytes)","format":"int64"},"coresPerSocket":{"type":"integer","description":"Number of Cores per Socket","format":"int32"},"cpuCores":{"type":"integer","description":"Total Number of CPU Cores","format":"int32"},"powerState":{"type":"string","description":"Current power state"},"toolsInstallType":{"type":"string","description":"Guest tools installation type"},"toolStatus":{"type":"string","description":"Guest tools status"},"toolsVersion":{"type":"string","description":"Guest tools version"},"guestOSFullName":{"type":"string","description":"Guest OS full name"},"guestOSFamily":{"type":"string","description":"Guest OS family"},"guestOSId":{"type":"string","description":"Guest OS identifier"},"toolsVersionStatus":{"type":"string","description":"Guest tools version status"},"snapshotCount":{"type":"integer","description":"Number of snapshots","format":"int32"},"snapshotTotalSize":{"type":"integer","description":"Total snapshot size (bytes)","format":"int64"},"deviceType":{"type":"string","description":"Device type","enum":["VMGuest"]}}}]},{"title":"MDM device","required":["deviceType"],"type":"object","description":"Mobile device managed through MDM","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"system":{"type":"object","properties":{"displayName":{"type":"string","description":"Display Name"},"name":{"type":"string","description":"Name"},"manufacturer":{"type":"string","description":"Manufacturer"},"model":{"type":"string","description":"Model"},"serialNumber":{"type":"string","description":"Serial Number"},"build":{"type":"string","description":"Build"}},"description":"Mdm System"},"memory":{"type":"object","properties":{"capacity":{"type":"integer","description":"Capacity","format":"int64"}},"description":"Memory information"},"network":{"type":"array","description":"Network information","items":{"type":"object","properties":{"imei":{"type":"string","description":"International Mobile Equipment Identity"},"eid":{"type":"string","description":"eUICC Identifier"},"meid":{"type":"string","description":"Mobile Equipment Identifier"},"phoneNumber":{"type":"string","description":"Device phone number"},"carrier":{"type":"string","description":"Network carrier name"},"iccId":{"type":"string","description":"Integrated Circuit Card Identifier"}},"description":"Network information"}},"volumes":{"type":"array","description":"Disk Volumes","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"driveLetter":{"type":"string","description":"Drive Letter"},"label":{"type":"string","description":"Volume Label"},"deviceType":{"type":"string","description":"Device Type"},"fileSystem":{"type":"string","description":"File System Type"},"autoMount":{"type":"boolean","description":"Automatically Mounted"},"compressed":{"type":"boolean","description":"Compressed"},"capacity":{"type":"integer","description":"Capacity (bytes)","format":"int64"},"freeSpace":{"type":"integer","description":"Free Space (bytes)","format":"int64"},"serialNumber":{"type":"string","description":"Serial Number"},"bitLockerStatus":{"type":"object","properties":{"conversionStatus":{"type":"string","description":"Volume encryption or decryption status.","enum":["FULLY_DECRYPTED","FULLY_ENCRYPTED","ENCRYPTION_IN_PROGRESS","DECRYPTION_IN_PROGRESS","ENCRYPTION_PAUSED","DECRYPTION_PAUSED","UNKNOWN"]},"encryptionMethod":{"type":"string","description":"Indicated the encryption algorithm and key size used on the volume","enum":["NONE","AES_128_WITH_DIFFUSER","AES_256_WITH_DIFFUSER","AES_128","AES_256","HARDWARE_ENCRYPTION","XTS_AES_128","XTS_AES_256","UNKNOWN"]},"protectionStatus":{"type":"string","description":" indicates whether the volume and its encryption key (if any) are secured.","enum":["UNPROTECTED","PROTECTED","UNKNOWN","PENDING"]},"lockStatus":{"type":"string","description":"Indicates whether the contents of the volume are accessible from Windows","enum":["UNKNOWN","UNLOCKED","LOCKED"]},"initializedForProtection":{"type":"boolean","description":"Is initialized for protection"}},"description":"BitLocker Status"}},"description":"Disk Volumes"}},"lastLoggedInUser":{"type":"string","description":"Last logged in user"},"deviceType":{"type":"string","description":"Device type","enum":["MdmDevice"]}}}]},{"title":"Unmanaged device","required":["deviceType"],"type":"object","description":"Device tracked without an agent or monitor","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"deviceType":{"type":"string","description":"Device type","enum":["UnmanagedDevice"]}}}]}]}}}}}}}},"/v2/notification-channels/enabled":{"get":{"tags":["system"],"summary":"List enabled notification channels","description":"Returns list of enabled notification channels","operationId":"getEnabledNotificationChannels","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Notification Channel ID","format":"int32"},"name":{"type":"string","description":"Notification Channel Name"},"description":{"type":"string","description":"Notification Channel Description"},"enabled":{"type":"boolean","description":"Notification Channel Enabled"},"type":{"type":"string","description":"Notification Channel Type","enum":["EMAIL","META_CHANNEL","PAGER_DUTY","SLACK","SMS","MICROSOFT_TEAMS","WEBHOOK","OTHER"]}}}}}}}}}},"/v2/system/custom-fields":{"get":{"tags":["system"],"summary":"Global custom fields","description":"Returns global custom field values","operationId":"getGlobalCustomFields","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}}}},"patch":{"tags":["system"],"summary":"Update global custom field values","description":"Update global custom field values.\n\n**Note:** setting or clearing TEXT_ENCRYPTED and TOTP fields requires an authorization_code access token from a signed-in user. With client_credentials tokens, a masked value sent back as read keeps the stored value, and any other value receives 403.","operationId":"updateGlobalCustomFields","requestBody":{"description":"Custom fields values. See the [**documentation**](/apidocs-beta/core-resources/articles/customFields/customFieldsValues/custom-fields-values) for more information.","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example using a single custom field":{"description":"Example using a single custom field","value":{"customFieldNameInteger":1}},"Example using multiple custom fields":{"description":"Example using multiple custom fields","value":{"customFieldNameInteger":1,"customFieldNameText":"Sample Text","customFieldNameClientLocation":{"entityIds":[1,2],"type":"CLIENT_LOCATION"}}}}}}},"responses":{"204":{"description":"No Content"}}}},"/v2/groups":{"get":{"tags":["system"],"summary":"List groups (saved searches)","description":"Returns list of groups","operationId":"getGroups","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Group identifier","format":"int32"},"name":{"type":"string","description":"Group Name"},"description":{"type":"string","description":"Group description"},"shared":{"type":"boolean","description":"Group is shared with all users?"},"created":{"type":"number","description":"Timestamp of group creation","format":"double"},"updated":{"type":"number","description":"Timestamp last update","format":"double"},"deviceCount":{"type":"integer","description":"Estimated/Last known device count.  Can be `null` if group membership has not been evaluated recently","format":"int32"},"lastEvaluated":{"type":"number","description":"Last evaluation time of group membership for nodes (search)","format":"double"}}}}}}}}}},"/v2/locations":{"get":{"tags":["system"],"summary":"List locations","description":"Returns flat list of all locations for all organizations","operationId":"getLocations","parameters":[{"name":"pageSize","in":"query","description":"Limit number of locations to return","schema":{"type":"integer","format":"int32"}},{"name":"after","in":"query","description":"Last Location Identifier from previous page","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"}}}}}}}}}},"/v2/roles":{"get":{"tags":["system"],"summary":"List device roles","description":"Returns list of device roles","operationId":"getNodeRoles_1","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"}}}}}}}},"/v2/notification-channels":{"get":{"tags":["system"],"summary":"List notification channels","description":"Returns list of notification channels","operationId":"getNotificationChannels","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Notification Channel ID","format":"int32"},"name":{"type":"string","description":"Notification Channel Name"},"description":{"type":"string","description":"Notification Channel Description"},"enabled":{"type":"boolean","description":"Notification Channel Enabled"},"type":{"type":"string","description":"Notification Channel Type","enum":["EMAIL","META_CHANNEL","PAGER_DUTY","SLACK","SMS","MICROSOFT_TEAMS","WEBHOOK","OTHER"]}}}}}}}}}},"/v2/organizations-detailed":{"get":{"tags":["system"],"summary":"List organizations (Detailed)","description":"Returns list of organizations with locations and policy mappings","operationId":"getOrganizationsDetailed","parameters":[{"name":"pageSize","in":"query","description":"Limit number of organizations to return","schema":{"type":"integer","format":"int32"}},{"name":"after","in":"query","description":"Last Organization Identifier from previous page","schema":{"type":"integer","format":"int32"}},{"name":"of","in":"query","description":"Organization filter","schema":{"type":"string"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"},"locations":{"type":"array","description":"List of locations","items":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"}},"policies":{"type":"array","description":"Node role policy assignments","items":{"type":"object","properties":{"nodeRoleId":{"type":"integer","description":"Node Role Identifier","format":"int32"},"policyId":{"type":"integer","description":"Policy Identifier","format":"int32"}},"description":"Node role policy assignments"}},"settings":{"type":"object","properties":{"trayicon":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"splashtop":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"teamviewer":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"backup":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"psa":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"}},"description":"Organization settings"}}}}}}}}}},"/v2/tasks":{"get":{"tags":["system"],"summary":"List scheduled tasks","description":"Returns list of registered scheduled tasks","operationId":"getScheduledTasks","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Scheduled Task identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"enabled":{"type":"boolean","description":"Is Enabled ?"},"created":{"type":"number","description":"Timestamp of Scheduled Task creation","format":"double"},"lastRun":{"type":"number","description":"Timestamp of last Scheduled Task run","format":"double"},"runCount":{"type":"integer","description":"Number of times scheduled task ran","format":"int32"}}}}}}}}}},"/v2/software-products":{"get":{"tags":["system"],"summary":"List supported 3rd party software","description":"Returns available software products (3rd party patching)","operationId":"getSoftwareProducts","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Product identifier","format":"uuid"},"vendorName":{"type":"string","description":"Vendor Name"},"productName":{"type":"string","description":"Product Name"},"installable":{"type":"boolean","description":"Installable"},"active":{"type":"boolean","description":"Active"}}}}}}}}}},"/v2/users":{"get":{"tags":["system"],"summary":"List users","description":"Returns list of users","operationId":"getUsers","parameters":[{"name":"userType","in":"query","description":"User type filter","schema":{"type":"string","enum":["TECHNICIAN","END_USER"]}},{"name":"includeRoles","in":"query","description":"Includes user role information","schema":{"type":"boolean","default":false}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"}}}}}}}},"/v2/devices/search":{"get":{"tags":["system"],"summary":"Find devices","description":"Returns list of entities matching search term","operationId":"search","parameters":[{"name":"q","in":"query","description":"Search query (name, logged on user name, IP address, etc.)","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Limit number of devices to return","schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"query":{"type":"string","description":"Search query"},"devices":{"type":"array","description":"Devices matching search query","items":{"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"score":{"type":"integer","description":"Match score","format":"int32"},"matchAttr":{"type":"string","description":"Name of the attribute that matched the query"},"matchAttrValue":{"type":"string","description":"Value of that attribute that matched"}},"description":"Devices matching search query"}}}}}}}}}},"/v2/backup/jobs":{"get":{"tags":["Backup"],"summary":"Backup jobs","description":"Returns list of backup jobs. If the stf (startTime) filter is not provided, results default to jobs starting since midnight UTC 7 days ago (a 7-8 day window depending on time of day); use stf to retrieve older jobs or a specific date range","operationId":"getBackupJobs","parameters":[{"name":"df","in":"query","description":"Device filter","schema":{"type":"string"}},{"name":"ddf","in":"query","description":"Deleted device filter","schema":{"type":"string"}},{"name":"sf","in":"query","description":"Backup job status filter","schema":{"type":"string"}},{"name":"ptf","in":"query","description":"Backup job planType filter","schema":{"type":"string"}},{"name":"stf","in":"query","description":"Backup job startTime filter. If omitted, defaults to jobs starting since midnight UTC 7 days ago, spanning 7-8 days depending on time of day. Format: 'after yyyy-MM-ddTHH:mm:ss.SSSZ' or 'between (yyyy-MM-ddTHH:mm:ss.SSSZ,yyyy-MM-ddTHH:mm:ss.SSSZ)', e.g. 'after 2026-05-01T00:00:00.000Z'","schema":{"type":"string"}},{"name":"include","in":"query","description":"Which devices include (active|deleted|all) default value active","schema":{"type":"string","default":"active"}},{"name":"cursor","in":"query","description":"Cursor name","schema":{"type":"string"}},{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"maximum":10000,"minimum":1,"type":"integer","format":"int32","default":10000}}],"responses":{"200":{"description":"Returns a backup job report","content":{"application/json":{"schema":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"jobId":{"type":"string","description":"Job id","format":"uuid"},"jobStartTime":{"type":"number","description":"Job start time","format":"double"},"jobEndTime":{"type":"number","description":"Job end time","format":"double"},"jobStatus":{"type":"string","description":"Job status"},"destination":{"type":"string","description":"Job destination"},"sourceJobId":{"type":"string","description":"Job source id","format":"uuid"},"planGuid":{"type":"string","description":"Plan id","format":"uuid"},"planName":{"type":"string","description":"Plan name"},"planType":{"type":"string","description":"Plan type"},"totalActualStorageBytes":{"type":"integer","description":"Total bytes","format":"int64"},"totalStoredBytes":{"type":"integer","description":"Total stored bytes","format":"int64"},"filesUploaded":{"type":"integer","description":"Files uploaded","format":"int64"},"organizationId":{"type":"integer","description":"Organization id","format":"int32"},"locationId":{"type":"integer","description":"Location id","format":"int32"},"deviceId":{"type":"integer","description":"Device id","format":"int32"},"upsyncJob":{"type":"object","properties":{"startTime":{"type":"number","description":"Upsync job start time","format":"double"},"endTime":{"type":"number","description":"Upsync job end time","format":"double"},"status":{"type":"string","description":"Upsync job status"},"filesUploaded":{"type":"integer","description":"Upsync job files uploaded","format":"int64"},"bytesUploaded":{"type":"integer","description":"Upsync job bytes uploaded","format":"int64"}},"description":"Upsync job details"}}}}}}}}}}}},"/v2/ticketing/attributes":{"get":{"tags":["ticketing"],"summary":"List ticket attributes","description":"Returns list of the ticket attributes","operationId":"getTicketAttributes","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"attributeType":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"customizeForEndUser":{"type":"boolean"},"nameForEndUser":{"type":"string"},"descriptionForEndUser":{"type":"string"},"endUserOption":{"type":"string"},"technicianOption":{"type":"string"},"content":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean"},"footerText":{"type":"string"},"tooltipText":{"type":"string"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}}},"system":{"type":"boolean"},"active":{"type":"boolean"},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"}}}}}}}}}},"/v2/ticketing/contact/contacts":{"get":{"tags":["ticketing"],"summary":"List contacts","description":"Returns list of contacts","operationId":"getContacts_1","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"clientId":{"type":"integer","format":"int32"},"clientName":{"type":"string"},"uid":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"jobTitle":{"type":"string"},"displayName":{"type":"string"},"manager":{"type":"object","properties":{"uid":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"deleted":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER","CONTACT"]},"displayName":{"type":"string"}}},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"}}}}}}}}}},"/v2/ticketing/ticket-form/{id}":{"get":{"tags":["ticketing"],"summary":"Ticket form","description":"Returns a ticket form with fields ","operationId":"getTicketFormById","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"endUserTitle":{"type":"string"},"content":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"integer","format":"int32"}},"timerSettings":{"type":"object","properties":{"enabled":{"type":"boolean"},"mode":{"type":"string","enum":["MANUAL","AUTO_START"]}}},"scopeTicketTypes":{"type":"array","items":{"type":"string","enum":["PROBLEM","QUESTION","INCIDENT","TASK","CHANGE_REQUEST","SERVICE_REQUEST","PROJECT","APPOINTMENT","MISCELLANEOUS"]}},"scopeOrgs":{"type":"object","properties":{"mode":{"type":"string","enum":["ALL","ALL_EXCEPT","ONLY"]},"ids":{"type":"array","items":{"type":"integer","format":"int32"}}}},"scopeTechRoles":{"type":"object","properties":{"mode":{"type":"string","enum":["ALL","ALL_EXCEPT","ONLY"]},"ids":{"type":"array","items":{"type":"integer","format":"int32"}}}},"scopeEndUserRoles":{"type":"object","properties":{"mode":{"type":"string","enum":["ALL","ALL_EXCEPT","ONLY"]},"ids":{"type":"array","items":{"type":"integer","format":"int32"}}}}}},"active":{"type":"boolean"},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"},"fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"attributeType":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"customizeForEndUser":{"type":"boolean"},"nameForEndUser":{"type":"string"},"descriptionForEndUser":{"type":"string"},"endUserOption":{"type":"string"},"technicianOption":{"type":"string"},"content":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean"},"footerText":{"type":"string"},"tooltipText":{"type":"string"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}}},"system":{"type":"boolean"},"active":{"type":"boolean"},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"}}}},"default":{"type":"boolean"}}}}}}}}},"/v2/ticketing/ticket-form":{"get":{"tags":["ticketing"],"summary":"List ticket forms","description":"Returns list of ticket forms with their fields. Optionally filters forms available for an organization and/or a ticket type","operationId":"getTicketForms","parameters":[{"name":"clientId","in":"query","description":"Organization identifier","schema":{"type":"integer","format":"int32"}},{"name":"ticketType","in":"query","description":"Ticket type","schema":{"type":"string","enum":["PROBLEM","QUESTION","INCIDENT","TASK","CHANGE_REQUEST","SERVICE_REQUEST","PROJECT","APPOINTMENT","MISCELLANEOUS"]}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"endUserTitle":{"type":"string"},"content":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"integer","format":"int32"}},"timerSettings":{"type":"object","properties":{"enabled":{"type":"boolean"},"mode":{"type":"string","enum":["MANUAL","AUTO_START"]}}},"scopeTicketTypes":{"type":"array","items":{"type":"string","enum":["PROBLEM","QUESTION","INCIDENT","TASK","CHANGE_REQUEST","SERVICE_REQUEST","PROJECT","APPOINTMENT","MISCELLANEOUS"]}},"scopeOrgs":{"type":"object","properties":{"mode":{"type":"string","enum":["ALL","ALL_EXCEPT","ONLY"]},"ids":{"type":"array","items":{"type":"integer","format":"int32"}}}},"scopeTechRoles":{"type":"object","properties":{"mode":{"type":"string","enum":["ALL","ALL_EXCEPT","ONLY"]},"ids":{"type":"array","items":{"type":"integer","format":"int32"}}}},"scopeEndUserRoles":{"type":"object","properties":{"mode":{"type":"string","enum":["ALL","ALL_EXCEPT","ONLY"]},"ids":{"type":"array","items":{"type":"integer","format":"int32"}}}}}},"active":{"type":"boolean"},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"},"fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"attributeType":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"customizeForEndUser":{"type":"boolean"},"nameForEndUser":{"type":"string"},"descriptionForEndUser":{"type":"string"},"endUserOption":{"type":"string"},"technicianOption":{"type":"string"},"content":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean"},"footerText":{"type":"string"},"tooltipText":{"type":"string"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}}},"system":{"type":"boolean"},"active":{"type":"boolean"},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"}}}},"default":{"type":"boolean"}}}}}}}}}},"/v2/ticketing/statuses":{"get":{"tags":["ticketing"],"summary":"Get list of ticket status","description":"Get list of ticket status ","operationId":"getAllStatuses","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"displayName":{"type":"string"},"parentId":{"type":"integer","format":"int32"},"statusId":{"type":"integer","format":"int32"}}}}}}}}}},"/v2/ticketing/trigger/boards":{"get":{"tags":["ticketing"],"summary":"List boards","description":"Returns list of ticketing boards","operationId":"getBoards","responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"uid":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string"},"conditions":{"type":"object","properties":{"any":{"uniqueItems":true,"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"},"params":{"type":"object","properties":{"repeat":{"type":"boolean"},"value":{"type":"string"}}}}}},"all":{"uniqueItems":true,"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"},"params":{"type":"object","properties":{"repeat":{"type":"boolean"},"value":{"type":"string"}}}}}}}},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"},"system":{"type":"boolean"},"columns":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"sortBy":{"uniqueItems":true,"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}},"ticketCount":{"type":"integer","format":"int32"}}}}}}}}}},"/v2/ticketing/trigger/board/{boardId}/run":{"post":{"tags":["ticketing"],"summary":"List of tickets for board","description":"Run a board. Returns list of tickets matching the board condition and filters. Allows pagination","operationId":"getTicketsByBoard","parameters":[{"name":"boardId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"sortBy":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"direction":{"type":"string","enum":["ASC","DESC"]}}}},"filters":{"uniqueItems":true,"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"},"params":{"type":"object","properties":{"repeat":{"type":"boolean"},"value":{"type":"string"}}}}}},"pageSize":{"maximum":1000,"minimum":1,"type":"integer","format":"int32"},"searchCriteria":{"maxLength":512,"minLength":0,"type":"string"},"includeColumns":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"lastCursorId":{"maximum":10000000,"minimum":0,"type":"integer","format":"int32"}}}}}},"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}},"metadata":{"type":"object","properties":{"columns":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"sortBy":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"direction":{"type":"string","enum":["ASC","DESC"]}}}},"attributes":{"type":"object","additionalProperties":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]}}}},"filters":{"uniqueItems":true,"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"},"params":{"type":"object","properties":{"repeat":{"type":"boolean"},"value":{"type":"string"}}}}}},"lastCursorId":{"type":"integer","format":"int32"},"allRequiredColumns":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"allColumns":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"columnNamesForExporting":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}}}}}}}}}},"/v2/ticketing/app-user-contact":{"get":{"tags":["ticketing"],"summary":"List of users by user type","description":"Returns list of users (contacts, end-user, technician)","operationId":"getAllUserAndContacts","parameters":[{"name":"pageSize","in":"query","description":"Limit number of records per page","schema":{"type":"integer","format":"int32","default":50}},{"name":"anchorNaturalId","in":"query","description":"Last User Identifier from previous page","schema":{"type":"integer","format":"int32","default":0}},{"name":"searchCriteria","in":"query","description":"Search by first name, last name or email address","schema":{"type":"string"}},{"name":"userType","in":"query","description":"User Type","schema":{"type":"string","enum":["TECHNICIAN","END_USER","CONTACT"]}},{"name":"clientId","in":"query","description":"Organization identifier","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns a list of all users and contacts","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"uid":{"type":"string","description":"Global identifier for the user","format":"uuid"},"id":{"type":"integer","description":"User identifier","format":"int32"},"clientId":{"type":"integer","description":"Client identifier","format":"int32"},"firstName":{"type":"string","description":"The user's first name"},"lastName":{"type":"string","description":"The user's last name"},"email":{"type":"string","description":"The user's email address"},"userType":{"type":"string","description":"System User Type","enum":["TECHNICIAN","END_USER","CONTACT"]},"naturalId":{"type":"string","description":"Last User Identifier"}}}}}}}}}},"/v2/user/end-users":{"get":{"tags":["system"],"summary":"End user list","description":"Get all end users","operationId":"getEndUsers_1","responses":{"200":{"description":"End user","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"enabled":{"type":"boolean","description":"User access status"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"email":{"type":"string","description":"Email address"},"phone":{"type":"string","description":"Phone number"},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"fullPortalAccess":{"type":"boolean","description":"Has full portal access"},"mustChangePw":{"type":"boolean","description":"Must change password during next login"},"mfaConfigured":{"type":"boolean","description":"At least one MFA method is configured"},"scimUser":{"type":"boolean","description":"User created by SCIM"},"authType":{"type":"string","description":"Authentication type, NATIVE or SSO"},"invitationStatus":{"type":"string","description":"User invitation status","enum":["REGISTERED","PENDING","EXPIRED"]},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"accessibleDeviceIds":{"type":"array","description":"Device IDs which user has access to","items":{"type":"integer","description":"Device IDs which user has access to","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}},"managerUid":{"type":"string","description":"Manager identifier","format":"uuid"}}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}},"post":{"tags":["management"],"summary":"Create end user","description":"Create an end user","operationId":"createEndUser","parameters":[{"name":"sendInvitation","in":"query","description":"Whether to send invitation to end user during creation","schema":{"type":"boolean","default":false}}],"requestBody":{"description":"End user creation payload","content":{"application/json":{"schema":{"required":["email","firstName","lastName"],"type":"object","properties":{"firstName":{"maxLength":150,"minLength":1,"type":"string","description":"First name should be between 1 and 150 characters"},"lastName":{"maxLength":150,"minLength":1,"type":"string","description":"Last name should be between 1 and 150 characters"},"email":{"type":"string","description":"Email address"},"phone":{"type":"string","description":"Phone number"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"fullPortalAccess":{"type":"boolean","description":"Gives end user full portal access"},"managerUid":{"type":"string","description":"Manager identifier","format":"uuid"}},"description":"Create end user request payload"}}},"required":true},"responses":{"200":{"description":"Created end user","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"enabled":{"type":"boolean","description":"User access status"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"email":{"type":"string","description":"Email address"},"phone":{"type":"string","description":"Phone number"},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"fullPortalAccess":{"type":"boolean","description":"Has full portal access"},"mustChangePw":{"type":"boolean","description":"Must change password during next login"},"mfaConfigured":{"type":"boolean","description":"At least one MFA method is configured"},"scimUser":{"type":"boolean","description":"User created by SCIM"},"authType":{"type":"string","description":"Authentication type, NATIVE or SSO"},"invitationStatus":{"type":"string","description":"User invitation status","enum":["REGISTERED","PENDING","EXPIRED"]},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"accessibleDeviceIds":{"type":"array","description":"Device IDs which user has access to","items":{"type":"integer","description":"Device IDs which user has access to","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}},"managerUid":{"type":"string","description":"Manager identifier","format":"uuid"}}}}}},"400":{"description":"Several possible validation errors"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/v2/user/end-user/{id}":{"get":{"tags":["Users"],"summary":"End user details","description":"Get details for a specific end user identifier","operationId":"getEndUser","parameters":[{"name":"id","in":"path","description":"End user identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"End user","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"enabled":{"type":"boolean","description":"User access status"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"email":{"type":"string","description":"Email address"},"phone":{"type":"string","description":"Phone number"},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"fullPortalAccess":{"type":"boolean","description":"Has full portal access"},"mustChangePw":{"type":"boolean","description":"Must change password during next login"},"mfaConfigured":{"type":"boolean","description":"At least one MFA method is configured"},"scimUser":{"type":"boolean","description":"User created by SCIM"},"authType":{"type":"string","description":"Authentication type, NATIVE or SSO"},"invitationStatus":{"type":"string","description":"User invitation status","enum":["REGISTERED","PENDING","EXPIRED"]},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"accessibleDeviceIds":{"type":"array","description":"Device IDs which user has access to","items":{"type":"integer","description":"Device IDs which user has access to","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}},"managerUid":{"type":"string","description":"Manager identifier","format":"uuid"}}}}}},"400":{"description":"Bad request or invalid user type"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"User not found"}}},"delete":{"tags":["management"],"summary":"Delete end user","description":"Delete an end user","operationId":"deleteEndUser","parameters":[{"name":"id","in":"path","description":"End user identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Deleted end user"},"400":{"description":"Several possible validation errors"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"User not found"}}},"patch":{"tags":["management"],"summary":"Update a specific end user","description":"Update a specific end user by their ID","operationId":"patchEndUser","parameters":[{"name":"id","in":"path","description":"End user identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"End user update payload","content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"maxLength":150,"minLength":1,"type":"string","description":"First name should be between 1 and 150 characters"},"lastName":{"maxLength":150,"minLength":1,"type":"string","description":"Last name should be between 1 and 150 characters"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"fullPortalAccess":{"type":"boolean","description":"Gives end user full portal access"},"managerUid":{"type":"string","description":"Manager identifier","format":"uuid"}},"description":"Patch end user request payload"}}},"required":true},"responses":{"200":{"description":"End user updated","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"enabled":{"type":"boolean","description":"User access status"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"email":{"type":"string","description":"Email address"},"phone":{"type":"string","description":"Phone number"},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"fullPortalAccess":{"type":"boolean","description":"Has full portal access"},"mustChangePw":{"type":"boolean","description":"Must change password during next login"},"mfaConfigured":{"type":"boolean","description":"At least one MFA method is configured"},"scimUser":{"type":"boolean","description":"User created by SCIM"},"authType":{"type":"string","description":"Authentication type, NATIVE or SSO"},"invitationStatus":{"type":"string","description":"User invitation status","enum":["REGISTERED","PENDING","EXPIRED"]},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"accessibleDeviceIds":{"type":"array","description":"Device IDs which user has access to","items":{"type":"integer","description":"Device IDs which user has access to","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}},"managerUid":{"type":"string","description":"Manager identifier","format":"uuid"}}}}}},"400":{"description":"Bad request or invalid user type"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"User not found"}}}},"/v2/user/end-user/{id}/custom-fields":{"get":{"tags":["Users"],"summary":"End user custom fields","description":"Returns list of end user custom fields","operationId":"getNodeCustomFields_3","parameters":[{"name":"id","in":"path","description":"End user identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"default":{"description":"default response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}}}},"patch":{"tags":["Users"],"summary":"Update Field Values","description":"Update end user custom field values.\n\n**Note:** setting or clearing TEXT_ENCRYPTED and TOTP fields requires an authorization_code access token from a signed-in user. With client_credentials tokens, a masked value sent back as read keeps the stored value, and any other value receives 403.","operationId":"updateNodeAttributeValues_3","parameters":[{"name":"id","in":"path","description":"End user identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Custom field values payload","content":{"application/json":{"schema":{"type":"object"},"examples":{"Example updating custom fields":{"description":"Example updating custom fields","value":{"additionalProp1":{},"additionalProp2":{},"additionalProp3":{}}}}}},"required":true},"responses":{"default":{"description":"default response","content":{"*/*":{}}}}}},"/v2/user/end-user/{id}/device-access":{"patch":{"tags":["management"],"summary":"Update device access for end user","description":"Add or remove up to 100 accessible devices for a specific end user by their ID","operationId":"patchEndUserDeviceAccess","parameters":[{"name":"id","in":"path","description":"End user identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"End user device access update payload","content":{"application/json":{"schema":{"type":"object","properties":{"addDeviceIds":{"type":"array","description":"List of device IDs to add access for the end user","items":{"type":"integer","description":"List of device IDs to add access for the end user","format":"int32"}},"removeDeviceIds":{"type":"array","description":"List of device IDs to remove access for the end user","items":{"type":"integer","description":"List of device IDs to remove access for the end user","format":"int32"}}},"description":"Patch end user accessible devices request payload"}}},"required":true},"responses":{"200":{"description":"End user accessible devices updated","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"enabled":{"type":"boolean","description":"User access status"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"email":{"type":"string","description":"Email address"},"phone":{"type":"string","description":"Phone number"},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"fullPortalAccess":{"type":"boolean","description":"Has full portal access"},"mustChangePw":{"type":"boolean","description":"Must change password during next login"},"mfaConfigured":{"type":"boolean","description":"At least one MFA method is configured"},"scimUser":{"type":"boolean","description":"User created by SCIM"},"authType":{"type":"string","description":"Authentication type, NATIVE or SSO"},"invitationStatus":{"type":"string","description":"User invitation status","enum":["REGISTERED","PENDING","EXPIRED"]},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"accessibleDeviceIds":{"type":"array","description":"Device IDs which user has access to","items":{"type":"integer","description":"Device IDs which user has access to","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}},"managerUid":{"type":"string","description":"Manager identifier","format":"uuid"}}}}}},"400":{"description":"Bad request or invalid user type"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"User not found"}}}},"/v2/user/technicians":{"get":{"tags":["system"],"summary":"Technicians list","description":"Get all technicians","operationId":"getTechnicians","responses":{"200":{"description":"Technician","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"enabled":{"type":"boolean","description":"User access status"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"email":{"type":"string","description":"Email address"},"phone":{"type":"string","description":"Phone number"},"mustChangePw":{"type":"boolean","description":"Must change password during next login"},"mfaConfigured":{"type":"boolean","description":"At least one MFA method is configured"},"scimUser":{"type":"boolean","description":"User is created by SCIM?"},"authType":{"type":"string","description":"Native or SSO authentication"},"userType":{"type":"string","description":"User type","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","description":"User invitation status","enum":["REGISTERED","PENDING","EXPIRED"]},"notifyAllClients":{"type":"boolean","description":"Notifications for all clients"},"administrator":{"type":"boolean","description":"Technician is a System Administrator"},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the technician. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the technician. This is provided when the 'includeRoles' query parameter is set to 'true'"}},"managerUid":{"type":"string","description":"Manager identifier","format":"uuid"}}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}},"post":{"tags":["management"],"summary":"Create a technician","description":"Create a new technician","operationId":"createTechnician","requestBody":{"description":"Technician creation payload","content":{"application/json":{"schema":{"required":["email","firstName","lastName"],"type":"object","properties":{"firstName":{"maxLength":150,"minLength":1,"type":"string","description":"First name should be between 1 and 150 characters"},"lastName":{"maxLength":150,"minLength":1,"type":"string","description":"Last name should be between 1 and 150 characters"},"email":{"type":"string","description":"Email address"},"phone":{"type":"string","description":"Phone number"},"managerUid":{"type":"string","description":"Manager identifier","format":"uuid"}},"description":"Create technician request payload"}}},"required":true},"responses":{"200":{"description":"Created technician","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"enabled":{"type":"boolean","description":"User access status"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"email":{"type":"string","description":"Email address"},"phone":{"type":"string","description":"Phone number"},"mustChangePw":{"type":"boolean","description":"Must change password during next login"},"mfaConfigured":{"type":"boolean","description":"At least one MFA method is configured"},"scimUser":{"type":"boolean","description":"User is created by SCIM?"},"authType":{"type":"string","description":"Native or SSO authentication"},"userType":{"type":"string","description":"User type","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","description":"User invitation status","enum":["REGISTERED","PENDING","EXPIRED"]},"notifyAllClients":{"type":"boolean","description":"Notifications for all clients"},"administrator":{"type":"boolean","description":"Technician is a System Administrator"},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the technician. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the technician. This is provided when the 'includeRoles' query parameter is set to 'true'"}},"managerUid":{"type":"string","description":"Manager identifier","format":"uuid"}}}}}},"400":{"description":"Several possible validation errors"},"401":{"description":"Unauthorized"},"403":{"description":"Must be a System Administrator"}}}},"/v2/user/technician/{id}":{"get":{"tags":["Users"],"summary":"Technician details","description":"Get details for a specific technician identifier","operationId":"getTechnician","parameters":[{"name":"id","in":"path","description":"Technician identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Technician","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"enabled":{"type":"boolean","description":"User access status"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"email":{"type":"string","description":"Email address"},"phone":{"type":"string","description":"Phone number"},"mustChangePw":{"type":"boolean","description":"Must change password during next login"},"mfaConfigured":{"type":"boolean","description":"At least one MFA method is configured"},"scimUser":{"type":"boolean","description":"User is created by SCIM?"},"authType":{"type":"string","description":"Native or SSO authentication"},"userType":{"type":"string","description":"User type","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","description":"User invitation status","enum":["REGISTERED","PENDING","EXPIRED"]},"notifyAllClients":{"type":"boolean","description":"Notifications for all clients"},"administrator":{"type":"boolean","description":"Technician is a System Administrator"},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the technician. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the technician. This is provided when the 'includeRoles' query parameter is set to 'true'"}},"managerUid":{"type":"string","description":"Manager identifier","format":"uuid"}}}}}},"400":{"description":"Bad request or invalid user type"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Technician not found"}}},"delete":{"tags":["management"],"summary":"Delete a technician","description":"Delete a technician by their ID","operationId":"deleteTechnician","parameters":[{"name":"id","in":"path","description":"Technician identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Deleted technician"},"400":{"description":"Several possible validation errors"},"401":{"description":"Unauthorized"},"403":{"description":"Must be a System Administrator"},"404":{"description":"Technician was not found"}}},"patch":{"tags":["management"],"summary":"Update a technician","description":"Update technician by their ID","operationId":"updateTechnician","parameters":[{"name":"id","in":"path","description":"Technician identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Technician update payload","content":{"application/json":{"schema":{"type":"object","properties":{"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"managerUid":{"type":"string","description":"Manager identifier","format":"uuid"}},"description":"Update technician request payload"}}},"required":true},"responses":{"200":{"description":"Updated technician"},"400":{"description":"Several possible validation errors"},"401":{"description":"Unauthorized"},"403":{"description":"Must be a System Administrator"},"404":{"description":"Technician was not found"}}}},"/v2/user/role/{roleId}/add-members":{"patch":{"tags":["management"],"summary":"Add user role members","description":"Add members to user role","operationId":"addUserRoleMembers","parameters":[{"name":"roleId","in":"path","description":"Role identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Member IDs to add","content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}},"required":true},"responses":{"200":{"description":"User role","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Role identifier","format":"int32"},"name":{"type":"string","description":"Role name"},"type":{"type":"string","description":"Role type"},"description":{"type":"string","description":"Role description"},"members":{"type":"array","description":"Role members","items":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"email":{"type":"string","description":"User email"},"name":{"type":"string","description":"User full name"},"source":{"type":"string","description":"Source of role assignment"}},"description":"Role members"}}}}}}},"400":{"description":"Several possible validation errors"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Role or members not found"}}}},"/v2/user/roles":{"get":{"tags":["system"],"summary":"Get user roles","description":"Get list of user roles","operationId":"getUserRoles","parameters":[{"name":"roleType","in":"query","description":"User role type filter","schema":{"type":"string","enum":["TECHNICIAN","END_USER"]}}],"responses":{"200":{"description":"User roles","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Role identifier","format":"int32"},"name":{"type":"string","description":"Role name"},"type":{"type":"string","description":"Role type"},"description":{"type":"string","description":"Role description"},"members":{"type":"array","description":"Role members","items":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"email":{"type":"string","description":"User email"},"name":{"type":"string","description":"User full name"},"source":{"type":"string","description":"Source of role assignment"}},"description":"Role members"}}}}}}}},"401":{"description":"Unauthorized"}}}},"/v2/user/role/{roleId}/remove-members":{"patch":{"tags":["management"],"summary":"Remove users from user role","description":"Remove users from user role ","operationId":"removeUserRoleMembers","parameters":[{"name":"roleId","in":"path","description":"Role identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Member IDs to remove","content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}},"required":true},"responses":{"200":{"description":"User role","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","description":"Role identifier","format":"int32"},"name":{"type":"string","description":"Role name"},"type":{"type":"string","description":"Role type"},"description":{"type":"string","description":"Role description"},"members":{"type":"array","description":"Role members","items":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"email":{"type":"string","description":"User email"},"name":{"type":"string","description":"User full name"},"source":{"type":"string","description":"Source of role assignment"}},"description":"Role members"}}}}}}},"400":{"description":"Several possible validation errors"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Role or members not found"}}}},"/v2/user/role/{roleId}/permissions/organizations":{"patch":{"tags":["management"],"summary":"Set organization access permissions for a role","description":"Set up to 100 organization access permissions for a technician role","operationId":"setOrganizationPermissions","parameters":[{"name":"roleId","in":"path","description":"Role identifier","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Organization permission settings payload","content":{"application/json":{"schema":{"uniqueItems":true,"type":"array","items":{"required":["organizationId","permission"],"type":"object","properties":{"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"permission":{"type":"string","description":"Permissions for the organization.","enum":["default","noAccess","view","viewUpdate","viewUpdateDelete"]}},"description":"Organization permission entry for a role"}}}},"required":true},"responses":{"200":{"description":"Role organization permissions","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","description":"Role name"},"description":{"type":"string","description":"Role description"},"organizationPermissions":{"type":"array","description":"Organization permissions updated for the provided role","items":{"type":"object","properties":{"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"organizationName":{"type":"string","description":"Organization name"},"permission":{"type":"string","description":"Permissions for the organization.","enum":["default","noAccess","view","viewUpdate","viewUpdateDelete"]}},"description":"Organization permissions updated for the provided role"}}}}}}},"400":{"description":"Bad request or request limit reached"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Role or organization not found"}}}}},"components":{"schemas":{"Contact":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"organizationId":{"type":"integer","format":"int32"},"uid":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"jobTitle":{"type":"string"}}},"CreateContactRequest":{"required":["email"],"type":"object","properties":{"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"firstName":{"maxLength":150,"minLength":1,"type":"string","description":"First name should be between 1 and 150 characters"},"lastName":{"maxLength":150,"minLength":1,"type":"string","description":"First name should be between 1 and 150 characters"},"email":{"type":"string","description":"Email address"},"phone":{"type":"string","description":"Contact Phone number"},"jobTitle":{"maxLength":150,"type":"string","description":"Job title should be between 0 and 150 characters"},"managerUuid":{"type":"string","description":"UUID of the manager","format":"uuid"}},"description":"Create contact request payload"},"ContactPatchRequest":{"type":"object","properties":{"firstName":{"maxLength":150,"type":"string","description":"First name should be between 0 and 150 characters"},"lastName":{"maxLength":150,"type":"string","description":"Last name should be between 0 and 150 characters"},"email":{"type":"string","description":"Email address"},"jobTitle":{"maxLength":150,"type":"string","description":"Job title should be between 0 and 150 characters"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"phone":{"type":"string","description":"Phone number"}},"description":"Patch contact request payload"},"CreateNodeRoleRequest":{"type":"object","properties":{"nodeClass":{"type":"string","description":"Node Class of the Device Role. Should match Parent Device Role's Node Class.","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleParentName":{"type":"string","description":"Name of a Device Parent that will be created in this request that will act as the Parent Device Role for this Device Role. Should be null if nodeRoleParentId is assigned."},"nodeRoleParentId":{"type":"integer","description":"Id of an already existing Device Role to create this Node Role Under. Should be null if nodeRoleParentName is assigned.","format":"int32"},"name":{"type":"string","description":"Device Role Name. Must be unique."},"description":{"type":"string","description":"Device Role Description."},"chassisType":{"type":"string","description":"Chassis Type for the Managed Device Roles that utilize it such as Workstations. Should be null if unused.","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"icon":{"type":"string","description":"Icon Name of white-listed icon to be used for Unmanaged Device Roles. Should be null for all Managed Device Roles."}}},"NodeRolePublicApiDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role Id","format":"int32"},"nodeClass":{"type":"string","description":"Node Class of the Device Role","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeClassGroup":{"type":"string","description":"Node Class Group","enum":["RMM","RMM_INTEGRATION","MDM","VMM","NMS","CLOUD_MONITORING","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"policyId":{"type":"integer","description":"Policy Id","format":"int32"},"policyName":{"type":"string","description":"Policy Name"},"nodeRoleParentId":{"type":"integer","description":"Parent Device Role Id","format":"int32"},"custom":{"type":"boolean","description":"Custom"},"name":{"type":"string","description":"Device Role Name"},"description":{"type":"string","description":"Device Role Description"},"chassisType":{"type":"string","description":"Device Role Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Created Time","format":"double"},"entityType":{"type":"string","description":"Device Role custom Icon name. Only applicable for Unmanaged Device Role"}}},"DeleteNodeRoleRequest":{"type":"object","properties":{"ids":{"type":"array","description":"Ids of the Custom Device Roles to delete. System Default Device Roles can not be deleted.","items":{"type":"integer","description":"Ids of the Custom Device Roles to delete. System Default Device Roles can not be deleted.","format":"int32"}}}},"UpdateNodeRoleRequest":{"type":"object","properties":{"id":{"type":"integer","description":"Id of the Device Role to update.","format":"int32"},"name":{"type":"string","description":"Device Role Name. Must be unique."},"description":{"type":"string","description":"Device Role Description"},"icon":{"type":"string","description":"Icon Name of white-listed icon to be used for Unmanaged Device Roles. Should be null for all Managed Device Roles."}}},"CustomFieldPolicyConditionResponse":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition id"},"conditionName":{"type":"string","description":"Policy condition name"},"displayName":{"type":"string","description":"Policy condition display name"},"enabled":{"type":"boolean","description":"Policy condition enabled"},"severity":{"type":"string","description":"Policy condition severity","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"]},"priority":{"type":"string","description":"Policy condition priority","enum":["NONE","LOW","MEDIUM","HIGH"]},"channels":{"uniqueItems":true,"type":"array","description":"Policy condition notification channels","items":{"type":"integer","description":"Policy condition notification channels","format":"int32"}},"scripts":{"type":"array","description":"Policy condition scripts","items":{"type":"object","properties":{"scriptId":{"type":"integer","description":"Policy condition script id","format":"int32"},"runAs":{"type":"string","description":"Policy condition script runAs","enum":["SYSTEM","LOGGED_ON_USER","LOCAL_ADMIN","DOMAIN_ADMIN","PREFERRED_CREDENTIAL_MAC","PREFERRED_CREDENTIAL_LINUX"],"default":"SYSTEM"},"scriptParam":{"type":"string","description":"Policy condition script parameter"},"scriptVariables":{"maxItems":20,"minItems":0,"type":"array","description":"Policy condition script variables","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition script variable Id"},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Policy condition script variable value"}},"description":"Policy condition script variable"}}},"description":"Policy condition script"}},"notificationAction":{"type":"string","description":"Policy condition notification action","enum":["NONE","SEND"]},"notifyOnReset":{"type":"boolean","description":"Policy condition notify on reset"},"resetThreshold":{"type":"integer","description":"Policy condition reset threshold (seconds)","format":"int32"},"inheritance":{"type":"object","properties":{"inherited":{"type":"boolean","description":"Is policy condition inherited"},"overridden":{"type":"boolean","description":"Is policy condition overridden"},"sourcePolicyId":{"type":"integer","description":"Id of the policy where the value originates; may be an ancestor above the immediate parent","format":"int32"}},"description":"Policy condition inheritance status"},"matchAll":{"type":"array","description":"Custom field value must meet all conditions","items":{"required":["fieldName","operator","value"],"type":"object","properties":{"fieldName":{"maxLength":250,"minLength":0,"type":"string","description":"Custom field name"},"operator":{"type":"string","description":"Custom field operator","enum":["EQUALS","NOT_EQUALS","LESS_THAN","LESS_OR_EQUAL_THAN","GREATER_THAN","GREATER_OR_EQUAL_THAN","IS_NOT_NULL","CONTAINS","CONTAINS_NONE","CONTAINS_ANY"]},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Custom field value"}},"description":"Policy condition custom field"}},"matchAny":{"type":"array","description":"Custom field value must meet any conditions","items":{"required":["fieldName","operator","value"],"type":"object","properties":{"fieldName":{"maxLength":250,"minLength":0,"type":"string","description":"Custom field name"},"operator":{"type":"string","description":"Custom field operator","enum":["EQUALS","NOT_EQUALS","LESS_THAN","LESS_OR_EQUAL_THAN","GREATER_THAN","GREATER_OR_EQUAL_THAN","IS_NOT_NULL","CONTAINS","CONTAINS_NONE","CONTAINS_ANY"]},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Custom field value"}},"description":"Policy condition custom field"}}},"description":"Custom fields policy condition response payload"},"PolicyConditionCustomField":{"required":["fieldName","operator","value"],"type":"object","properties":{"fieldName":{"maxLength":250,"minLength":0,"type":"string","description":"Custom field name"},"operator":{"type":"string","description":"Custom field operator","enum":["EQUALS","NOT_EQUALS","LESS_THAN","LESS_OR_EQUAL_THAN","GREATER_THAN","GREATER_OR_EQUAL_THAN","IS_NOT_NULL","CONTAINS","CONTAINS_NONE","CONTAINS_ANY"]},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Custom field value"}},"description":"Policy condition custom field"},"PolicyConditionInheritanceStatus":{"type":"object","properties":{"inherited":{"type":"boolean","description":"Is policy condition inherited"},"overridden":{"type":"boolean","description":"Is policy condition overridden"},"sourcePolicyId":{"type":"integer","description":"Id of the policy where the value originates; may be an ancestor above the immediate parent","format":"int32"}},"description":"Policy condition inheritance status"},"PolicyConditionScript":{"type":"object","properties":{"scriptId":{"type":"integer","description":"Policy condition script id","format":"int32"},"runAs":{"type":"string","description":"Policy condition script runAs","enum":["SYSTEM","LOGGED_ON_USER","LOCAL_ADMIN","DOMAIN_ADMIN","PREFERRED_CREDENTIAL_MAC","PREFERRED_CREDENTIAL_LINUX"],"default":"SYSTEM"},"scriptParam":{"type":"string","description":"Policy condition script parameter"},"scriptVariables":{"maxItems":20,"minItems":0,"type":"array","description":"Policy condition script variables","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition script variable Id"},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Policy condition script variable value"}},"description":"Policy condition script variable"}}},"description":"Policy condition script"},"PolicyConditionScriptVariable":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition script variable Id"},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Policy condition script variable value"}},"description":"Policy condition script variable"},"CustomFieldsPolicyConditionCreateRequest":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Policy condition enabled","default":true},"displayName":{"maxLength":255,"minLength":0,"type":"string","description":"Policy condition display name"},"severity":{"type":"string","description":"Policy condition severity","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"],"default":"NONE"},"priority":{"type":"string","description":"Policy condition priority","enum":["NONE","LOW","MEDIUM","HIGH"],"default":"NONE"},"channels":{"maxItems":20,"minItems":0,"uniqueItems":true,"type":"array","description":"Policy condition notification channels","items":{"type":"integer","description":"Policy condition notification channels","format":"int32"}},"scripts":{"maxItems":20,"minItems":0,"type":"array","description":"Policy condition scripts","items":{"type":"object","properties":{"scriptId":{"type":"integer","description":"Policy condition script id","format":"int32"},"runAs":{"type":"string","description":"Policy condition script runAs","enum":["SYSTEM","LOGGED_ON_USER","LOCAL_ADMIN","DOMAIN_ADMIN","PREFERRED_CREDENTIAL_MAC","PREFERRED_CREDENTIAL_LINUX"],"default":"SYSTEM"},"scriptParam":{"type":"string","description":"Policy condition script parameter"},"scriptVariables":{"maxItems":20,"minItems":0,"type":"array","description":"Policy condition script variables","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition script variable Id"},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Policy condition script variable value"}},"description":"Policy condition script variable"}}},"description":"Policy condition script"}},"notificationAction":{"type":"string","description":"Policy condition notification action","enum":["NONE","SEND"],"default":"NONE"},"notifyOnReset":{"type":"boolean","description":"Policy condition notify on reset","default":false},"resetThreshold":{"type":"integer","description":"Policy condition reset threshold (seconds)","format":"int32","default":14400},"matchAll":{"maxItems":10,"minItems":0,"type":"array","description":"Custom field value must meet all conditions","items":{"required":["fieldName","operator","value"],"type":"object","properties":{"fieldName":{"maxLength":250,"minLength":0,"type":"string","description":"Custom field name"},"operator":{"type":"string","description":"Custom field operator","enum":["EQUALS","NOT_EQUALS","LESS_THAN","LESS_OR_EQUAL_THAN","GREATER_THAN","GREATER_OR_EQUAL_THAN","IS_NOT_NULL","CONTAINS","CONTAINS_NONE","CONTAINS_ANY"]},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Custom field value"}},"description":"Policy condition custom field"}},"matchAny":{"maxItems":10,"minItems":0,"type":"array","description":"Custom field value must meet any conditions","items":{"required":["fieldName","operator","value"],"type":"object","properties":{"fieldName":{"maxLength":250,"minLength":0,"type":"string","description":"Custom field name"},"operator":{"type":"string","description":"Custom field operator","enum":["EQUALS","NOT_EQUALS","LESS_THAN","LESS_OR_EQUAL_THAN","GREATER_THAN","GREATER_OR_EQUAL_THAN","IS_NOT_NULL","CONTAINS","CONTAINS_NONE","CONTAINS_ANY"]},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Custom field value"}},"description":"Policy condition custom field"}}},"description":"Custom fields policy condition create request payload"},"WindowsEventPolicyConditionOccurrence":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Occurrence enabled","default":false},"threshold":{"type":"integer","description":"Occurrence threshold","format":"int32","default":2},"duration":{"type":"integer","description":"Occurrence duration","format":"int32","default":5}},"description":"Windows event policy condition occurrence"},"WindowsEventPolicyConditionResponse":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition id"},"conditionName":{"type":"string","description":"Policy condition name"},"displayName":{"type":"string","description":"Policy condition display name"},"enabled":{"type":"boolean","description":"Policy condition enabled"},"severity":{"type":"string","description":"Policy condition severity","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"]},"priority":{"type":"string","description":"Policy condition priority","enum":["NONE","LOW","MEDIUM","HIGH"]},"channels":{"uniqueItems":true,"type":"array","description":"Policy condition notification channels","items":{"type":"integer","description":"Policy condition notification channels","format":"int32"}},"scripts":{"type":"array","description":"Policy condition scripts","items":{"type":"object","properties":{"scriptId":{"type":"integer","description":"Policy condition script id","format":"int32"},"runAs":{"type":"string","description":"Policy condition script runAs","enum":["SYSTEM","LOGGED_ON_USER","LOCAL_ADMIN","DOMAIN_ADMIN","PREFERRED_CREDENTIAL_MAC","PREFERRED_CREDENTIAL_LINUX"],"default":"SYSTEM"},"scriptParam":{"type":"string","description":"Policy condition script parameter"},"scriptVariables":{"maxItems":20,"minItems":0,"type":"array","description":"Policy condition script variables","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition script variable Id"},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Policy condition script variable value"}},"description":"Policy condition script variable"}}},"description":"Policy condition script"}},"notificationAction":{"type":"string","description":"Policy condition notification action","enum":["NONE","SEND"]},"notifyOnReset":{"type":"boolean","description":"Policy condition notify on reset"},"resetThreshold":{"type":"integer","description":"Policy condition reset threshold (seconds)","format":"int32"},"inheritance":{"type":"object","properties":{"inherited":{"type":"boolean","description":"Is policy condition inherited"},"overridden":{"type":"boolean","description":"Is policy condition overridden"},"sourcePolicyId":{"type":"integer","description":"Id of the policy where the value originates; may be an ancestor above the immediate parent","format":"int32"}},"description":"Policy condition inheritance status"},"source":{"type":"string","description":"Event Source"},"eventIds":{"uniqueItems":true,"type":"array","description":"Event IDs","items":{"type":"integer","description":"Event IDs","format":"int32"}},"text":{"type":"object","properties":{"values":{"maxItems":20,"minItems":0,"uniqueItems":true,"type":"array","description":"Text values","items":{"type":"string","description":"Text values"}},"condition":{"type":"string","description":"Text condition","enum":["CONTAINS","NOT_CONTAINS"],"default":"CONTAINS"},"include":{"type":"string","description":"Text include","enum":["ALL","ANY"],"default":"ALL"}},"description":"Windows event policy condition text"},"occurrence":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Occurrence enabled","default":false},"threshold":{"type":"integer","description":"Occurrence threshold","format":"int32","default":2},"duration":{"type":"integer","description":"Occurrence duration","format":"int32","default":5}},"description":"Windows event policy condition occurrence"}},"description":"Windows event policy condition response payload"},"WindowsEventPolicyConditionText":{"type":"object","properties":{"values":{"maxItems":20,"minItems":0,"uniqueItems":true,"type":"array","description":"Text values","items":{"type":"string","description":"Text values"}},"condition":{"type":"string","description":"Text condition","enum":["CONTAINS","NOT_CONTAINS"],"default":"CONTAINS"},"include":{"type":"string","description":"Text include","enum":["ALL","ANY"],"default":"ALL"}},"description":"Windows event policy condition text"},"WindowsEventPolicyConditionCreateRequest":{"required":["eventIds","source"],"type":"object","properties":{"enabled":{"type":"boolean","description":"Policy condition enabled","default":true},"displayName":{"maxLength":255,"minLength":0,"type":"string","description":"Policy condition display name"},"severity":{"type":"string","description":"Policy condition severity","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"],"default":"NONE"},"priority":{"type":"string","description":"Policy condition priority","enum":["NONE","LOW","MEDIUM","HIGH"],"default":"NONE"},"channels":{"maxItems":20,"minItems":0,"uniqueItems":true,"type":"array","description":"Policy condition notification channels","items":{"type":"integer","description":"Policy condition notification channels","format":"int32"}},"scripts":{"maxItems":20,"minItems":0,"type":"array","description":"Policy condition scripts","items":{"type":"object","properties":{"scriptId":{"type":"integer","description":"Policy condition script id","format":"int32"},"runAs":{"type":"string","description":"Policy condition script runAs","enum":["SYSTEM","LOGGED_ON_USER","LOCAL_ADMIN","DOMAIN_ADMIN","PREFERRED_CREDENTIAL_MAC","PREFERRED_CREDENTIAL_LINUX"],"default":"SYSTEM"},"scriptParam":{"type":"string","description":"Policy condition script parameter"},"scriptVariables":{"maxItems":20,"minItems":0,"type":"array","description":"Policy condition script variables","items":{"type":"object","properties":{"id":{"type":"string","description":"Policy condition script variable Id"},"value":{"maxLength":65535,"minLength":0,"type":"string","description":"Policy condition script variable value"}},"description":"Policy condition script variable"}}},"description":"Policy condition script"}},"notificationAction":{"type":"string","description":"Policy condition notification action","enum":["NONE","SEND"],"default":"NONE"},"notifyOnReset":{"type":"boolean","description":"Policy condition notify on reset","default":false},"resetThreshold":{"type":"integer","description":"Policy condition reset threshold (seconds)","format":"int32","default":14400},"source":{"maxLength":255,"minLength":0,"type":"string","description":"Event Source"},"eventIds":{"maxItems":20,"minItems":0,"uniqueItems":true,"type":"array","description":"Event IDs","items":{"type":"integer","description":"Event IDs","format":"int32"}},"text":{"type":"object","properties":{"values":{"maxItems":20,"minItems":0,"uniqueItems":true,"type":"array","description":"Text values","items":{"type":"string","description":"Text values"}},"condition":{"type":"string","description":"Text condition","enum":["CONTAINS","NOT_CONTAINS"],"default":"CONTAINS"},"include":{"type":"string","description":"Text include","enum":["ALL","ANY"],"default":"ALL"}},"description":"Windows event policy condition text"},"occurrence":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Occurrence enabled","default":false},"threshold":{"type":"integer","description":"Occurrence threshold","format":"int32","default":2},"duration":{"type":"integer","description":"Occurrence duration","format":"int32","default":5}},"description":"Windows event policy condition occurrence"}},"description":"Windows event policy condition create request payload"},"HTTPHeader":{"type":"object","properties":{"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}},"description":"Custom HTTP Headers (i.e. Authorization)"},"WebhookConfiguration":{"type":"object","properties":{"url":{"type":"string","description":"Callback (WebHook) URL for activity notifications"},"activities":{"type":"object","additionalProperties":{"type":"array","description":"Activity filter","items":{"type":"string","description":"Activity filter"}},"description":"Activity filter"},"expand":{"type":"array","description":"Which references to expand in payloads","items":{"type":"string","description":"Which references to expand in payloads"}},"headers":{"type":"array","description":"Custom HTTP Headers (i.e. Authorization)","items":{"type":"object","properties":{"name":{"type":"string","description":"Header name"},"value":{"type":"string","description":"Header value"}},"description":"Custom HTTP Headers (i.e. Authorization)"}},"organizationIds":{"uniqueItems":true,"type":"array","description":"List of organization id to be filtered","items":{"type":"integer","description":"List of organization id to be filtered","format":"int32"}}}},"FeatureSettings":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"Location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"NodeRolePolicyAssignment":{"type":"object","properties":{"nodeRoleId":{"type":"integer","description":"Node Role Identifier","format":"int32"},"policyId":{"type":"integer","description":"Policy Identifier","format":"int32"}},"description":"Node role policy assignments"},"OrganizationDetailed":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"},"locations":{"type":"array","description":"List of locations","items":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"}},"policies":{"type":"array","description":"Node role policy assignments","items":{"type":"object","properties":{"nodeRoleId":{"type":"integer","description":"Node Role Identifier","format":"int32"},"policyId":{"type":"integer","description":"Policy Identifier","format":"int32"}},"description":"Node role policy assignments"}},"settings":{"type":"object","properties":{"trayicon":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"splashtop":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"teamviewer":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"backup":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"psa":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"}},"description":"Organization settings"}}},"OrganizationSettings":{"type":"object","properties":{"trayicon":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"splashtop":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"teamviewer":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"backup":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"},"psa":{"type":"object","properties":{"product":{"type":"string","description":"Configured product code"},"enabled":{"type":"boolean","description":"Is enabled"},"targets":{"type":"array","description":"Feature deployment targets","items":{"type":"string","description":"Feature deployment targets"}},"options":{"type":"object","additionalProperties":{"type":"object","description":"Feature options"},"description":"Feature options"}},"description":"Feature/product/integration configuration settings"}},"description":"Organization settings"},"LocationModel":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"}}},"OrganizationWithLocationsAndPolicyAssignmentsModel":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"locations":{"type":"array","description":"List of locations","items":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"}}}},"policies":{"type":"array","description":"Node role policy assignments","items":{"type":"object","properties":{"nodeRoleId":{"type":"integer","description":"Node Role Identifier","format":"int32"},"policyId":{"type":"integer","description":"Policy Identifier","format":"int32"}},"description":"Node role policy assignments"}}}},"DeviceIDList":{"type":"object","properties":{"devices":{"type":"array","items":{"type":"integer","format":"int32"}}}},"AttachmentMetadataPublicApiDTO":{"type":"object","properties":{"name":{"type":"string","description":"name"},"mimeType":{"type":"string","description":"Mime type"},"size":{"type":"string","description":"Size in bytes"},"extension":{"type":"string","description":"File extension"},"contentId":{"type":"string","description":"Content identifier"}}},"BodyPart":{"type":"object","properties":{"contentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"}}},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"}}},"messageBodyWorkers":{"type":"object"},"parent":{"$ref":"#/components/schemas/MultiPart"},"providers":{"type":"object"},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}}}}}}}},"ContentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"}}},"FormDataBodyPart":{"type":"object","properties":{"contentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"}}},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"}}},"messageBodyWorkers":{"type":"object"},"parent":{"type":"object","properties":{"contentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"}}},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"}}},"messageBodyWorkers":{"type":"object"},"parent":{"$ref":"#/components/schemas/MultiPart"},"providers":{"type":"object"},"bodyParts":{"type":"array","items":{"$ref":"#/components/schemas/BodyPart"}},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}}}}}}}},"providers":{"type":"object"},"formDataContentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"simple":{"type":"boolean"},"name":{"type":"string"},"value":{"type":"string"},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}}}}}}}},"FormDataContentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"MessageBodyWorkers":{"type":"object"},"MultiPart":{"type":"object","properties":{"contentDisposition":{"type":"object","properties":{"type":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"fileName":{"type":"string"},"creationDate":{"type":"string","format":"date-time"},"modificationDate":{"type":"string","format":"date-time"},"readDate":{"type":"string","format":"date-time"},"size":{"type":"integer","format":"int64"}}},"entity":{"type":"object"},"headers":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"mediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"}}},"messageBodyWorkers":{"type":"object"},"parent":{"$ref":"#/components/schemas/MultiPart"},"providers":{"type":"object"},"bodyParts":{"type":"array","items":{"$ref":"#/components/schemas/BodyPart"}},"parameterizedHeaders":{"type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}}}}}}}},"ParameterizedHeader":{"type":"object","properties":{"value":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}}}},"ChecklistDescription":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"ChecklistTemplatePublicApiDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Checklist template name (must be unique)"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"tasks":{"type":"array","description":"Checklist template tasks","items":{"type":"object","properties":{"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"}},"description":"Checklist template tasks"}},"required":{"type":"boolean","description":"Indicates if the checklist completion is required"},"lastUpdatedOn":{"type":"number","description":"Last updated on","format":"double"},"lastUpdatedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archived":{"type":"boolean","description":"Indicates if the checklist template is archived"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archiveTime":{"type":"number","description":"Archive time","format":"double"}}},"ChecklistTemplateTaskPublicApiDTO":{"type":"object","properties":{"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"}},"description":"Checklist template tasks"},"ChecklistUserResponseDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"ArchiveChecklistTemplatesRequest":{"type":"object","properties":{"checklistTemplateIds":{"type":"array","items":{"type":"integer","format":"int32"}}}},"ChecklistTemplateTaskPublicApiRequest":{"type":"object","properties":{"position":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"}},"description":"Checklist's tasks"},"CreateChecklistTemplatePublicApiRequest":{"type":"object","properties":{"name":{"type":"string","description":"Checklist template name (must be unique)"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"tasks":{"type":"array","description":"Checklist's tasks","items":{"type":"object","properties":{"position":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"}},"description":"Checklist's tasks"}},"required":{"type":"boolean","description":"Checklist's tasks"}}},"RestoreChecklistTemplatesRequest":{"type":"object","properties":{"checklistTemplateIds":{"type":"array","items":{"type":"integer","format":"int32"}}}},"UpdateChecklistTemplatePublicApiRequest":{"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"Checklist template identifier","format":"int32"},"name":{"type":"string","description":"Checklist template name (must be unique)"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"tasks":{"type":"array","description":"Checklist's tasks","items":{"type":"object","properties":{"position":{"maximum":2147483647,"minimum":1,"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"}},"description":"Checklist's tasks"}},"required":{"type":"boolean","description":"Indicates if the checklist is required"}}},"ClientChecklistPublicApiDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Checklist name (must be unique)"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"required":{"type":"boolean","description":"Indicates if the checklist completion is required"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"},"completedOn":{"type":"number","description":"Date of completion","format":"double"},"assignedTo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"lastUpdatedOn":{"type":"number","description":"Last updated on","format":"double"},"lastUpdatedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"completedTaskCount":{"type":"integer","description":"Last updated by user","format":"int32"},"totalTaskCount":{"type":"integer","description":"Checklist's total tasks count","format":"int32"},"tasks":{"type":"array","description":"Checklist's tasks","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"assignedTo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"},"completedOn":{"type":"number","description":"Date of completion","format":"double"},"completedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"}},"description":"Checklist's tasks"}},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"clientName":{"type":"string","description":"Client name"},"archived":{"type":"boolean","description":"Indicates if the checklist is archived"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"archiveTime":{"type":"number","description":"Archive time","format":"double"}}},"ClientChecklistTaskPublicApiDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"assignedTo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"},"completedOn":{"type":"number","description":"Date of completion","format":"double"},"completedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Archive by user"}},"description":"Checklist's tasks"},"ArchiveClientChecklistRequest":{"type":"object","properties":{"clientChecklistIds":{"type":"array","items":{"type":"integer","format":"int32"}}}},"ClientChecklistTaskPublicApiRequest":{"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"Identifier","format":"int32"},"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"assignedToUserId":{"minimum":1,"type":"integer","description":"User identifier assigned to the checklist task","format":"int32"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"}},"description":"Checklist tasks"},"CreateClientChecklistAndTasksPublicApiRequest":{"type":"object","properties":{"name":{"type":"string","description":"Checklist name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"required":{"type":"boolean","description":"Indicates if the checklist completion is required"},"dueDate":{"type":"number","description":"Due date","format":"double"},"assignedToUserId":{"minimum":1,"type":"integer","description":"User identifier assigned to the checklist","format":"int32"},"organizationId":{"minimum":1,"type":"integer","description":"Organization identifier","format":"int32"},"checklistTemplateId":{"minimum":1,"type":"integer","description":"Checklist template identifier","format":"int32"},"tasks":{"type":"array","description":"Checklist tasks","items":{"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"Identifier","format":"int32"},"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"assignedToUserId":{"minimum":1,"type":"integer","description":"User identifier assigned to the checklist task","format":"int32"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"}},"description":"Checklist tasks"}}}},"PromoteClientChecklistWithNamePublicApiRequest":{"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Checklist name"}}},"UpdateClientChecklistAndTasksPublicApiRequest":{"type":"object","properties":{"checklistId":{"minimum":1,"type":"integer","description":"Checklist identifier","format":"int32"},"name":{"type":"string","description":"Checklist name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"required":{"type":"boolean","description":"Indicates if the checklist completion is required"},"dueDate":{"type":"number","description":"Due date","format":"double"},"assignedToUserId":{"minimum":1,"type":"integer","description":"User identifier assigned to the checklist","format":"int32"},"tasks":{"type":"array","description":"Checklist tasks","items":{"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"Identifier","format":"int32"},"position":{"type":"integer","description":"Position of the task","format":"int32"},"name":{"type":"string","description":"Task name"},"description":{"type":"object","properties":{"text":{"type":"string"},"html":{"type":"string"}},"description":"Task description"},"assignedToUserId":{"minimum":1,"type":"integer","description":"User identifier assigned to the checklist task","format":"int32"},"dueDate":{"type":"number","description":"Due date","format":"double"},"completed":{"type":"boolean","description":"Indicates if the checklist is completed"}},"description":"Checklist tasks"}}}},"ClientDocumentAttributeWithValuePublicApiDTO":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"value":{"type":"object","description":"Value"},"valueUpdateTime":{"type":"number","description":"Value Last Updated","format":"double"}},"description":"Updated Fields"},"ClientDocumentWithAttributeValuesPublicApiDTO":{"type":"object","properties":{"documentId":{"type":"integer","description":"Document Identifier","format":"int32"},"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"documentUpdateTime":{"type":"number","description":"Document Last Updated","format":"double"},"fields":{"type":"array","description":"Fields","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"value":{"type":"object","description":"Value"},"valueUpdateTime":{"type":"number","description":"Value Last Updated","format":"double"}},"description":"Updated Fields"}},"documentTemplateId":{"type":"integer","description":"Document Template Identifier","format":"int32"},"documentTemplateName":{"type":"string","description":"Document Template Name"},"organizationId":{"type":"integer","description":"Organization Identifier","format":"int32"}}},"ClientDocumentWithAttributeValuesPublicApiRequest":{"type":"object","properties":{"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"fields":{"type":"object","additionalProperties":{"type":"object","description":"Fields"},"description":"Fields"}}},"ClientDocumentWithAttributeValuesBulkCreatePublicApiRequest":{"type":"object","properties":{"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"fields":{"type":"object","additionalProperties":{"type":"object","description":"Fields"},"description":"Fields"},"documentTemplateId":{"type":"integer","description":"Document Template Identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization Identifier","format":"int32"}}},"ClientDocumentWithUpdatedAttributeValuesPublicApiDTO":{"type":"object","properties":{"documentId":{"type":"integer","description":"Document Identifier","format":"int32"},"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"documentUpdateTime":{"type":"number","description":"Document Last Updated","format":"double"},"updatedFields":{"type":"array","description":"Updated Fields","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"value":{"type":"object","description":"Value"},"valueUpdateTime":{"type":"number","description":"Value Last Updated","format":"double"}},"description":"Updated Fields"}},"documentTemplateId":{"type":"integer","description":"Document Template Identifier","format":"int32"},"documentTemplateName":{"type":"string","description":"Document Template Name"},"organizationId":{"type":"integer","description":"Organization Identifier","format":"int32"}}},"ClientDocumentWithAttributeValuesBulkUpdatePublicApiRequest":{"type":"object","properties":{"documentId":{"type":"integer","description":"Document Identifier","format":"int32"},"documentName":{"type":"string","description":"Document Name"},"documentDescription":{"type":"string","description":"Document Description"},"fields":{"type":"object","additionalProperties":{"type":"object","description":"Fields"},"description":"Fields"}}},"ArchiveUserInfo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"displayName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Indicates who archived the template"},"AttributeApiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"AttributeContentAdvancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}},"AttributeContentAdvancedSettingsComplexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"AttributeContentAdvancedSettingsDateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"AttributeContentAdvancedSettingsDateFiltersType":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"AttributeContentAdvancedSettingsHealthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}},"AttributeContentAdvancedSettingsIdentifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"AttributeContentAdvancedSettingsIpAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"AttributeContentAdvancedSettingsMonetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"AttributeContentAdvancedSettingsNumericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"AttributeScriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"AttributeTechnicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"AttributeType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"DocumentAttributeContentPublicApi":{"type":"object","properties":{"values":{"type":"array","description":"Used for dropdown options","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Dropdown option name"},"active":{"type":"boolean","description":"Indicates if a dropdown option is active"}},"description":"Used for dropdown options"}},"required":{"type":"boolean","description":"Indicates if the field is required"},"footerText":{"type":"string","description":"Footer text"},"tooltipText":{"type":"string","description":"Tooltip text"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Field content"},"DocumentAttributeContentValuePublicApi":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Dropdown option name"},"active":{"type":"boolean","description":"Indicates if a dropdown option is active"}},"description":"Used for dropdown options"},"DocumentItemPublicApiDTO":{"type":"object","properties":{"fieldId":{"type":"integer","description":"Field identifier","format":"int32"},"fieldLabel":{"type":"string","description":"Field or UI element name"},"fieldName":{"type":"string","description":"Field name"},"fieldDescription":{"type":"string","description":"Field description"},"fieldType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"fieldTechnicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"fieldScriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldApiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldDefaultValue":{"type":"string","description":"Default value"},"fieldContent":{"type":"object","properties":{"values":{"type":"array","description":"Used for dropdown options","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Dropdown option name"},"active":{"type":"boolean","description":"Indicates if a dropdown option is active"}},"description":"Used for dropdown options"}},"required":{"type":"boolean","description":"Indicates if the field is required"},"footerText":{"type":"string","description":"Footer text"},"tooltipText":{"type":"string","description":"Tooltip text"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Field content"},"uiElementUid":{"type":"string","description":"UI element identifier","format":"uuid"},"uiElementName":{"type":"string","description":"UI element name"},"uiElementType":{"type":"string","description":"UI element type","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"UI element value"},"createdTime":{"type":"number","description":"Creation time","format":"double"},"updatedTime":{"type":"number","description":"Last updated time","format":"double"}},"description":"Document template fields"},"DocumentTemplatePublicApiDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"name":{"type":"string","description":"Name of the template (must be unique)"},"description":{"type":"string","description":"Description of the template"},"allowMultiple":{"type":"boolean","description":"Indicates if multiple instances of the document template is allowed"},"mandatory":{"type":"boolean","description":"Indicates if the document template is mandatory"},"createTime":{"type":"number","description":"Creation time","format":"double"},"updateTime":{"type":"number","description":"Last updated time","format":"double"},"fields":{"type":"array","description":"Document template fields","items":{"type":"object","properties":{"fieldId":{"type":"integer","description":"Field identifier","format":"int32"},"fieldLabel":{"type":"string","description":"Field or UI element name"},"fieldName":{"type":"string","description":"Field name"},"fieldDescription":{"type":"string","description":"Field description"},"fieldType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"fieldTechnicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"fieldScriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldApiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldDefaultValue":{"type":"string","description":"Default value"},"fieldContent":{"type":"object","properties":{"values":{"type":"array","description":"Used for dropdown options","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Dropdown option name"},"active":{"type":"boolean","description":"Indicates if a dropdown option is active"}},"description":"Used for dropdown options"}},"required":{"type":"boolean","description":"Indicates if the field is required"},"footerText":{"type":"string","description":"Footer text"},"tooltipText":{"type":"string","description":"Tooltip text"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Field content"},"uiElementUid":{"type":"string","description":"UI element identifier","format":"uuid"},"uiElementName":{"type":"string","description":"UI element name"},"uiElementType":{"type":"string","description":"UI element type","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"UI element value"},"createdTime":{"type":"number","description":"Creation time","format":"double"},"updatedTime":{"type":"number","description":"Last updated time","format":"double"}},"description":"Document template fields"}},"availableToAllTechnicians":{"type":"boolean","description":"Indicates if the document template is available to all technicians"},"allowedTechnicianRoles":{"type":"array","description":"List of allowed technician role ids","items":{"type":"integer","description":"List of allowed technician role ids","format":"int32"}},"archived":{"type":"boolean","description":"Indicates if the document template is archived"},"archivedTime":{"type":"number","description":"Indicates the time the template was archived","format":"double"},"archivedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"displayName":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Indicates who archived the template"}}},"NewDocumentAttributeContentPublicApi":{"type":"object","properties":{"values":{"type":"array","description":"Used for dropdown options","items":{"type":"object","properties":{"name":{"type":"string","description":"Dropdown option name"}},"description":"Used for dropdown options"}},"required":{"type":"boolean","description":"Indicates if the field is required"},"footerText":{"type":"string","description":"Footer text"},"tooltipText":{"type":"string","description":"Tooltip text"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Field content"},"NewDocumentAttributeContentValuePublicApi":{"type":"object","properties":{"name":{"type":"string","description":"Dropdown option name"}},"description":"Used for dropdown options"},"NewDocumentItemPublicApiRequest":{"required":["fieldLabel","fieldName"],"type":"object","properties":{"fieldLabel":{"type":"string","description":"Field label"},"fieldName":{"type":"string","description":"Field name (Immutable value)"},"fieldDescription":{"type":"string","description":"Field description"},"fieldType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"fieldTechnicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"fieldScriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldApiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldDefaultValue":{"type":"string","description":"Default value"},"fieldContent":{"type":"object","properties":{"values":{"type":"array","description":"Used for dropdown options","items":{"type":"object","properties":{"name":{"type":"string","description":"Dropdown option name"}},"description":"Used for dropdown options"}},"required":{"type":"boolean","description":"Indicates if the field is required"},"footerText":{"type":"string","description":"Footer text"},"tooltipText":{"type":"string","description":"Tooltip text"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Field content"},"uiElementName":{"type":"string","description":"UI element name"},"uiElementType":{"type":"string","description":"UI element type","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"UI element value"}},"description":"List of fields and ui elements"},"NewDocumentTemplatePublicApiRequest":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the template (must be unique)"},"description":{"type":"string","description":"Description of the template"},"allowMultiple":{"type":"boolean","description":"States if multiple instances of the document template is allowed"},"mandatory":{"type":"boolean","description":"Indicates if the document template is mandatory"},"fields":{"type":"array","description":"List of fields and ui elements","items":{"required":["fieldLabel","fieldName"],"type":"object","properties":{"fieldLabel":{"type":"string","description":"Field label"},"fieldName":{"type":"string","description":"Field name (Immutable value)"},"fieldDescription":{"type":"string","description":"Field description"},"fieldType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"fieldTechnicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"fieldScriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldApiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldDefaultValue":{"type":"string","description":"Default value"},"fieldContent":{"type":"object","properties":{"values":{"type":"array","description":"Used for dropdown options","items":{"type":"object","properties":{"name":{"type":"string","description":"Dropdown option name"}},"description":"Used for dropdown options"}},"required":{"type":"boolean","description":"Indicates if the field is required"},"footerText":{"type":"string","description":"Footer text"},"tooltipText":{"type":"string","description":"Tooltip text"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Field content"},"uiElementName":{"type":"string","description":"UI element name"},"uiElementType":{"type":"string","description":"UI element type","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"UI element value"}},"description":"List of fields and ui elements"}},"availableToAllTechnicians":{"type":"boolean","description":"States if the document template is available to all technicians"},"allowedTechnicianRoles":{"type":"array","description":"List of allowed technician role ids","items":{"type":"integer","description":"List of allowed technician role ids","format":"int32"}}}},"UpdateDocumentItemPublicApiRequest":{"type":"object","properties":{"fieldId":{"type":"integer","description":"Field identifier (Used to identify existing fields)","format":"int32"},"fieldLabel":{"type":"string","description":"Field or UI element name"},"fieldName":{"type":"string","description":"Field name (Immutable except for new fields)"},"fieldDescription":{"type":"string","description":"Field description"},"fieldType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"fieldTechnicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"fieldScriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldApiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldDefaultValue":{"type":"string","description":"Default value"},"fieldContent":{"type":"object","properties":{"values":{"type":"array","description":"Used for dropdown options","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Dropdown option name"},"active":{"type":"boolean","description":"Indicates if a dropdown option is active"}},"description":"Used for dropdown options"}},"required":{"type":"boolean","description":"Indicates if the field is required"},"footerText":{"type":"string","description":"Footer text"},"tooltipText":{"type":"string","description":"Tooltip text"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Field content"},"uiElementUid":{"type":"string","description":"UI element identifier","format":"uuid"},"uiElementName":{"type":"string","description":"UI element name"},"uiElementType":{"type":"string","description":"UI element type","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"UI element value"}},"description":"List of fields and ui elements"},"UpdateDocumentTemplatePublicApiRequest":{"type":"object","properties":{"name":{"type":"string","description":"Name of the template (must be unique)"},"description":{"type":"string","description":"Description of the template"},"mandatory":{"type":"boolean","description":"Indicates if the document template is mandatory"},"fields":{"type":"array","description":"List of fields and ui elements","items":{"type":"object","properties":{"fieldId":{"type":"integer","description":"Field identifier (Used to identify existing fields)","format":"int32"},"fieldLabel":{"type":"string","description":"Field or UI element name"},"fieldName":{"type":"string","description":"Field name (Immutable except for new fields)"},"fieldDescription":{"type":"string","description":"Field description"},"fieldType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"fieldTechnicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"fieldScriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldApiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"fieldDefaultValue":{"type":"string","description":"Default value"},"fieldContent":{"type":"object","properties":{"values":{"type":"array","description":"Used for dropdown options","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Dropdown option name"},"active":{"type":"boolean","description":"Indicates if a dropdown option is active"}},"description":"Used for dropdown options"}},"required":{"type":"boolean","description":"Indicates if the field is required"},"footerText":{"type":"string","description":"Footer text"},"tooltipText":{"type":"string","description":"Tooltip text"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Field content"},"uiElementUid":{"type":"string","description":"UI element identifier","format":"uuid"},"uiElementName":{"type":"string","description":"UI element name"},"uiElementType":{"type":"string","description":"UI element type","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"UI element value"}},"description":"List of fields and ui elements"}},"availableToAllTechnicians":{"type":"boolean","description":"States if the document template is available to all technicians"},"allowedTechnicianRoles":{"type":"array","description":"List of allowed technician role ids","items":{"type":"integer","description":"List of allowed technician role ids","format":"int32"}}}},"ItamManageAssetRequestPublicApiDTO":{"type":"object","properties":{"assetIds":{"uniqueItems":true,"type":"array","description":"Array of asset IDs to perform bulk operations on (provide the type of asset with the URL)","items":{"type":"integer","description":"Array of asset IDs to perform bulk operations on (provide the type of asset with the URL)","format":"int32"}},"tagIdsToAdd":{"uniqueItems":true,"type":"array","description":"Array of tag IDs to add to the supplied assets","items":{"type":"integer","description":"Array of tag IDs to add to the supplied assets","format":"int32"}},"tagIdsToRemove":{"uniqueItems":true,"type":"array","description":"Array of tag IDs to remove from the supplied assets","items":{"type":"integer","description":"Array of tag IDs to remove from the supplied assets","format":"int32"}}}},"ItamTagPublicApiDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID","format":"int32"},"name":{"type":"string","description":"Tag name"},"description":{"type":"string","description":"Description of the tag"},"createTime":{"type":"number","description":"Creation time for the tag in seconds since unix epoch","format":"double"},"updateTime":{"type":"number","description":"Last update time for the tag in seconds since unix epoch","format":"double"},"createdByUserId":{"type":"integer","description":"Id of the user that created the tag","format":"int32"},"updatedByUserId":{"type":"integer","description":"Id of the user that last updated the the tag","format":"int32"}}},"CreateItamTagRequest":{"type":"object","properties":{"name":{"maxLength":40,"minLength":1,"type":"string"},"description":{"maxLength":250,"minLength":0,"type":"string"}}},"GetItamTagsResponse":{"type":"object","properties":{"tags":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"},"createdByUserId":{"type":"integer","format":"int32"},"updatedByUserId":{"type":"integer","format":"int32"},"targetsCount":{"type":"integer","format":"int32"},"createdBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"email":{"type":"string"}}},"updatedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"email":{"type":"string"}}}}}}}},"ItamTagDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"},"createdByUserId":{"type":"integer","format":"int32"},"updatedByUserId":{"type":"integer","format":"int32"},"targetsCount":{"type":"integer","format":"int32"},"createdBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"email":{"type":"string"}}},"updatedBy":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"email":{"type":"string"}}}}},"UserBasicInfo":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"email":{"type":"string"}}},"GetItamTagsPublicApiResponse":{"type":"object","properties":{"tags":{"type":"array","description":"List of tag objects","items":{"type":"object","properties":{"id":{"type":"integer","description":"Tag ID","format":"int32"},"name":{"type":"string","description":"Tag name"},"description":{"type":"string","description":"Description of the tag"},"createTime":{"type":"number","description":"Creation time for the tag in seconds since unix epoch","format":"double"},"updateTime":{"type":"number","description":"Last update time for the tag in seconds since unix epoch","format":"double"},"createdByUserId":{"type":"integer","description":"Id of the user that created the tag","format":"int32"},"updatedByUserId":{"type":"integer","description":"Id of the user that last updated the the tag","format":"int32"}}}}}},"MergeItamTagsPublicApiRequest":{"type":"object","properties":{"tagIds":{"uniqueItems":true,"type":"array","description":"Array of tag ids to merge","items":{"type":"integer","description":"Array of tag ids to merge","format":"int32"}},"mergeMethod":{"type":"string","description":"Method to use - merge into an existing tag or create a new one","enum":["MERGE_INTO_EXISTING_TAG","MERGE_INTO_NEW_TAG"]},"mergeIntoTagId":{"type":"integer","description":"If merging into an existing tag, you must provide the target tag id here","format":"int32","nullable":true},"name":{"maxLength":40,"minLength":0,"type":"string","description":"If creating a new tag, you must supply the new tag name here","nullable":true},"description":{"maxLength":250,"minLength":0,"type":"string","description":"If creating a new tag, you can supply the new tag description here","nullable":true}}},"ItamSetAssetTagsRequestPublicApiDTO":{"type":"object","properties":{"tagIds":{"uniqueItems":true,"type":"array","description":"Array of tag IDS to assign to asset from URL. The tags on the asset will be set to exactly these tags, removing existing tags if necessary","items":{"type":"integer","description":"Array of tag IDS to assign to asset from URL. The tags on the asset will be set to exactly these tags, removing existing tags if necessary","format":"int32"}}}},"UpdateItamTagRequest":{"type":"object","properties":{"name":{"maxLength":40,"minLength":0,"type":"string"},"description":{"maxLength":250,"minLength":0,"type":"string"}}},"AttachmentMetadata":{"type":"object","properties":{"name":{"type":"string"},"mimeType":{"type":"string"},"size":{"type":"string"},"extension":{"type":"string"},"contentId":{"type":"string"},"inline":{"type":"boolean"}},"description":"Attachment metadata"},"KnowledgeBaseArticlePublicApiContent":{"type":"object","properties":{"html":{"type":"string","description":"Article content html"},"text":{"type":"string","description":"Article content text"}},"description":"Article content"},"KnowledgeBaseArticlePublicApiDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"parentFolderId":{"type":"integer","description":"Parent folder identifier","format":"int32"},"name":{"type":"string","description":"Article name"},"isNinjaArticle":{"type":"boolean","description":"Indicates if the article was created in ninja"},"isArchived":{"type":"boolean","description":"Indicates if the article is archived"},"attachments":{"type":"array","description":"Lists the files associated with the article","items":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"uploadStatus":{"type":"string","description":"Upload status","enum":["PROCESSING","SUCCESS","FAILURE","SUSPICIOUS"]},"metadata":{"type":"object","properties":{"name":{"type":"string"},"mimeType":{"type":"string"},"size":{"type":"string"},"extension":{"type":"string"},"contentId":{"type":"string"},"inline":{"type":"boolean"}},"description":"Attachment metadata"}},"description":"Lists the files associated with the article"}},"content":{"type":"object","properties":{"html":{"type":"string","description":"Article content html"},"text":{"type":"string","description":"Article content text"}},"description":"Article content"},"createTime":{"type":"number","description":"Article created time","format":"double"},"updateTime":{"type":"number","description":"Article last updated time","format":"double"},"archivedTime":{"type":"number","description":"Article archived time","format":"double"},"path":{"type":"string","description":"Article path"}}},"KnowledgeBaseAttachmentPublicApiDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"uploadStatus":{"type":"string","description":"Upload status","enum":["PROCESSING","SUCCESS","FAILURE","SUSPICIOUS"]},"metadata":{"type":"object","properties":{"name":{"type":"string"},"mimeType":{"type":"string"},"size":{"type":"string"},"extension":{"type":"string"},"contentId":{"type":"string"},"inline":{"type":"boolean"}},"description":"Attachment metadata"}},"description":"Lists the files associated with the article"},"KnowledgeBaseArticleBulkCreatePublicApiRequest":{"type":"object","properties":{"name":{"type":"string","description":"Article name"},"organizationId":{"type":"integer","description":"Organization Identifier","format":"int32"},"destinationFolderId":{"type":"integer","description":"Destination folder identifier","format":"int32"},"destinationFolderPath":{"type":"string","description":"Folder path, each folder name separated by '|'","example":"Folder 1|Folder 2|Folder 3|Folder 4"},"content":{"type":"object","properties":{"html":{"type":"string","description":"Article content html"},"text":{"type":"string","description":"Article content text"}},"description":"Article content"}}},"KnowledgeBaseFolderItemPublicApiDTO":{"type":"object","properties":{"archived":{"type":"boolean"},"folder":{"type":"boolean"},"id":{"type":"integer","description":"Identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"parentFolderId":{"type":"integer","description":"Parent folder identifier","format":"int32"},"isFolder":{"type":"boolean","description":"Indicates if this item is a folder"},"isArchived":{"type":"boolean","description":"Indicates if this item is archived"},"name":{"type":"string","description":"Article name (In the case of uploaded articles this will be the file name)"},"fileSize":{"type":"string","description":"Article file size (Only for uploaded knowledge base articles)"},"fileExtension":{"type":"string","description":"Article file extension (For native kb articles the extension will be 'ninja')"},"fileUploadStatus":{"type":"string","description":"Article file upload status (Only for uploaded knowledge base articles)","enum":["PROCESSING","SUCCESS","FAILURE","SUSPICIOUS"]},"createTime":{"type":"number","description":"Item created time","format":"double"},"updateTime":{"type":"number","description":"Item last updated time","format":"double"}},"description":"Folder content"},"KnowledgeBaseFolderPublicApiDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"parentFolderId":{"type":"integer","description":"Parent folder identifier","format":"int32"},"name":{"type":"string","description":"Article name"},"isArchived":{"type":"boolean","description":"Indicates if the article is archived"},"createTime":{"type":"number","description":"Folder created time","format":"double"},"updateTime":{"type":"number","description":"Folder last updated time","format":"double"},"archivedTime":{"type":"number","description":"Folder archived time","format":"double"},"content":{"type":"array","description":"Folder content","items":{"type":"object","properties":{"archived":{"type":"boolean"},"folder":{"type":"boolean"},"id":{"type":"integer","description":"Identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"parentFolderId":{"type":"integer","description":"Parent folder identifier","format":"int32"},"isFolder":{"type":"boolean","description":"Indicates if this item is a folder"},"isArchived":{"type":"boolean","description":"Indicates if this item is archived"},"name":{"type":"string","description":"Article name (In the case of uploaded articles this will be the file name)"},"fileSize":{"type":"string","description":"Article file size (Only for uploaded knowledge base articles)"},"fileExtension":{"type":"string","description":"Article file extension (For native kb articles the extension will be 'ninja')"},"fileUploadStatus":{"type":"string","description":"Article file upload status (Only for uploaded knowledge base articles)","enum":["PROCESSING","SUCCESS","FAILURE","SUSPICIOUS"]},"createTime":{"type":"number","description":"Item created time","format":"double"},"updateTime":{"type":"number","description":"Item last updated time","format":"double"}},"description":"Folder content"}}}},"MovePublicApiRequest":{"type":"object","properties":{"folderIds":{"type":"array","description":"Folders to move","items":{"type":"integer","description":"Folders to move","format":"int32"}},"documentIds":{"type":"array","description":"Documents to move","items":{"type":"integer","description":"Documents to move","format":"int32"}},"destinationFolderId":{"type":"integer","description":"Destination folder","format":"int32"},"destinationOrganizationId":{"type":"integer","description":"Destination client. Use when the root folder of the client does not exist.","format":"int32"}}},"KnowledgeBaseArticleBulkUpdatePublicApiRequest":{"type":"object","properties":{"id":{"type":"integer","description":"Article identifier","format":"int32"},"name":{"type":"string","description":"Article name"},"content":{"type":"object","properties":{"html":{"type":"string","description":"Article content html"},"text":{"type":"string","description":"Article content text"}},"description":"Article content"}}},"AttributeContent":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean"},"footerText":{"type":"string"},"tooltipText":{"type":"string"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}}},"AttributeContentValue":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}},"AttributeEndUserOption":{"type":"string","description":"End user access level for custom fields in the UI","enum":["HIDDEN","EDITABLE_OPTIONAL","EDITABLE_REQUIRED","READ_ONLY"]},"AttributePublicApiDTO":{"type":"object","properties":{"entityType":{"type":"string","description":"Entity type that this custom field or operation applies to","enum":["USER","NODE","TICKET","DOCUMENT","INPUT_FIELD_FORM"]},"scope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition Scope","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"label":{"type":"string","description":"Label"},"description":{"type":"string","description":"Description"},"name":{"type":"string","description":"Name"},"defaultValue":{"type":"string","description":"Default Value"},"endUserPermission":{"type":"string","description":"End user access level for custom fields in the UI","enum":["HIDDEN","EDITABLE_OPTIONAL","EDITABLE_REQUIRED","READ_ONLY"]},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"content":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean"},"footerText":{"type":"string"},"tooltipText":{"type":"string"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}}},"system":{"type":"boolean","description":"System"},"active":{"type":"boolean","description":"Active"},"createTime":{"type":"number","description":"Create Time","format":"double"},"updateTime":{"type":"number","description":"Update Time","format":"double"}}},"AttributeScope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"DefinitionScope":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]},"EndUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"EntityType":{"type":"string","description":"Entity type that this custom field or operation applies to","enum":["USER","NODE","TICKET","DOCUMENT","INPUT_FIELD_FORM"]},"BulkCreateNodeAttributePublicApiRequest":{"type":"object","properties":{"customFields":{"type":"array","description":"List of custom fields to create","items":{"required":["fieldName","label"],"type":"object","properties":{"label":{"type":"string","description":"Display label for the custom field"},"fieldName":{"type":"string","description":"Unique field name for API access (used when accessing the value programmatically)"},"description":{"type":"string","description":"Description of the custom field"},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"defaultValue":{"type":"string","description":"Default value for the custom field. This only has an effect for DROPDOWN and MULTI_SELECT attributes"},"content":{"type":"object","properties":{"values":{"type":"array","description":"List of predefined values for dropdown/radio types","items":{"type":"object","properties":{"name":{"type":"string","description":"Display name for the option"}},"description":"List of predefined values for dropdown/radio types"}},"required":{"type":"boolean","description":"Whether the field is required"},"footerText":{"type":"string","description":"Footer text displayed below the field"},"tooltipText":{"type":"string","description":"Tooltip text for the field"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Content configuration for the custom field"},"scope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition scope for the custom field","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"groupId":{"type":"integer","description":"Group ID for organizing custom fields","format":"int32"},"addToDefaultTab":{"type":"boolean","description":"Whether to add to the default tab"}}}}}},"CreateNodeAttributeContentPublicApi":{"type":"object","properties":{"values":{"type":"array","description":"List of predefined values for dropdown/radio types","items":{"type":"object","properties":{"name":{"type":"string","description":"Display name for the option"}},"description":"List of predefined values for dropdown/radio types"}},"required":{"type":"boolean","description":"Whether the field is required"},"footerText":{"type":"string","description":"Footer text displayed below the field"},"tooltipText":{"type":"string","description":"Tooltip text for the field"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Content configuration for the custom field"},"CreateNodeAttributeContentValuePublicApi":{"type":"object","properties":{"name":{"type":"string","description":"Display name for the option"}},"description":"List of predefined values for dropdown/radio types"},"CreateNodeAttributePublicApiRequest":{"required":["fieldName","label"],"type":"object","properties":{"label":{"type":"string","description":"Display label for the custom field"},"fieldName":{"type":"string","description":"Unique field name for API access (used when accessing the value programmatically)"},"description":{"type":"string","description":"Description of the custom field"},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"defaultValue":{"type":"string","description":"Default value for the custom field. This only has an effect for DROPDOWN and MULTI_SELECT attributes"},"content":{"type":"object","properties":{"values":{"type":"array","description":"List of predefined values for dropdown/radio types","items":{"type":"object","properties":{"name":{"type":"string","description":"Display name for the option"}},"description":"List of predefined values for dropdown/radio types"}},"required":{"type":"boolean","description":"Whether the field is required"},"footerText":{"type":"string","description":"Footer text displayed below the field"},"tooltipText":{"type":"string","description":"Tooltip text for the field"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Content configuration for the custom field"},"scope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition scope for the custom field","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"groupId":{"type":"integer","description":"Group ID for organizing custom fields","format":"int32"},"addToDefaultTab":{"type":"boolean","description":"Whether to add to the default tab"}}},"BulkUpdateNodeAttributePublicApiRequest":{"type":"object","properties":{"customFields":{"type":"array","description":"List of custom fields to update","items":{"type":"object","properties":{"label":{"type":"string","description":"Display label for the custom field"},"fieldName":{"type":"string","description":"Unique field name for API access (recommended for programmatic access)"},"description":{"type":"string","description":"Description of the custom field"},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"defaultValue":{"type":"string","description":"Default value for the custom field"},"content":{"type":"object","properties":{"values":{"type":"array","description":"List of predefined values for dropdown/radio types","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the existing option (null for new options)","format":"uuid"},"name":{"type":"string","description":"Display name for the option"},"active":{"type":"boolean","description":"Whether the option is active"},"system":{"type":"boolean","description":"Whether the option is a system option"}},"description":"List of predefined values for dropdown/radio types"}},"required":{"type":"boolean","description":"Whether the field is required"},"footerText":{"type":"string","description":"Footer text displayed below the field"},"tooltipText":{"type":"string","description":"Tooltip text for the field"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Content configuration for the custom field"},"active":{"type":"boolean","description":"Whether the custom field is active"},"scope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition scope for the custom field","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"groupId":{"type":"integer","description":"Group ID for organizing custom fields","format":"int32"}}}}}},"UpdateNodeAttributeContentPublicApi":{"type":"object","properties":{"values":{"type":"array","description":"List of predefined values for dropdown/radio types","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the existing option (null for new options)","format":"uuid"},"name":{"type":"string","description":"Display name for the option"},"active":{"type":"boolean","description":"Whether the option is active"},"system":{"type":"boolean","description":"Whether the option is a system option"}},"description":"List of predefined values for dropdown/radio types"}},"required":{"type":"boolean","description":"Whether the field is required"},"footerText":{"type":"string","description":"Footer text displayed below the field"},"tooltipText":{"type":"string","description":"Tooltip text for the field"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Content configuration for the custom field"},"UpdateNodeAttributeContentValuePublicApi":{"type":"object","properties":{"id":{"type":"string","description":"ID of the existing option (null for new options)","format":"uuid"},"name":{"type":"string","description":"Display name for the option"},"active":{"type":"boolean","description":"Whether the option is active"},"system":{"type":"boolean","description":"Whether the option is a system option"}},"description":"List of predefined values for dropdown/radio types"},"UpdateNodeAttributePublicApiRequest":{"type":"object","properties":{"label":{"type":"string","description":"Display label for the custom field"},"fieldName":{"type":"string","description":"Unique field name for API access (recommended for programmatic access)"},"description":{"type":"string","description":"Description of the custom field"},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"defaultValue":{"type":"string","description":"Default value for the custom field"},"content":{"type":"object","properties":{"values":{"type":"array","description":"List of predefined values for dropdown/radio types","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the existing option (null for new options)","format":"uuid"},"name":{"type":"string","description":"Display name for the option"},"active":{"type":"boolean","description":"Whether the option is active"},"system":{"type":"boolean","description":"Whether the option is a system option"}},"description":"List of predefined values for dropdown/radio types"}},"required":{"type":"boolean","description":"Whether the field is required"},"footerText":{"type":"string","description":"Footer text displayed below the field"},"tooltipText":{"type":"string","description":"Tooltip text for the field"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"Content configuration for the custom field"},"active":{"type":"boolean","description":"Whether the custom field is active"},"scope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition scope for the custom field","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"groupId":{"type":"integer","description":"Group ID for organizing custom fields","format":"int32"}}},"SupportPaginationResponse":{"type":"object","properties":{"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"results":{"type":"array","items":{"type":"object"}}}},"Cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"NodeAttributesPublicDtoReport":{"type":"object","properties":{"results":{"type":"array","items":{"type":"object","properties":{"entityType":{"type":"string","description":"Entity type that this custom field or operation applies to","enum":["USER","NODE","TICKET","DOCUMENT","INPUT_FIELD_FORM"]},"scope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition Scope","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"label":{"type":"string","description":"Label"},"description":{"type":"string","description":"Description"},"name":{"type":"string","description":"Name"},"defaultValue":{"type":"string","description":"Default Value"},"endUserPermission":{"type":"string","description":"End user access level for custom fields in the UI","enum":["HIDDEN","EDITABLE_OPTIONAL","EDITABLE_REQUIRED","READ_ONLY"]},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"content":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean"},"footerText":{"type":"string"},"tooltipText":{"type":"string"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}}},"system":{"type":"boolean","description":"System"},"active":{"type":"boolean","description":"Active"},"createTime":{"type":"number","description":"Create Time","format":"double"},"updateTime":{"type":"number","description":"Update Time","format":"double"}}}},"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}}}},"RelatedItemPublicApiDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Identifier","format":"int32"},"type":{"type":"string","description":"Type of Relation","enum":["VALUE","ENTITY"]},"entity":{"type":"object","description":"Entity"},"entityId":{"type":"integer","description":"Entity Identifier","format":"int32"},"entityType":{"type":"string","description":"Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","CHECKLIST","KB_DOCUMENT","END_USER","SOFTWARE_LICENSE"]},"relEntity":{"type":"object","description":"Related Entity"},"relEntityId":{"type":"integer","description":"Related Entity Identifier","format":"int32"},"relEntityType":{"type":"string","description":"Related Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","ATTACHMENT","TECHNICIAN","CREDENTIAL","CHECKLIST","END_USER","CONTACT","KB_DOCUMENT","SOFTWARE_LICENSE","SECURE"]},"value":{"type":"object","description":"Related item value (Attachment meta data / Secure information)"},"createTime":{"type":"number","description":"Creation time","format":"double"},"updateTime":{"type":"number","description":"Last update time","format":"double"},"createdByAppUserId":{"type":"integer","description":"The identifier of the user who created the related item","format":"int32"},"updatedByAppUserId":{"type":"integer","description":"The identifier of the last user to update the related item","format":"int32"}}},"NewRelatedItemEntityRequest":{"type":"object","properties":{"relEntityType":{"type":"string","description":"Related Entity Type","enum":["ORGANIZATION","DOCUMENT","LOCATION","NODE","ATTACHMENT","TECHNICIAN","CREDENTIAL","CHECKLIST","END_USER","CONTACT","KB_DOCUMENT","SOFTWARE_LICENSE"]},"relEntityId":{"type":"integer","description":"Related Entity Identifier","format":"int32"}}},"NewRelatedItemSecureValueRequest":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"url":{"type":"string","description":"URL"},"notes":{"type":"string","description":"Notes"},"username":{"type":"string","description":"Username"},"password":{"type":"string","description":"Password"},"totpSecret":{"type":"string","description":"TOTP Secret"}}},"Asset":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the asset","format":"int32"},"entityType":{"type":"string","description":"Type of the entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"name":{"type":"string","description":"Name of the asset"},"clientId":{"type":"integer","description":"Client identifier, if applicable","format":"int32"}},"description":"Target asset in the relationship"},"AssetRelationMinimalDTO":{"type":"object","properties":{"relationId":{"type":"integer","description":"Unique identifier of the relationship","format":"int32"},"source":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the asset","format":"int32"},"entityType":{"type":"string","description":"Type of the entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"name":{"type":"string","description":"Name of the asset"},"clientId":{"type":"integer","description":"Client identifier, if applicable","format":"int32"}},"description":"Target asset in the relationship"},"target":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the asset","format":"int32"},"entityType":{"type":"string","description":"Type of the entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"name":{"type":"string","description":"Name of the asset"},"clientId":{"type":"integer","description":"Client identifier, if applicable","format":"int32"}},"description":"Target asset in the relationship"},"relation":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the relation type","format":"int32"},"forwardLabel":{"type":"string","description":"Label for the forward direction"},"reverseLabel":{"type":"string","description":"Label for the reverse direction"},"systemDefault":{"type":"boolean","description":"Whether this is a system default relation"}},"description":"Type of the relationship"}},"description":"List of asset relationships"},"CreateAssetRelationshipRequest":{"type":"object","properties":{"sourceId":{"type":"integer","description":"Unique identifier of the source entity","format":"int32"},"sourceType":{"type":"string","description":"Type of the source entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"targetId":{"type":"integer","description":"Unique identifier of the target entity","format":"int32"},"targetType":{"type":"string","description":"Type of the target entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"relationshipTypeId":{"type":"integer","description":"Unique identifier of the relationship type","format":"int32"}}},"CreateAssetRelationshipsResponse":{"type":"object","properties":{"successfulRelationships":{"type":"array","description":"List of successfully created relationships","items":{"type":"object","properties":{"relationId":{"type":"integer","description":"Unique identifier of the relationship","format":"int32"},"source":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the asset","format":"int32"},"entityType":{"type":"string","description":"Type of the entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"name":{"type":"string","description":"Name of the asset"},"clientId":{"type":"integer","description":"Client identifier, if applicable","format":"int32"}},"description":"Target asset in the relationship"},"target":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the asset","format":"int32"},"entityType":{"type":"string","description":"Type of the entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"name":{"type":"string","description":"Name of the asset"},"clientId":{"type":"integer","description":"Client identifier, if applicable","format":"int32"}},"description":"Target asset in the relationship"},"relation":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the relation type","format":"int32"},"forwardLabel":{"type":"string","description":"Label for the forward direction"},"reverseLabel":{"type":"string","description":"Label for the reverse direction"},"systemDefault":{"type":"boolean","description":"Whether this is a system default relation"}},"description":"Type of the relationship"}},"description":"List of asset relationships"}},"errors":{"type":"array","description":"List of failed relationship creation attempts","items":{"type":"object","properties":{"requestIndex":{"type":"integer","description":"Index of the failed request in the original array (zero-based)","format":"int32"},"request":{"type":"object","properties":{"sourceId":{"type":"integer","description":"Unique identifier of the source entity","format":"int32"},"sourceType":{"type":"string","description":"Type of the source entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"targetId":{"type":"integer","description":"Unique identifier of the target entity","format":"int32"},"targetType":{"type":"string","description":"Type of the target entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"relationshipTypeId":{"type":"integer","description":"Unique identifier of the relationship type","format":"int32"}}},"errorCode":{"type":"string","description":"Error code indicating the failure reason"},"errorMessage":{"type":"string","description":"Human-readable error message"}},"description":"List of failed relationship creation attempts"}}}},"RelationType":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the relation type","format":"int32"},"forwardLabel":{"type":"string","description":"Label for the forward direction"},"reverseLabel":{"type":"string","description":"Label for the reverse direction"},"systemDefault":{"type":"boolean","description":"Whether this is a system default relation"}},"description":"Type of the relationship"},"RelationshipCreationError":{"type":"object","properties":{"requestIndex":{"type":"integer","description":"Index of the failed request in the original array (zero-based)","format":"int32"},"request":{"type":"object","properties":{"sourceId":{"type":"integer","description":"Unique identifier of the source entity","format":"int32"},"sourceType":{"type":"string","description":"Type of the source entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"targetId":{"type":"integer","description":"Unique identifier of the target entity","format":"int32"},"targetType":{"type":"string","description":"Type of the target entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"relationshipTypeId":{"type":"integer","description":"Unique identifier of the relationship type","format":"int32"}}},"errorCode":{"type":"string","description":"Error code indicating the failure reason"},"errorMessage":{"type":"string","description":"Human-readable error message"}},"description":"List of failed relationship creation attempts"},"RelationshipTypeDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"relationshipName":{"type":"string"},"secondaryRelationshipName":{"type":"string"},"system":{"type":"boolean"},"active":{"type":"boolean"},"description":{"type":"string"}}},"CreateRelationshipTypeRequest":{"required":["forwardLabel","reverseLabel"],"type":"object","properties":{"forwardLabel":{"type":"string","description":"Label for the forward direction"},"reverseLabel":{"type":"string","description":"Label for the reverse direction"},"description":{"type":"string","description":"Description of the relation type"}}},"PageInfo":{"type":"object","properties":{"count":{"type":"integer","description":"Total count of results in this page","format":"int32"},"nextCursor":{"type":"string","description":"Cursor for the next page. Use with 'after' parameter."},"previousCursor":{"type":"string","description":"Cursor for the previous page. Use with 'before' parameter."},"hasMore":{"type":"boolean","description":"Indicates if there are more results after this page"},"hasPrevious":{"type":"boolean","description":"Indicates if there are results before this page"}},"description":"Pagination information for paginated responses"},"RelationTypePageResponse":{"type":"object","properties":{"results":{"type":"array","description":"List of relationship types","items":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the relation type","format":"int32"},"forwardLabel":{"type":"string","description":"Label for the forward direction"},"reverseLabel":{"type":"string","description":"Label for the reverse direction"},"systemDefault":{"type":"boolean","description":"Whether this is a system default relation"}},"description":"Type of the relationship"}},"pageInfo":{"type":"object","properties":{"count":{"type":"integer","description":"Total count of results in this page","format":"int32"},"nextCursor":{"type":"string","description":"Cursor for the next page. Use with 'after' parameter."},"previousCursor":{"type":"string","description":"Cursor for the previous page. Use with 'before' parameter."},"hasMore":{"type":"boolean","description":"Indicates if there are more results after this page"},"hasPrevious":{"type":"boolean","description":"Indicates if there are results before this page"}},"description":"Pagination information for paginated responses"}},"description":"Paginated response containing relationship types"},"AssetRelationPageResponse":{"type":"object","properties":{"results":{"type":"array","description":"List of asset relationships","items":{"type":"object","properties":{"relationId":{"type":"integer","description":"Unique identifier of the relationship","format":"int32"},"source":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the asset","format":"int32"},"entityType":{"type":"string","description":"Type of the entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"name":{"type":"string","description":"Name of the asset"},"clientId":{"type":"integer","description":"Client identifier, if applicable","format":"int32"}},"description":"Target asset in the relationship"},"target":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the asset","format":"int32"},"entityType":{"type":"string","description":"Type of the entity","enum":["DEVICE","CHECKLIST","CONTACT","CREDENTIAL","APPS_SERVICES_DOCUMENT","TECHNICIAN","END_USER","KB_ARTICLE","LOCATION","ORGANIZATION"]},"name":{"type":"string","description":"Name of the asset"},"clientId":{"type":"integer","description":"Client identifier, if applicable","format":"int32"}},"description":"Target asset in the relationship"},"relation":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the relation type","format":"int32"},"forwardLabel":{"type":"string","description":"Label for the forward direction"},"reverseLabel":{"type":"string","description":"Label for the reverse direction"},"systemDefault":{"type":"boolean","description":"Whether this is a system default relation"}},"description":"Type of the relationship"}},"description":"List of asset relationships"}},"pageInfo":{"type":"object","properties":{"count":{"type":"integer","description":"Total count of results in this page","format":"int32"},"nextCursor":{"type":"string","description":"Cursor for the next page. Use with 'after' parameter."},"previousCursor":{"type":"string","description":"Cursor for the previous page. Use with 'before' parameter."},"hasMore":{"type":"boolean","description":"Indicates if there are more results after this page"},"hasPrevious":{"type":"boolean","description":"Indicates if there are results before this page"}},"description":"Pagination information for paginated responses"}},"description":"Paginated response containing asset relationships"},"AssigmentAutomationSettings":{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"DeviceAutomationSettings":{"type":"object","allOf":[{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},{"type":"object","properties":{"normalizedSoftwareName":{"type":"string"},"inventory":{"type":"object","properties":{"criteriaArgs":{"type":"object","additionalProperties":{"type":"object"}}}},"deviceSearchGroups":{"type":"object","properties":{"groupIds":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"operator":{"type":"string","enum":["ANY","ALL"]}}},"currentGroups":{"uniqueItems":true,"type":"array","writeOnly":true,"items":{"type":"integer","format":"int32"}}}}]},"DeviceSearchGroups":{"type":"object","properties":{"groupIds":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"operator":{"type":"string","enum":["ANY","ALL"]}}},"EndUserRoles":{"type":"object","properties":{"roleIds":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"operator":{"type":"string","enum":["ANY","ALL"]}}},"LicenseAssignmentListDTO":{"type":"object","properties":{"licenseeId":{"type":"integer","format":"int32"},"licenseeName":{"type":"string"},"licenseeType":{"type":"string","enum":["NODE","APP_USER","CONTACT"]},"licenseeUserType":{"type":"string","enum":["TECHNICIAN","END_USER","CONTACT"]},"licenseeOrganizationName":{"type":"string"},"licenseeOrganizationId":{"type":"integer","format":"int32"},"licenseeEmail":{"type":"string"},"firstFoundAt":{"type":"integer","format":"int64"},"lastUsedAt":{"type":"integer","format":"int64"},"hasViewAccess":{"type":"boolean"}}},"NotificationConfiguration":{"type":"object","properties":{"email":{"type":"string"},"sms":{"type":"string"},"pushNotification":{"type":"string"}}},"OsTypeBinaries":{"type":"object","properties":{"osType":{"type":"string","enum":["WINDOWS","LINUX","MAC"]},"binaryNames":{"type":"array","items":{"type":"string"}},"nonMatches":{"type":"boolean"}}},"PublisherDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"ScopeClientDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"ScopeClientLocationDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"organizationId":{"type":"integer","format":"int32"}}},"SoftwareInventory":{"type":"object","properties":{"criteriaArgs":{"type":"object","additionalProperties":{"type":"object"}}}},"SoftwareLicenseDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["PER_DEVICE","PER_USER","CUSTOM"]},"automated":{"type":"boolean"},"purchaseDate":{"type":"integer","format":"int64"},"publisherId":{"type":"integer","format":"int32"},"vendorId":{"type":"integer","format":"int32"},"publisher":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"vendor":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"scope":{"type":"object","properties":{"global":{"type":"boolean"},"organizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"organizationId":{"type":"integer","format":"int32"}}}}}},"quantity":{"type":"integer","format":"int32"},"term":{"type":"object","properties":{"renewalUnit":{"type":"string","enum":["MONTH","YEAR"]},"value":{"type":"integer","format":"int32"},"expirationDate":{"type":"integer","format":"int64"},"autoRenewal":{"type":"boolean"},"generateActivityAlert":{"type":"boolean"},"daysBeforeExpiration":{"type":"integer","format":"int32"},"hasNotifiedExpirationDate":{"type":"boolean"},"hasNotifiedUpToRenewal":{"type":"boolean"}}},"notificationChannelInfo":{"type":"object","properties":{"email":{"type":"string"},"sms":{"type":"string"},"pushNotification":{"type":"string"}}},"assigmentAutomationSettings":{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"licenseAssignmentList":{"type":"array","items":{"type":"object","properties":{"licenseeId":{"type":"integer","format":"int32"},"licenseeName":{"type":"string"},"licenseeType":{"type":"string","enum":["NODE","APP_USER","CONTACT"]},"licenseeUserType":{"type":"string","enum":["TECHNICIAN","END_USER","CONTACT"]},"licenseeOrganizationName":{"type":"string"},"licenseeOrganizationId":{"type":"integer","format":"int32"},"licenseeEmail":{"type":"string"},"firstFoundAt":{"type":"integer","format":"int64"},"lastUsedAt":{"type":"integer","format":"int64"},"hasViewAccess":{"type":"boolean"}}}},"currentUsage":{"type":"integer","format":"int32"},"expired":{"type":"boolean"},"daysToExpire":{"type":"integer","format":"int32"},"note":{"type":"string"},"perLicenseCost":{"type":"number"},"totalCost":{"type":"number"},"costMode":{"type":"string","enum":["TOTAL","PER_LICENSE"]},"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]},"usageMonitoring":{"type":"array","items":{"type":"object","properties":{"osType":{"type":"string","enum":["WINDOWS","LINUX","MAC"]},"binaryNames":{"type":"array","items":{"type":"string"}},"nonMatches":{"type":"boolean"}}}},"firstFoundAt":{"type":"integer","format":"int64"},"lastUsageAt":{"type":"integer","format":"int64"}}},"SoftwareLicenseScopeDTO":{"type":"object","properties":{"global":{"type":"boolean"},"organizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"organizationId":{"type":"integer","format":"int32"}}}}}},"TechnicianRoles":{"type":"object","properties":{"roleIds":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"operator":{"type":"string","enum":["ANY","ALL"]}}},"TermResponseDTO":{"type":"object","properties":{"renewalUnit":{"type":"string","enum":["MONTH","YEAR"]},"value":{"type":"integer","format":"int32"},"expirationDate":{"type":"integer","format":"int64"},"autoRenewal":{"type":"boolean"},"generateActivityAlert":{"type":"boolean"},"daysBeforeExpiration":{"type":"integer","format":"int32"},"hasNotifiedExpirationDate":{"type":"boolean"},"hasNotifiedUpToRenewal":{"type":"boolean"}}},"UserContactAutomationSettings":{"type":"object","allOf":[{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},{"type":"object","properties":{"endUserRoles":{"type":"object","properties":{"roleIds":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"operator":{"type":"string","enum":["ANY","ALL"]}}},"technicianRoles":{"type":"object","properties":{"roleIds":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"operator":{"type":"string","enum":["ANY","ALL"]}}},"includeContacts":{"type":"boolean"}}}]},"VendorDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"LicenseScope":{"type":"object","properties":{"global":{"type":"boolean"},"organizationIds":{"type":"array","items":{"type":"integer","format":"int32"}},"locationIds":{"type":"array","items":{"type":"integer","format":"int32"}}},"description":"Indicates the scope of the software license"},"OsTypeBinariesAPIDTO":{"type":"object","properties":{"osType":{"type":"string","description":"Operating system type","example":"WINDOWS","enum":["WINDOWS","LINUX","MAC"]},"binaryNames":{"type":"array","description":"List of binary/process names to monitor","example":["chrome.exe","firefox.exe"],"items":{"type":"string","description":"List of binary/process names to monitor","example":"[\"chrome.exe\",\"firefox.exe\"]"}},"nonMatches":{"type":"boolean","description":"Flag indicating whether configured binaries don't match detected binaries"}},"description":"List of OS-specific binary configurations for usage monitoring"},"SoftwareLicenseAPIDTO":{"required":["currentUsage","description","name","notificationChannelInfo","publisherId","purchaseDate","quantity","scope","term","type","vendorId"],"type":"object","properties":{"name":{"type":"string","description":"Indicates of the name of the software license"},"description":{"maxLength":250,"minLength":0,"type":"string","description":"Indicates a description for the software license"},"type":{"type":"string","description":"Indicates the type of the software license","example":"PER_DEVICE","enum":["PER_DEVICE","PER_USER","CUSTOM"]},"purchaseDate":{"type":"integer","description":"Indicates the purchase date of the software license in unix epoch milliseconds","format":"int64","example":1672531199000},"publisherId":{"type":"integer","description":"Identifier of the publisher","format":"int32"},"vendorId":{"type":"integer","description":"Identifier of the vendor","format":"int32"},"scope":{"type":"object","properties":{"global":{"type":"boolean"},"organizationIds":{"type":"array","items":{"type":"integer","format":"int32"}},"locationIds":{"type":"array","items":{"type":"integer","format":"int32"}}},"description":"Indicates the scope of the software license"},"quantity":{"type":"integer","description":"Indicates the quantity of the software license","format":"int32"},"currentUsage":{"type":"integer","description":"Indicates the current usage of the software license","format":"int32"},"term":{"type":"object","properties":{"renewalUnit":{"type":"string","enum":["MONTH","YEAR"]},"value":{"type":"integer","format":"int32"},"expirationDate":{"type":"number","format":"double"},"autoRenewal":{"type":"boolean"},"generateActivityAlert":{"type":"boolean"},"daysBeforeExpiration":{"type":"integer","format":"int32"},"hasNotifiedExpirationDate":{"type":"boolean"},"hasNotifiedUpToRenewal":{"type":"boolean"}},"description":"Indicates the term of the software license"},"notificationChannelInfo":{"type":"object","properties":{"email":{"type":"string"},"sms":{"type":"string"},"pushNotification":{"type":"string"}}},"assigmentAutomationSettings":{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"assignedLicenses":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Indicates the ids of the assigned licensees","nullable":true,"items":{"type":"integer","description":"Indicates the ids of the assigned licensees","format":"int32","nullable":true}},"description":"Indicates the ids of the assigned licensees","nullable":true},"unassignedLicenses":{"type":"object","additionalProperties":{"uniqueItems":true,"type":"array","description":"Indicates the ids of the unassigned licensees","nullable":true,"items":{"type":"integer","description":"Indicates the ids of the unassigned licensees","format":"int32","nullable":true}},"description":"Indicates the ids of the unassigned licensees","nullable":true},"note":{"type":"string","description":"Indicates a note about the software license","nullable":true},"costMode":{"type":"string","description":"Indicates the cost mode of the software license","nullable":true,"enum":["TOTAL","PER_LICENSE"]},"cost":{"type":"number","description":"Indicates the cost of the software license","nullable":true},"usageMonitoring":{"type":"object","properties":{"binaries":{"type":"array","description":"List of OS-specific binary configurations for usage monitoring","items":{"type":"object","properties":{"osType":{"type":"string","description":"Operating system type","example":"WINDOWS","enum":["WINDOWS","LINUX","MAC"]},"binaryNames":{"type":"array","description":"List of binary/process names to monitor","example":["chrome.exe","firefox.exe"],"items":{"type":"string","description":"List of binary/process names to monitor","example":"[\"chrome.exe\",\"firefox.exe\"]"}},"nonMatches":{"type":"boolean","description":"Flag indicating whether configured binaries don't match detected binaries"}},"description":"List of OS-specific binary configurations for usage monitoring"}}},"description":"Indicates the binary usage monitoring configuration for the software license","nullable":true}}},"Term":{"type":"object","properties":{"renewalUnit":{"type":"string","enum":["MONTH","YEAR"]},"value":{"type":"integer","format":"int32"},"expirationDate":{"type":"number","format":"double"},"autoRenewal":{"type":"boolean"},"generateActivityAlert":{"type":"boolean"},"daysBeforeExpiration":{"type":"integer","format":"int32"},"hasNotifiedExpirationDate":{"type":"boolean"},"hasNotifiedUpToRenewal":{"type":"boolean"}},"description":"Indicates the term of the software license"},"UsageMonitoringAPIDTO":{"type":"object","properties":{"binaries":{"type":"array","description":"List of OS-specific binary configurations for usage monitoring","items":{"type":"object","properties":{"osType":{"type":"string","description":"Operating system type","example":"WINDOWS","enum":["WINDOWS","LINUX","MAC"]},"binaryNames":{"type":"array","description":"List of binary/process names to monitor","example":["chrome.exe","firefox.exe"],"items":{"type":"string","description":"List of binary/process names to monitor","example":"[\"chrome.exe\",\"firefox.exe\"]"}},"nonMatches":{"type":"boolean","description":"Flag indicating whether configured binaries don't match detected binaries"}},"description":"List of OS-specific binary configurations for usage monitoring"}}},"description":"Indicates the binary usage monitoring configuration for the software license","nullable":true},"SoftwareLicenseAPIResponseDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Indicates the identifier of the licensee","format":"int32"},"name":{"type":"string","description":"Indicates the name of the software license"},"type":{"type":"string","description":"Indicates the type of the software license","enum":["PER_DEVICE","PER_USER","CUSTOM"]},"description":{"type":"string","description":"Indicates a description for the software license"},"purchaseDate":{"type":"integer","description":"Indicates the purchase date of the software license in unix","format":"int64"},"automated":{"type":"boolean","description":"Indicates if the software license assignment is automated"},"publisher":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"vendor":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"scope":{"type":"object","properties":{"global":{"type":"boolean"},"organizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"organizationId":{"type":"integer","format":"int32"}}}}}},"quantity":{"type":"integer","description":"Indicates the quantity of the software license","format":"int32"},"term":{"type":"object","properties":{"renewalUnit":{"type":"string","enum":["MONTH","YEAR"]},"value":{"type":"integer","format":"int32"},"expirationDate":{"type":"integer","format":"int64"},"autoRenewal":{"type":"boolean"},"generateActivityAlert":{"type":"boolean"},"daysBeforeExpiration":{"type":"integer","format":"int32"},"hasNotifiedExpirationDate":{"type":"boolean"},"hasNotifiedUpToRenewal":{"type":"boolean"}}},"notificationChannelInfo":{"type":"object","properties":{"email":{"type":"string"},"sms":{"type":"string"},"pushNotification":{"type":"string"}}},"assigmentAutomationSettings":{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"currentUsage":{"type":"integer","description":"Indicates the current usage of the software license","format":"int32"},"expired":{"type":"boolean","description":"Indicates itf the software license is expired"},"daysToExpire":{"type":"integer","description":"Indicates the days to expire the software license","format":"int32"},"note":{"type":"string","description":"Indicates if exists notes of the software license"},"automation":{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"usageMonitoring":{"type":"array","description":"Indicates the binary usage monitoring configuration","items":{"type":"object","properties":{"osType":{"type":"string","enum":["WINDOWS","LINUX","MAC"]},"binaryNames":{"type":"array","items":{"type":"string"}},"nonMatches":{"type":"boolean"}}}}},"description":"List of software licenses"},"SoftwareLicensePageResponse":{"type":"object","properties":{"results":{"type":"array","description":"List of software licenses","items":{"type":"object","properties":{"id":{"type":"integer","description":"Indicates the identifier of the licensee","format":"int32"},"name":{"type":"string","description":"Indicates the name of the software license"},"type":{"type":"string","description":"Indicates the type of the software license","enum":["PER_DEVICE","PER_USER","CUSTOM"]},"description":{"type":"string","description":"Indicates a description for the software license"},"purchaseDate":{"type":"integer","description":"Indicates the purchase date of the software license in unix","format":"int64"},"automated":{"type":"boolean","description":"Indicates if the software license assignment is automated"},"publisher":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"vendor":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"scope":{"type":"object","properties":{"global":{"type":"boolean"},"organizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"organizationId":{"type":"integer","format":"int32"}}}}}},"quantity":{"type":"integer","description":"Indicates the quantity of the software license","format":"int32"},"term":{"type":"object","properties":{"renewalUnit":{"type":"string","enum":["MONTH","YEAR"]},"value":{"type":"integer","format":"int32"},"expirationDate":{"type":"integer","format":"int64"},"autoRenewal":{"type":"boolean"},"generateActivityAlert":{"type":"boolean"},"daysBeforeExpiration":{"type":"integer","format":"int32"},"hasNotifiedExpirationDate":{"type":"boolean"},"hasNotifiedUpToRenewal":{"type":"boolean"}}},"notificationChannelInfo":{"type":"object","properties":{"email":{"type":"string"},"sms":{"type":"string"},"pushNotification":{"type":"string"}}},"assigmentAutomationSettings":{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"currentUsage":{"type":"integer","description":"Indicates the current usage of the software license","format":"int32"},"expired":{"type":"boolean","description":"Indicates itf the software license is expired"},"daysToExpire":{"type":"integer","description":"Indicates the days to expire the software license","format":"int32"},"note":{"type":"string","description":"Indicates if exists notes of the software license"},"automation":{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"usageMonitoring":{"type":"array","description":"Indicates the binary usage monitoring configuration","items":{"type":"object","properties":{"osType":{"type":"string","enum":["WINDOWS","LINUX","MAC"]},"binaryNames":{"type":"array","items":{"type":"string"}},"nonMatches":{"type":"boolean"}}}}},"description":"List of software licenses"}},"pageInfo":{"type":"object","properties":{"count":{"type":"integer","description":"Total count of results in this page","format":"int32"},"nextCursor":{"type":"string","description":"Cursor for the next page. Use with 'after' parameter."},"previousCursor":{"type":"string","description":"Cursor for the previous page. Use with 'before' parameter."},"hasMore":{"type":"boolean","description":"Indicates if there are more results after this page"},"hasPrevious":{"type":"boolean","description":"Indicates if there are results before this page"}},"description":"Pagination information for paginated responses"}},"description":"Paginated response containing software licenses"},"SoftwareLicenseResponseDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string","enum":["PER_DEVICE","PER_USER","CUSTOM"]},"automated":{"type":"boolean"},"purchaseDate":{"type":"integer","format":"int64"},"publisher":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"vendor":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"}}},"scope":{"type":"object","properties":{"global":{"type":"boolean"},"organizations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}}},"locations":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"organizationId":{"type":"integer","format":"int32"}}}}}},"quantity":{"type":"integer","format":"int32"},"term":{"type":"object","properties":{"renewalUnit":{"type":"string","enum":["MONTH","YEAR"]},"value":{"type":"integer","format":"int32"},"expirationDate":{"type":"integer","format":"int64"},"autoRenewal":{"type":"boolean"},"generateActivityAlert":{"type":"boolean"},"daysBeforeExpiration":{"type":"integer","format":"int32"},"hasNotifiedExpirationDate":{"type":"boolean"},"hasNotifiedUpToRenewal":{"type":"boolean"}}},"notificationChannelInfo":{"type":"object","properties":{"email":{"type":"string"},"sms":{"type":"string"},"pushNotification":{"type":"string"}}},"assigmentAutomationSettings":{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"licenseAssignmentList":{"type":"array","items":{"type":"object","properties":{"licenseeId":{"type":"integer","format":"int32"},"licenseeName":{"type":"string"},"licenseeType":{"type":"string","enum":["NODE","APP_USER","CONTACT"]},"licenseeUserType":{"type":"string","enum":["TECHNICIAN","END_USER","CONTACT"]},"licenseeOrganizationName":{"type":"string"},"licenseeOrganizationId":{"type":"integer","format":"int32"},"licenseeEmail":{"type":"string"},"firstFoundAt":{"type":"integer","format":"int64"},"lastUsedAt":{"type":"integer","format":"int64"},"hasViewAccess":{"type":"boolean"}}}},"currentUsage":{"type":"integer","format":"int32"},"expired":{"type":"boolean"},"daysToExpire":{"type":"integer","format":"int32"},"note":{"type":"string"},"perLicenseCost":{"type":"number"},"totalCost":{"type":"number"},"costMode":{"type":"string","enum":["TOTAL","PER_LICENSE"]},"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]},"automation":{"required":["type"],"type":"object","properties":{"assignmentType":{"type":"string","enum":["NORMALIZED_SOFTWARE","SOFTWARE_INVENTORY","DEVICE_SEARCH_GROUPS","USER_CONTACT"]},"type":{"type":"string"}},"discriminator":{"propertyName":"type"}},"usageMonitoring":{"type":"array","items":{"type":"object","properties":{"osType":{"type":"string","enum":["WINDOWS","LINUX","MAC"]},"binaryNames":{"type":"array","items":{"type":"string"}},"nonMatches":{"type":"boolean"}}}}}},"LicenseAssignmentPublicAPIDTO":{"type":"object","properties":{"licenseeId":{"type":"integer","description":"Indicates the identifier of the licensee","format":"int32"},"licenseeName":{"type":"string","description":"Indicates the name of the licensee"},"licenseeOrganizationName":{"type":"string","description":"Indicates the organization name of the licensee"},"licenseeOrganizationId":{"type":"integer","description":"Indicates the organization identifier of the licensee","format":"int32"},"licenseeEmail":{"type":"string","description":"Indicates the email of the licensee"},"lastUsedAt":{"type":"integer","description":"The last usage timestamp in unix epoch seconds","format":"int64","example":1672531199},"hasViewAccess":{"type":"boolean","description":"Indicates if the requester has access to view the licensee details"}},"description":"List of license assignments"},"SoftwareLicenseAssignmentsPageResponse":{"type":"object","properties":{"results":{"type":"array","description":"List of license assignments","items":{"type":"object","properties":{"licenseeId":{"type":"integer","description":"Indicates the identifier of the licensee","format":"int32"},"licenseeName":{"type":"string","description":"Indicates the name of the licensee"},"licenseeOrganizationName":{"type":"string","description":"Indicates the organization name of the licensee"},"licenseeOrganizationId":{"type":"integer","description":"Indicates the organization identifier of the licensee","format":"int32"},"licenseeEmail":{"type":"string","description":"Indicates the email of the licensee"},"lastUsedAt":{"type":"integer","description":"The last usage timestamp in unix epoch seconds","format":"int64","example":1672531199},"hasViewAccess":{"type":"boolean","description":"Indicates if the requester has access to view the licensee details"}},"description":"List of license assignments"}},"pageInfo":{"type":"object","properties":{"count":{"type":"integer","description":"Total count of results in this page","format":"int32"},"nextCursor":{"type":"string","description":"Cursor for the next page. Use with 'after' parameter."},"previousCursor":{"type":"string","description":"Cursor for the previous page. Use with 'before' parameter."},"hasMore":{"type":"boolean","description":"Indicates if there are more results after this page"},"hasPrevious":{"type":"boolean","description":"Indicates if there are results before this page"}},"description":"Pagination information for paginated responses"}},"description":"Paginated response containing license assignments"},"UpdateLicenseAssignmentLastUsageDTO":{"type":"object","properties":{"licenseId":{"type":"integer","description":"The identifier of the software license","format":"int32"},"licenseeId":{"type":"integer","description":"The identifier of the licensee","format":"int32"},"licenseeType":{"type":"string","description":"The type of the licensee","enum":["NODE","APP_USER","CONTACT"]},"lastUsage":{"type":"integer","description":"The last usage timestamp in unix epoch seconds","format":"int64","example":1672531199}}},"LicenseScopeAPIDTO":{"type":"object","properties":{"global":{"type":"boolean","description":"Indicates if the scope is global"},"organizationNames":{"type":"array","description":"Indicates the organization names for the scope","items":{"type":"string","description":"Indicates the organization names for the scope"}},"locationNames":{"type":"array","description":"Indicates the location names for the scope","items":{"type":"string","description":"Indicates the location names for the scope"}}},"description":"Indicates the scope of the software license"},"SoftwareLicenseUpsertAPIDTO":{"required":["name","publisherName","quantity","scope","type","vendorName"],"type":"object","properties":{"name":{"type":"string","description":"Indicates the name of the software license"},"description":{"maxLength":250,"minLength":0,"type":"string","description":"Indicates a description for the software license","nullable":true},"type":{"type":"string","description":"Indicates the type of the software license","example":"PER_DEVICE","enum":["PER_DEVICE","PER_USER","CUSTOM"]},"date":{"type":"integer","description":"Indicates the purchase date of the software license in unix epoch milliseconds","format":"int64","nullable":true,"example":1672531199000},"publisherName":{"type":"string","description":"Name of the publisher"},"vendorName":{"type":"string","description":"Name of the vendor"},"scope":{"type":"object","properties":{"global":{"type":"boolean","description":"Indicates if the scope is global"},"organizationNames":{"type":"array","description":"Indicates the organization names for the scope","items":{"type":"string","description":"Indicates the organization names for the scope"}},"locationNames":{"type":"array","description":"Indicates the location names for the scope","items":{"type":"string","description":"Indicates the location names for the scope"}}},"description":"Indicates the scope of the software license"},"quantity":{"type":"integer","description":"Indicates the quantity of the software license","format":"int32"},"currentUsage":{"type":"integer","description":"Indicates the current usage of the software license","format":"int32","nullable":true},"currentLicensees":{"uniqueItems":true,"type":"array","description":"Indicates the names of assigned licensees and removes those not specified","items":{"type":"string","description":"Indicates the names of assigned licensees and removes those not specified"}},"licenseesToAssign":{"uniqueItems":true,"type":"array","description":"Indicates the names of the licensees on which the license will be assigned","items":{"type":"string","description":"Indicates the names of the licensees on which the license will be assigned"}},"licenseesToRemove":{"uniqueItems":true,"type":"array","description":"Indicates the names of the licensees on which the license will be remowed","items":{"type":"string","description":"Indicates the names of the licensees on which the license will be remowed"}},"note":{"type":"string","description":"Indicates a note about the software license","nullable":true},"costMode":{"type":"string","description":"Indicates the cost mode of the software license","nullable":true,"enum":["TOTAL","PER_LICENSE"]},"cost":{"type":"number","description":"Indicates the cost of the software license","nullable":true},"usageMonitoring":{"type":"object","properties":{"binaries":{"type":"array","description":"List of OS-specific binary configurations for usage monitoring","items":{"type":"object","properties":{"osType":{"type":"string","description":"Operating system type","example":"WINDOWS","enum":["WINDOWS","LINUX","MAC"]},"binaryNames":{"type":"array","description":"List of binary/process names to monitor","example":["chrome.exe","firefox.exe"],"items":{"type":"string","description":"List of binary/process names to monitor","example":"[\"chrome.exe\",\"firefox.exe\"]"}},"nonMatches":{"type":"boolean","description":"Flag indicating whether configured binaries don't match detected binaries"}},"description":"List of OS-specific binary configurations for usage monitoring"}}},"description":"Indicates the binary usage monitoring configuration for the software license","nullable":true}}},"CreateUnmanagedDevicePublicApiResponseDTO":{"type":"object","properties":{"nodeId":{"type":"integer","format":"int32"}}},"AssetFieldsPublicApiRequest":{"type":"object","properties":{"serialNumber":{"type":"string","description":"The SerialNumber to use for the new device"},"assetId":{"type":"string","description":"The asset id to use for the new device"},"assetStatus":{"type":"string","description":"The asset status to use for the new device"},"assetPurchaseDate":{"type":"number","description":"The purchase date of the new device","format":"double"},"assetPurchaseAmount":{"type":"number","description":"The purchase amount of the new device","format":"double"},"assetExpectedLifetime":{"type":"string","description":"The expected lifetime of the new device"}},"description":"The asset information"},"CreateUnmanagedDevicePublicApiRequest":{"required":["locationId","name","orgId","roleId"],"type":"object","properties":{"name":{"maxLength":200,"minLength":0,"type":"string","description":"The display name of the device to be created"},"orgId":{"type":"integer","description":"The id of the organization the device belongs to","format":"int32"},"locationId":{"type":"integer","description":"The id of the location the device belongs to","format":"int32"},"roleId":{"type":"integer","description":"The id of the role to use for this device. Must be a sub-role of Unmanaged Device ","format":"int32"},"assignedUserUid":{"type":"string","description":"The UUID of the user this device is assigned to","format":"uuid"},"warrantyStartDate":{"type":"number","description":"The warranty start date for the device, in unix epoch seconds","format":"double"},"warrantyEndDate":{"type":"number","description":"The warranty end date for the device, in unix epoch seconds","format":"double"},"assetFields":{"type":"object","properties":{"serialNumber":{"type":"string","description":"The SerialNumber to use for the new device"},"assetId":{"type":"string","description":"The asset id to use for the new device"},"assetStatus":{"type":"string","description":"The asset status to use for the new device"},"assetPurchaseDate":{"type":"number","description":"The purchase date of the new device","format":"double"},"assetPurchaseAmount":{"type":"number","description":"The purchase amount of the new device","format":"double"},"assetExpectedLifetime":{"type":"string","description":"The expected lifetime of the new device"}},"description":"The asset information"}}},"DecommissionUnmanagedDeviceListPublicApiRequest":{"required":["nodeIds"],"type":"object","properties":{"nodeIds":{"maxItems":100,"minItems":0,"type":"array","description":"The ids of the devices to be decommissioned","items":{"type":"integer","description":"The ids of the devices to be decommissioned","format":"int32"}}}},"UpdateUnmanagedDevicePublicApiRequest":{"required":["locationId","name","orgId"],"type":"object","properties":{"name":{"maxLength":200,"minLength":0,"type":"string","description":"The display name of the device to be updated"},"orgId":{"type":"integer","description":"The id of the organization the device belongs to","format":"int32"},"locationId":{"type":"integer","description":"The id of the location the device belongs to","format":"int32"},"assignedUserUid":{"type":"string","description":"The UUID of the user this device is assigned to","format":"uuid"},"warrantyStartDate":{"type":"number","description":"The warranty start date for the device, in unix epoch seconds","format":"double"},"warrantyEndDate":{"type":"number","description":"The warranty end date for the device, in unix epoch seconds","format":"double"},"assetFields":{"type":"object","properties":{"serialNumber":{"type":"string","description":"The SerialNumber to use for the new device"},"assetId":{"type":"string","description":"The asset id to use for the new device"},"assetStatus":{"type":"string","description":"The asset status to use for the new device"},"assetPurchaseDate":{"type":"number","description":"The purchase date of the new device","format":"double"},"assetPurchaseAmount":{"type":"number","description":"The purchase amount of the new device","format":"double"},"assetExpectedLifetime":{"type":"string","description":"The expected lifetime of the new device"}},"description":"The asset information"}}},"BackupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"},"BackupBandwidthThrottleWorkSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"},"DeviceBackupBandwidthThrottleSettingRequest":{"type":"object","properties":{"deviceId":{"type":"integer","format":"int32"},"bandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Request of the Device Bandwidth Throttle setting."},"LockhartIntegrityCheckJobCreationResponse":{"type":"object","properties":{"result":{"type":"string","enum":["SUCCESS","FAILURE","UNSUPPORTED","UNCOMPLETED","MISSED"]},"jobUid":{"type":"string","format":"uuid"},"deviceId":{"type":"integer","format":"int32"},"planGuid":{"type":"string","format":"uuid"},"planName":{"type":"string"},"planType":{"type":"string"}},"description":"Response of the Integrity Check Job creation."},"LockhartIntegrityCheckJobCreationRequest":{"type":"object","properties":{"deviceId":{"type":"integer","format":"int32"},"planUid":{"type":"string","format":"uuid"}},"description":"Request of the Integrity Check Job creation."},"NinjaPsaAccountPublicApiDTO":{"title":"NinjaOneBillingAccountResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"code":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"system":{"type":"boolean"}},"description":"Representation of a ninja billing Account."},"NinjaPsaAccountPublicApiRequest":{"title":"NinjaOneBillingAccountRequest","required":["code","name"],"type":"object","properties":{"code":{"maxLength":20,"minLength":0,"type":"string","description":"Unique code used to identify the account.","example":"ACCOUNT_NAME"},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Display name of the account.","example":"Account example name"},"description":{"maxLength":250,"minLength":0,"type":"string","description":"Optional description of the account.","example":"This is an example description of the account."}},"description":"Representation of a ninja billing Account request."},"BusinessHours":{"type":"object","properties":{"twentyFourSeven":{"type":"boolean"},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"startHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"endHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"allDayClosed":{"type":"boolean"}}}}},"description":"Days and time the work registered in tickets will be registered as off hours."},"NinjaPsaAgreementContentPublicApiDTO":{"type":"object","properties":{"interval":{"type":"string","nullable":true},"billDate":{"type":"string","nullable":true},"startDate":{"type":"string"},"endDate":{"type":"string","nullable":true},"businessHours":{"type":"object","properties":{"twentyFourSeven":{"type":"boolean"},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"startHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"endHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"allDayClosed":{"type":"boolean"}}}}},"description":"Days and time the work registered in tickets will be registered as off hours."}}},"NinjaPsaAgreementProductPublicApiDTO":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true},"NinjaPsaAgreementPublicApiDTO":{"title":"NinjaOneBillingAgreementResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"invoiceGenerationType":{"type":"string","enum":["AUTOMATIC","MANUAL","ONE_OFF"]},"lastBillDate":{"type":"number","format":"double","nullable":true},"nextBillDate":{"type":"string","nullable":true},"nextBillingPeriodStartDate":{"type":"string","nullable":true},"lastPeriodStartDate":{"type":"string","nullable":true},"lastPeriodEndDate":{"type":"string","nullable":true},"content":{"type":"object","properties":{"interval":{"type":"string","nullable":true},"billDate":{"type":"string","nullable":true},"startDate":{"type":"string"},"endDate":{"type":"string","nullable":true},"businessHours":{"type":"object","properties":{"twentyFourSeven":{"type":"boolean"},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"startHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"endHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"allDayClosed":{"type":"boolean"}}}}},"description":"Days and time the work registered in tickets will be registered as off hours."}}},"contact":{"type":"object","properties":{"uid":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int32"},"clientId":{"type":"integer","format":"int32","nullable":true},"clientName":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string"},"deleted":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER","CONTACT"]},"enabled":{"type":"boolean"},"ninjaAdmin":{"type":"boolean"},"sysadmin":{"type":"boolean"}},"nullable":true},"taxRate":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"taxRate":{"type":"number"}},"nullable":true},"client":{"required":["deleted"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the client","format":"int32","example":789},"name":{"type":"string","description":"Name of the client","example":"Acme Corporation"},"deleted":{"type":"boolean","description":"Indicates if the client has been deleted","example":false}},"description":"Client information associated with this invoice"},"externalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"},"timeDefault":{"type":"boolean"},"businessHoursSource":{"type":"string","enum":["CUSTOM","TICKETING"]},"dueDaysSource":{"type":"string","enum":["CUSTOM","INHERIT_FROM_CONFIGURATION"]},"dueDays":{"type":"integer","format":"int32"},"allowOnlineCreditCardPayments":{"type":"boolean"},"allowOnlineAchPayments":{"type":"boolean"},"invoiceNote":{"type":"string"},"billEmails":{"type":"array","items":{"type":"string"}},"billCcEmails":{"type":"array","items":{"type":"string"}},"billBccEmails":{"type":"array","items":{"type":"string"}},"ticketBillingSettings":{"type":"object","properties":{"billTicketInAnyStatus":{"type":"boolean"},"condition":{"type":"object","properties":{"operator":{"type":"string"},"value":{"type":"string"},"metadata":{"uniqueItems":true,"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}},"nullable":true}}},"nullable":true}},"nullable":true},"multiMatchEndUsers":{"type":"boolean"},"multiMatchDevices":{"type":"boolean"},"products":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"deviceCountsProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"timeEntriesProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"endUserCountsProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"backupStorageCountsProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"softwareLicenseProducts":{"type":"array","nullable":true,"items":{"title":"NinjaOneBillingAgreementProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"productId":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"order":{"type":"integer","format":"int32"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"integrationSettings":{"type":"object","additionalProperties":true},"accountId":{"type":"integer","format":"int32"},"group":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing agreement product.","nullable":true}},"multiMatchDeviceBackups":{"type":"boolean"},"displayIncludedTimeOnInvoices":{"type":"boolean"},"taxId":{"type":"integer","format":"int32"},"autoApproveInvoice":{"type":"boolean"},"autoCompleteInvoice":{"type":"boolean"},"quickBooks":{"type":"object","properties":{"externalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"allowOnlineCreditCardPayments":{"type":"boolean"},"allowOnlineAchPayments":{"type":"boolean"}}},"xero":{"type":"object","properties":{"externalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"brandingTheme":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"nullable":true},"taxlessItemsExternalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"nullable":true},"newInvoiceStatus":{"type":"string","enum":["DRAFT","SUBMITTED","AUTHORISED"]}}},"archived":{"type":"boolean"},"active":{"type":"boolean"}},"description":"Representation of a ninja billing Agreement."},"NinjaPsaAppUserOrContactPublicApiDTO":{"type":"object","properties":{"uid":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int32"},"clientId":{"type":"integer","format":"int32","nullable":true},"clientName":{"type":"string","nullable":true},"firstName":{"type":"string","nullable":true},"lastName":{"type":"string","nullable":true},"email":{"type":"string"},"deleted":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER","CONTACT"]},"enabled":{"type":"boolean"},"ninjaAdmin":{"type":"boolean"},"sysadmin":{"type":"boolean"}},"nullable":true},"NinjaPsaBrandingThemePublicApiDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"nullable":true},"NinjaPsaClientPublicApiDTO":{"required":["deleted"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the client","format":"int32","example":789},"name":{"type":"string","description":"Name of the client","example":"Acme Corporation"},"deleted":{"type":"boolean","description":"Indicates if the client has been deleted","example":false}},"description":"Client information associated with this invoice"},"NinjaPsaExternalTaxPublicApiDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"NinjaPsaProductUserRolePublicApiDTO":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"NinjaPsaQuickBooksAgreementIntegrationDataPublicApiDTO":{"type":"object","properties":{"externalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"allowOnlineCreditCardPayments":{"type":"boolean"},"allowOnlineAchPayments":{"type":"boolean"}}},"NinjaPsaTaxRatePublicApiDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"taxRate":{"type":"number"}},"nullable":true},"NinjaPsaTaxlessItemsExternalTaxPublicApiDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"nullable":true},"NinjaPsaTicketBillingSettingsConditionPublicApiDTO":{"type":"object","properties":{"operator":{"type":"string"},"value":{"type":"string"},"metadata":{"uniqueItems":true,"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}},"nullable":true}}},"nullable":true},"NinjaPsaTicketBillingSettingsMetadataPublicApiDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}},"nullable":true},"NinjaPsaTicketBillingSettingsPublicApiDTO":{"type":"object","properties":{"billTicketInAnyStatus":{"type":"boolean"},"condition":{"type":"object","properties":{"operator":{"type":"string"},"value":{"type":"string"},"metadata":{"uniqueItems":true,"type":"array","nullable":true,"items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}},"nullable":true}}},"nullable":true}},"nullable":true},"NinjaPsaUserRolePublicApiDTO":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."},"NinjaPsaXeroAgreementIntegrationDataPublicApiDTO":{"type":"object","properties":{"externalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"brandingTheme":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"nullable":true},"taxlessItemsExternalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"nullable":true},"newInvoiceStatus":{"type":"string","enum":["DRAFT","SUBMITTED","AUTHORISED"]}}},"WeekDayHour":{"type":"object","properties":{"day":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"startHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"endHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"allDayClosed":{"type":"boolean"}}},"BrandingThemePublicApiRequest":{"title":"NinjaOneBillingXeroBrandingThemeRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Xero integration branding theme specific data."},"ConditionPublicApiRequest":{"title":"NinjaOneBillingTicketSettingsRequest","required":["operator","value"],"type":"object","properties":{"operator":{"type":"string","description":"Operation to evaluate the ticket state.","example":"parent_in","enum":["in","not_in","parent_in","parent_not_in"]},"value":{"type":"string","description":"Allowed ticket states defined.","example":"new"}},"description":"Ticket state conditions under which a ticket will be invoiced."},"NinjaPsaAgreementContentPublicApiRequest":{"title":"NinjaOneBillingAgreementContentRequest","required":["endDate","startDate"],"type":"object","properties":{"startDate":{"type":"string","description":"Effective start date of the agreement. Invoices will be generated from this date.","format":"date","example":"2026-01-09T00:00:00.000Z"},"endDate":{"type":"string","description":"Effective end date of the agreement. Invoices will not be generated from this date.","format":"date","example":"2026-09-23T00:00:00.000Z"},"businessHours":{"type":"object","properties":{"twentyFourSeven":{"type":"boolean"},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"startHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"endHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"allDayClosed":{"type":"boolean"}}}}},"description":"Days and time the work registered in tickets will be registered as off hours."},"interval":{"type":"string","description":"How frequent the automatic agreements will generate invoices.","example":"MONTHLY","enum":["ANNUAL","SEMIANNUAL","QUARTERLY","MONTHLY","BIMONTHLY","BIWEEKLY","WEEKLY","ONE_TIME"]},"billDate":{"type":"string","description":"\n                    Date or day when the invoice will be generated, depending on the billing interval:\n                    - ANNUAL: Day of the year for the invoice to be generated,\n                    even if it is in the past will be updated to the next year eg. \"2026-01-01\"\n                    - QUARTERLY: Day of the month for the invoice to be generated each quarter eg. \"23\"\n                    - MONTHLY: Day of the month for the invoice to be generated eg. \"5\"\n                    - WEEKLY: Day of the week for the invoice to be generated eg. \"WEDNESDAY\"\n                    - ONE_TIME: Specific invoice date for the invoice to be generated eg. \"2026-01-09\"\n                ","example":"MONDAY"}},"description":"Representation of a ninja billing Agreement content request."},"NinjaPsaAgreementProductPublicApiRequest":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."},"NinjaPsaAgreementPublicApiRequest":{"title":"NinjaOneBillingAgreementRequest","required":["autoApproveInvoice","autoCompleteInvoice","displayIncludedTimeOnInvoices","invoiceNote","multiMatchEndUsers","name"],"type":"object","properties":{"name":{"maxLength":50,"minLength":0,"type":"string","description":"Agreement name.","example":"Agreement Example Name"},"description":{"maxLength":250,"minLength":0,"type":"string","description":"Agreement description.","example":"Agreement description example."},"products":{"type":"array","description":"List of manual quantity type products.","items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"deviceCountsProducts":{"type":"array","writeOnly":true,"items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"softwareLicenseProducts":{"type":"array","description":"List of software license quantity type products.","items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"backupStorageCountsProducts":{"type":"array","writeOnly":true,"items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"timeEntriesProducts":{"type":"array","writeOnly":true,"items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"endUserCountsProducts":{"type":"array","writeOnly":true,"items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"content":{"title":"NinjaOneBillingAgreementContentRequest","required":["endDate","startDate"],"type":"object","properties":{"startDate":{"type":"string","description":"Effective start date of the agreement. Invoices will be generated from this date.","format":"date","example":"2026-01-09T00:00:00.000Z"},"endDate":{"type":"string","description":"Effective end date of the agreement. Invoices will not be generated from this date.","format":"date","example":"2026-09-23T00:00:00.000Z"},"businessHours":{"type":"object","properties":{"twentyFourSeven":{"type":"boolean"},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"startHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"endHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"allDayClosed":{"type":"boolean"}}}}},"description":"Days and time the work registered in tickets will be registered as off hours."},"interval":{"type":"string","description":"How frequent the automatic agreements will generate invoices.","example":"MONTHLY","enum":["ANNUAL","SEMIANNUAL","QUARTERLY","MONTHLY","BIMONTHLY","BIWEEKLY","WEEKLY","ONE_TIME"]},"billDate":{"type":"string","description":"\n                    Date or day when the invoice will be generated, depending on the billing interval:\n                    - ANNUAL: Day of the year for the invoice to be generated,\n                    even if it is in the past will be updated to the next year eg. \"2026-01-01\"\n                    - QUARTERLY: Day of the month for the invoice to be generated each quarter eg. \"23\"\n                    - MONTHLY: Day of the month for the invoice to be generated eg. \"5\"\n                    - WEEKLY: Day of the week for the invoice to be generated eg. \"WEDNESDAY\"\n                    - ONE_TIME: Specific invoice date for the invoice to be generated eg. \"2026-01-09\"\n                ","example":"MONDAY"}},"description":"Representation of a ninja billing Agreement content request."},"clientId":{"minimum":1,"type":"integer","description":"ID of the organization owner of the agreement.","format":"int32","example":2},"invoiceGenerationType":{"type":"string","description":"How the agreement invoices will be generated.","example":"MANUAL","enum":["AUTOMATIC","MANUAL","ONE_OFF"]},"multiMatchDevices":{"type":"boolean","description":"Match multiple devices when counting to generate invoices.","example":true},"multiMatchDeviceBackups":{"type":"boolean","description":"Match multiple backup devices when counting to generate invoices.","example":true},"multiMatchEndUsers":{"type":"boolean","description":"Match multiple end user devices when counting to generate invoices.","example":true},"billEmails":{"uniqueItems":true,"type":"array","description":"Primary recipient email addresses to export to 3rd party integration when invoicing.","example":["test@mail.com"],"items":{"type":"string","description":"Primary recipient email addresses to export to 3rd party integration when invoicing.","example":"[\"test@mail.com\"]"}},"billCcEmails":{"uniqueItems":true,"type":"array","description":"Copy recipient email addresses to export to 3rd party integration when invoicing.","example":["testcc@mail.com"],"items":{"type":"string","description":"Copy recipient email addresses to export to 3rd party integration when invoicing.","example":"[\"testcc@mail.com\"]"}},"billBccEmails":{"uniqueItems":true,"type":"array","description":"Hidden primary recipient email addresses to export to 3rd party integration when invoicing.","example":["testbcc@mail.com"],"items":{"type":"string","description":"Hidden primary recipient email addresses to export to 3rd party integration when invoicing.","example":"[\"testbcc@mail.com\"]"}},"businessHoursSource":{"type":"string","description":"Where to pick business hours configuration, could be inherited from general configuration or custom.","example":"TICKETING","enum":["CUSTOM","TICKETING"]},"nextBillDate":{"type":"string","description":"When the next invoice will be automatically generated.","format":"date","example":"2026-01-09T00:00:00.000Z"},"nextBillingPeriodStartDate":{"type":"string","description":"When the next billing period will start to count for the next invoice.","format":"date","example":"2026-01-01T00:00:00.000Z"},"displayIncludedTimeOnInvoices":{"type":"boolean","description":"Show time entries that have been billed against an included amount of hours on invoices.","example":true},"dueDaysSource":{"type":"string","description":"Where the agreement will obtain the information about due days.","example":"CUSTOM","enum":["CUSTOM","INHERIT_FROM_CONFIGURATION"]},"dueDays":{"type":"integer","description":"How many days an invoice has to be payed after invoiced.","format":"int32","example":30},"ticketBillingSettings":{"title":"NinjaOneBillingTicketSettingsRequest","required":["billTicketInAnyStatus"],"type":"object","properties":{"billTicketInAnyStatus":{"type":"boolean","description":"Whether a ticket can be billed in any status or under specific conditions.","example":true},"condition":{"title":"NinjaOneBillingTicketSettingsRequest","required":["operator","value"],"type":"object","properties":{"operator":{"type":"string","description":"Operation to evaluate the ticket state.","example":"parent_in","enum":["in","not_in","parent_in","parent_not_in"]},"value":{"type":"string","description":"Allowed ticket states defined.","example":"new"}},"description":"Ticket state conditions under which a ticket will be invoiced."}},"description":"Representation of a ninja billing ticket settings request."},"autoApproveInvoice":{"type":"boolean","description":"Whether invoices generated from the agreement will be automatically approved when generated.","example":true},"autoCompleteInvoice":{"type":"boolean","description":"Whether invoices generated from the agreement will be automatically completed when approved.","example":true},"taxId":{"type":"integer","description":"ID of the tax to be applied to the agreement.","format":"int32","example":1},"quickBooks":{"title":"NinjaOneBillingQuickBooksAgreementIntegrationDataRequest","required":["allowOnlineAchPayments","allowOnlineCreditCardPayments"],"type":"object","properties":{"externalTax":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."},"allowOnlineCreditCardPayments":{"type":"boolean","description":"Specifies if online credit card payments are allowed for this invoice and corresponds to the Credit card check box on the QuickBooks UI.","example":true},"allowOnlineAchPayments":{"type":"boolean","description":"Specifies if this invoice can be paid with online bank transfers and corresponds to the Bank transfer check box on the QuickBooks UI.","example":true},"externalTaxRequest":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."}},"description":"Quickbooks integration agreement specific data.","nullable":true},"xero":{"title":"NinjaOneBillingXeroAgreementIntegrationDataRequest","type":"object","properties":{"externalTax":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."},"taxlessItemsExternalTax":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Not billable products external integration tax rate."},"brandingTheme":{"title":"NinjaOneBillingXeroBrandingThemeRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Xero integration branding theme specific data."},"newInvoiceStatus":{"type":"string","description":"Xero invoice status.","enum":["DRAFT","SUBMITTED","AUTHORISED"]},"externalTaxRequest":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."},"taxlessItemsExternalTaxRequest":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Not billable products external integration tax rate."},"brandingThemeRequest":{"title":"NinjaOneBillingXeroBrandingThemeRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Xero integration branding theme specific data."}},"description":"Xero integration agreement specific data.","nullable":true},"managedDeviceProducts":{"type":"array","description":"List of device count quantity type products.","items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"managedDeviceBackupProducts":{"type":"array","description":"List of backup storage count quantity type products.","items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"laborTicketTimeEntryProducts":{"type":"array","description":"List of time entry quantity type products.","items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"managedEndUserProducts":{"type":"array","description":"List of end user count quantity type products.","items":{"title":"NinjaOneBillingAgreementProductRequest","required":["accountId","description","group","name","quantityType"],"type":"object","properties":{"id":{"minimum":1,"type":"integer","description":"ID of the agreement product.","format":"int32","example":1},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the agreement product.","example":"Agreement product example name"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the agreement product.","example":"Agreement product example description."},"quantityType":{"type":"string","description":"How the product quantity is calculated in billing.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product specific information needed to its calculations, structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","example":116},"order":{"minimum":1,"type":"integer","description":"Order on which the product will be taken in account for invoicing.","format":"int32","example":1},"accountId":{"minimum":1,"type":"integer","description":"Account ID assigned to the product to be mapped to a 3rd party integration product type.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product can be billed as group.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing agreement product request."}},"invoiceNote":{"maxLength":250,"minLength":0,"type":"string","description":"String message added to invoices generated from the agreement.","example":"Invoice note example."},"quickBooksAgreementIntegrationDataRequest":{"title":"NinjaOneBillingQuickBooksAgreementIntegrationDataRequest","required":["allowOnlineAchPayments","allowOnlineCreditCardPayments"],"type":"object","properties":{"externalTax":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."},"allowOnlineCreditCardPayments":{"type":"boolean","description":"Specifies if online credit card payments are allowed for this invoice and corresponds to the Credit card check box on the QuickBooks UI.","example":true},"allowOnlineAchPayments":{"type":"boolean","description":"Specifies if this invoice can be paid with online bank transfers and corresponds to the Bank transfer check box on the QuickBooks UI.","example":true},"externalTaxRequest":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."}},"description":"Quickbooks integration agreement specific data.","nullable":true},"xeroAgreementIntegrationDataRequest":{"title":"NinjaOneBillingXeroAgreementIntegrationDataRequest","type":"object","properties":{"externalTax":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."},"taxlessItemsExternalTax":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Not billable products external integration tax rate."},"brandingTheme":{"title":"NinjaOneBillingXeroBrandingThemeRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Xero integration branding theme specific data."},"newInvoiceStatus":{"type":"string","description":"Xero invoice status.","enum":["DRAFT","SUBMITTED","AUTHORISED"]},"externalTaxRequest":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."},"taxlessItemsExternalTaxRequest":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Not billable products external integration tax rate."},"brandingThemeRequest":{"title":"NinjaOneBillingXeroBrandingThemeRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Xero integration branding theme specific data."}},"description":"Xero integration agreement specific data.","nullable":true},"multiMatchSoftwareLicenses":{"type":"boolean","description":"Match multiple software licenses when counting to generate invoices.","example":true}},"description":"Representation of a ninja billing Agreement creation request."},"NinjaPsaExternalTaxContentPublicApiRequest":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."},"NinjaPsaProductUserRolePublicApiRequest":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"QuickBooksAgreementIntegrationDataPublicApiRequest":{"title":"NinjaOneBillingQuickBooksAgreementIntegrationDataRequest","required":["allowOnlineAchPayments","allowOnlineCreditCardPayments"],"type":"object","properties":{"externalTax":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."},"allowOnlineCreditCardPayments":{"type":"boolean","description":"Specifies if online credit card payments are allowed for this invoice and corresponds to the Credit card check box on the QuickBooks UI.","example":true},"allowOnlineAchPayments":{"type":"boolean","description":"Specifies if this invoice can be paid with online bank transfers and corresponds to the Bank transfer check box on the QuickBooks UI.","example":true},"externalTaxRequest":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."}},"description":"Quickbooks integration agreement specific data.","nullable":true},"TaxlessItemsExternalTaxPublicApiRequest":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Not billable products external integration tax rate."},"TicketBillingSettingsPublicApiRequest":{"title":"NinjaOneBillingTicketSettingsRequest","required":["billTicketInAnyStatus"],"type":"object","properties":{"billTicketInAnyStatus":{"type":"boolean","description":"Whether a ticket can be billed in any status or under specific conditions.","example":true},"condition":{"title":"NinjaOneBillingTicketSettingsRequest","required":["operator","value"],"type":"object","properties":{"operator":{"type":"string","description":"Operation to evaluate the ticket state.","example":"parent_in","enum":["in","not_in","parent_in","parent_not_in"]},"value":{"type":"string","description":"Allowed ticket states defined.","example":"new"}},"description":"Ticket state conditions under which a ticket will be invoiced."}},"description":"Representation of a ninja billing ticket settings request."},"XeroAgreementIntegrationDataPublicApiRequest":{"title":"NinjaOneBillingXeroAgreementIntegrationDataRequest","type":"object","properties":{"externalTax":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."},"taxlessItemsExternalTax":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Not billable products external integration tax rate."},"brandingTheme":{"title":"NinjaOneBillingXeroBrandingThemeRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Xero integration branding theme specific data."},"newInvoiceStatus":{"type":"string","description":"Xero invoice status.","enum":["DRAFT","SUBMITTED","AUTHORISED"]},"externalTaxRequest":{"title":"NinjaOneBillingExternalTaxRateContentRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"ID of the external tax rate assigned by the 3rd party integration.","example":"EX-TAX-01"},"name":{"type":"string","description":"Name of the external tax rate assigned by the 3rd party integration.","example":"External_tax_name"}},"description":"Representation of a ninja billing External tax rate request."},"taxlessItemsExternalTaxRequest":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Not billable products external integration tax rate."},"brandingThemeRequest":{"title":"NinjaOneBillingXeroBrandingThemeRequest","required":["id","name"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"Xero integration branding theme specific data."}},"description":"Xero integration agreement specific data.","nullable":true},"NinjaPsaListedAgreementPublicApiDTO":{"title":"NinjaOneBillingListedAgreementResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"invoiceGenerationType":{"type":"string","enum":["AUTOMATIC","MANUAL","ONE_OFF"]},"lastBillDate":{"type":"number","format":"double","nullable":true},"nextBillDate":{"type":"string","nullable":true},"nextBillingPeriodStartDate":{"type":"string","nullable":true},"lastPeriodStartDate":{"type":"string","nullable":true},"lastPeriodEndDate":{"type":"string","nullable":true},"content":{"type":"object","properties":{"interval":{"type":"string","nullable":true},"billDate":{"type":"string","nullable":true},"startDate":{"type":"string"},"endDate":{"type":"string","nullable":true},"businessHours":{"type":"object","properties":{"twentyFourSeven":{"type":"boolean"},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"]},"startHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"endHour":{"maximum":86399,"minimum":0,"type":"integer","format":"int32"},"allDayClosed":{"type":"boolean"}}}}},"description":"Days and time the work registered in tickets will be registered as off hours."}}},"client":{"required":["deleted"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the client","format":"int32","example":789},"name":{"type":"string","description":"Name of the client","example":"Acme Corporation"},"deleted":{"type":"boolean","description":"Indicates if the client has been deleted","example":false}},"description":"Client information associated with this invoice"},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"},"timeDefault":{"type":"boolean"},"businessHoursSource":{"type":"string","enum":["CUSTOM","TICKETING"]},"taxId":{"type":"integer","format":"int32"},"archived":{"type":"boolean"},"active":{"type":"boolean"}},"description":"Representation of a ninja billing Agreement."},"NinjaPsaInvoiceApprovePublicApiRequest":{"required":["invoiceIds"],"type":"object","properties":{"invoiceIds":{"uniqueItems":true,"type":"array","description":"Set of invoice IDs to approve","example":[123,124,125],"items":{"type":"integer","description":"Set of invoice IDs to approve","format":"int32"}}},"description":"Request to approve one or more invoices"},"NinjaPsaInvoiceArchivePublicApiRequest":{"required":["invoiceIds"],"type":"object","properties":{"invoiceIds":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}},"NinjaPsaAgreementBasicPublicApiDTO":{"title":"AgreementBasicPublicApiDTO","type":"object","properties":{"id":{"type":"integer","description":"Agreement ID.","format":"int32","example":456},"name":{"type":"string","description":"Agreement name.","example":"Annual Support Agreement"}},"description":"Basic agreement information."},"NinjaPsaBillContentPublicApiDTO":{"title":"BillContentPublicApiDTO","type":"object","properties":{"issuerName":{"type":"string","description":"Issuer name.","example":"ACME Corp"},"issuerAddress":{"type":"string","description":"Issuer address.","example":"123 Main St, City, State 12345"},"issuerWebPage":{"type":"string","description":"Issuer webpage.","example":"https://acme.com"},"issuerPhone":{"type":"string","description":"Issuer phone.","example":"+1-555-0123"},"billName":{"type":"string","description":"Bill name.","example":"Client Company"},"billAddress":{"type":"string","description":"Bill address.","example":"456 Oak Ave, City, State 67890"},"billEmail":{"type":"string","description":"Bill email.","example":"billing@client.com"},"billPhone":{"type":"string","description":"Bill phone.","example":"+1-555-9876"}},"description":"Bill content information for invoice."},"NinjaPsaInternalTaxPublicApiDTO":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true},"NinjaPsaInternalTaxRatePublicApiDTO":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."},"NinjaPsaInvoiceProductIntegrationSettingsPublicApiDTO":{"title":"InvoiceProductIntegrationSettingsPublicApiDTO","type":"object","properties":{"inheritTaxRateFromAgreement":{"type":"boolean","description":"Whether to inherit tax rate from agreement.","example":true},"taxRate":{"type":"string","description":"Tax rate id from integration","example":"INPUT"}},"description":"Integration settings for invoice product."},"NinjaPsaInvoiceProductPublicApiDTO":{"title":"NinjaOneBillingInvoiceProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice product.","format":"int32","example":1},"productId":{"type":"integer","description":"Product ID from catalog.","format":"int32","example":10},"name":{"type":"string","description":"Product name.","example":"Managed Services"},"description":{"type":"string","description":"Description.","example":"Monthly managed services for 50 devices"},"price":{"type":"number","description":"Unit price.","example":10},"cost":{"type":"number","description":"Cost.","example":5},"quantity":{"type":"number","description":"Quantity.","example":50},"subTotal":{"type":"number","description":"Subtotal before discount.","example":500},"discount":{"type":"number","description":"Discount amount.","example":25},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":475},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":47.5},"total":{"type":"number","description":"Total amount including tax.","example":522.5},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"accountId":{"type":"integer","description":"Account ID.","format":"int32","example":5},"quantityType":{"type":"string","description":"Quantity type.","example":"DEVICE_COUNTS"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"agreementProductId":{"type":"integer","description":"Agreement product ID.","format":"int32","example":123},"ticketProductId":{"type":"integer","description":"Ticket product ID.","format":"int32","example":456},"integrationSettings":{"title":"InvoiceProductIntegrationSettingsPublicApiDTO","type":"object","properties":{"inheritTaxRateFromAgreement":{"type":"boolean","description":"Whether to inherit tax rate from agreement.","example":true},"taxRate":{"type":"string","description":"Tax rate id from integration","example":"INPUT"}},"description":"Integration settings for invoice product."},"group":{"type":"boolean","description":"Whether this is a product group.","example":false},"productIds":{"type":"array","description":"Product IDs if this is a group.","items":{"type":"integer","description":"Product IDs if this is a group.","format":"int32"}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true}},"description":"Representation of an invoice product/line item."},"NinjaPsaInvoicePublicApiDTO":{"title":"NinjaOneBillingInvoiceResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice.","format":"int32","example":123},"invoiceNumber":{"type":"string","description":"Invoice number.","example":"INV-2024-001"},"client":{"required":["deleted"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the client","format":"int32","example":789},"name":{"type":"string","description":"Name of the client","example":"Acme Corporation"},"deleted":{"type":"boolean","description":"Indicates if the client has been deleted","example":false}},"description":"Client information associated with this invoice"},"status":{"type":"string","description":"Invoice status.","example":"APPROVED","enum":["PENDING","APPROVED","COMPLETE","EXPORTING","FAILED","EXPORTED","ARCHIVED"]},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"invoiceDate":{"type":"string","description":"Invoice date.","example":"2024-02-01T00:00:00.000Z"},"dueDate":{"type":"string","description":"Due date.","example":"2024-02-15T00:00:00.000Z"},"subTotal":{"type":"number","description":"Subtotal amount before discount.","example":1000},"discount":{"type":"number","description":"Discount amount.","example":50},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":950},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":95},"total":{"type":"number","description":"Total amount including tax.","example":1045},"currency":{"type":"string","description":"Currency code.","example":"USD"},"notes":{"type":"array","description":"Invoice notes.","items":{"type":"string","description":"Invoice notes."}},"invoiceNote":{"type":"string","description":"Invoice note field.","example":"Additional invoice information"},"interval":{"type":"string","description":"Billing interval.","example":"MONTHLY"},"errorDescription":{"type":"string","description":"Error description if failed.","nullable":true,"example":"Failed to export to Xero"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"invoiceGenerationType":{"type":"string","description":"Invoice generation type.","example":"MANUAL","enum":["AUTOMATIC","MANUAL","ONE_OFF"]},"billContent":{"title":"BillContentPublicApiDTO","type":"object","properties":{"issuerName":{"type":"string","description":"Issuer name.","example":"ACME Corp"},"issuerAddress":{"type":"string","description":"Issuer address.","example":"123 Main St, City, State 12345"},"issuerWebPage":{"type":"string","description":"Issuer webpage.","example":"https://acme.com"},"issuerPhone":{"type":"string","description":"Issuer phone.","example":"+1-555-0123"},"billName":{"type":"string","description":"Bill name.","example":"Client Company"},"billAddress":{"type":"string","description":"Bill address.","example":"456 Oak Ave, City, State 67890"},"billEmail":{"type":"string","description":"Bill email.","example":"billing@client.com"},"billPhone":{"type":"string","description":"Bill phone.","example":"+1-555-9876"}},"description":"Bill content information for invoice."},"appUserName":{"type":"string","description":"App user name who created/modified the invoice.","example":"john.doe@company.com"},"agreement":{"title":"AgreementBasicPublicApiDTO","type":"object","properties":{"id":{"type":"integer","description":"Agreement ID.","format":"int32","example":456},"name":{"type":"string","description":"Agreement name.","example":"Annual Support Agreement"}},"description":"Basic agreement information."},"externalTax":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"description":"External tax information."},"failureReason":{"type":"string","description":"Failure reason if invoice processing failed.","nullable":true,"example":"Integration sync failed"},"allowOnlineCreditCardPayments":{"type":"boolean","description":"Whether online credit card payments are allowed.","example":true},"allowOnlineAchPayments":{"type":"boolean","description":"Whether online ACH payments are allowed.","example":false},"hasActiveIntegrationData":{"type":"boolean","description":"Whether invoice has active integration data.","example":false},"products":{"type":"array","description":"Invoice products/line items added directly to the invoice.","items":{"title":"NinjaOneBillingInvoiceProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice product.","format":"int32","example":1},"productId":{"type":"integer","description":"Product ID from catalog.","format":"int32","example":10},"name":{"type":"string","description":"Product name.","example":"Managed Services"},"description":{"type":"string","description":"Description.","example":"Monthly managed services for 50 devices"},"price":{"type":"number","description":"Unit price.","example":10},"cost":{"type":"number","description":"Cost.","example":5},"quantity":{"type":"number","description":"Quantity.","example":50},"subTotal":{"type":"number","description":"Subtotal before discount.","example":500},"discount":{"type":"number","description":"Discount amount.","example":25},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":475},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":47.5},"total":{"type":"number","description":"Total amount including tax.","example":522.5},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"accountId":{"type":"integer","description":"Account ID.","format":"int32","example":5},"quantityType":{"type":"string","description":"Quantity type.","example":"DEVICE_COUNTS"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"agreementProductId":{"type":"integer","description":"Agreement product ID.","format":"int32","example":123},"ticketProductId":{"type":"integer","description":"Ticket product ID.","format":"int32","example":456},"integrationSettings":{"title":"InvoiceProductIntegrationSettingsPublicApiDTO","type":"object","properties":{"inheritTaxRateFromAgreement":{"type":"boolean","description":"Whether to inherit tax rate from agreement.","example":true},"taxRate":{"type":"string","description":"Tax rate id from integration","example":"INPUT"}},"description":"Integration settings for invoice product."},"group":{"type":"boolean","description":"Whether this is a product group.","example":false},"productIds":{"type":"array","description":"Product IDs if this is a group.","items":{"type":"integer","description":"Product IDs if this is a group.","format":"int32"}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true}},"description":"Representation of an invoice product/line item."}},"agreementProducts":{"type":"array","description":"Invoice products/line items coming from agreements.","items":{"title":"NinjaOneBillingInvoiceProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice product.","format":"int32","example":1},"productId":{"type":"integer","description":"Product ID from catalog.","format":"int32","example":10},"name":{"type":"string","description":"Product name.","example":"Managed Services"},"description":{"type":"string","description":"Description.","example":"Monthly managed services for 50 devices"},"price":{"type":"number","description":"Unit price.","example":10},"cost":{"type":"number","description":"Cost.","example":5},"quantity":{"type":"number","description":"Quantity.","example":50},"subTotal":{"type":"number","description":"Subtotal before discount.","example":500},"discount":{"type":"number","description":"Discount amount.","example":25},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":475},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":47.5},"total":{"type":"number","description":"Total amount including tax.","example":522.5},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"accountId":{"type":"integer","description":"Account ID.","format":"int32","example":5},"quantityType":{"type":"string","description":"Quantity type.","example":"DEVICE_COUNTS"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"agreementProductId":{"type":"integer","description":"Agreement product ID.","format":"int32","example":123},"ticketProductId":{"type":"integer","description":"Ticket product ID.","format":"int32","example":456},"integrationSettings":{"title":"InvoiceProductIntegrationSettingsPublicApiDTO","type":"object","properties":{"inheritTaxRateFromAgreement":{"type":"boolean","description":"Whether to inherit tax rate from agreement.","example":true},"taxRate":{"type":"string","description":"Tax rate id from integration","example":"INPUT"}},"description":"Integration settings for invoice product."},"group":{"type":"boolean","description":"Whether this is a product group.","example":false},"productIds":{"type":"array","description":"Product IDs if this is a group.","items":{"type":"integer","description":"Product IDs if this is a group.","format":"int32"}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true}},"description":"Representation of an invoice product/line item."}},"ticketProducts":{"type":"array","description":"Invoice products/line items coming from tickets.","items":{"title":"NinjaOneBillingInvoiceProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice product.","format":"int32","example":1},"productId":{"type":"integer","description":"Product ID from catalog.","format":"int32","example":10},"name":{"type":"string","description":"Product name.","example":"Managed Services"},"description":{"type":"string","description":"Description.","example":"Monthly managed services for 50 devices"},"price":{"type":"number","description":"Unit price.","example":10},"cost":{"type":"number","description":"Cost.","example":5},"quantity":{"type":"number","description":"Quantity.","example":50},"subTotal":{"type":"number","description":"Subtotal before discount.","example":500},"discount":{"type":"number","description":"Discount amount.","example":25},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":475},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":47.5},"total":{"type":"number","description":"Total amount including tax.","example":522.5},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"accountId":{"type":"integer","description":"Account ID.","format":"int32","example":5},"quantityType":{"type":"string","description":"Quantity type.","example":"DEVICE_COUNTS"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"agreementProductId":{"type":"integer","description":"Agreement product ID.","format":"int32","example":123},"ticketProductId":{"type":"integer","description":"Ticket product ID.","format":"int32","example":456},"integrationSettings":{"title":"InvoiceProductIntegrationSettingsPublicApiDTO","type":"object","properties":{"inheritTaxRateFromAgreement":{"type":"boolean","description":"Whether to inherit tax rate from agreement.","example":true},"taxRate":{"type":"string","description":"Tax rate id from integration","example":"INPUT"}},"description":"Integration settings for invoice product."},"group":{"type":"boolean","description":"Whether this is a product group.","example":false},"productIds":{"type":"array","description":"Product IDs if this is a group.","items":{"type":"integer","description":"Product IDs if this is a group.","format":"int32"}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true}},"description":"Representation of an invoice product/line item."}},"oneOffProducts":{"type":"array","description":"Invoice products/line items added directly to a one-off invoice (not linked to any catalog product, agreement, or ticket).","items":{"title":"NinjaOneBillingInvoiceProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the invoice product.","format":"int32","example":1},"productId":{"type":"integer","description":"Product ID from catalog.","format":"int32","example":10},"name":{"type":"string","description":"Product name.","example":"Managed Services"},"description":{"type":"string","description":"Description.","example":"Monthly managed services for 50 devices"},"price":{"type":"number","description":"Unit price.","example":10},"cost":{"type":"number","description":"Cost.","example":5},"quantity":{"type":"number","description":"Quantity.","example":50},"subTotal":{"type":"number","description":"Subtotal before discount.","example":500},"discount":{"type":"number","description":"Discount amount.","example":25},"subTotalWithDiscount":{"type":"number","description":"Subtotal after discount.","example":475},"taxRate":{"type":"number","description":"Tax rate applied.","example":0.1},"totalTax":{"type":"number","description":"Total tax amount.","example":47.5},"total":{"type":"number","description":"Total amount including tax.","example":522.5},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"billingPeriodStartDate":{"type":"string","description":"Billing period start date.","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date.","example":"2024-01-31T00:00:00.000Z"},"accountId":{"type":"integer","description":"Account ID.","format":"int32","example":5},"quantityType":{"type":"string","description":"Quantity type.","example":"DEVICE_COUNTS"},"createTime":{"type":"string","description":"Created date.","example":"2024-01-15T10:30:00.000Z"},"updateTime":{"type":"string","description":"Last update date.","example":"2024-01-20T14:45:00.000Z"},"agreementProductId":{"type":"integer","description":"Agreement product ID.","format":"int32","example":123},"ticketProductId":{"type":"integer","description":"Ticket product ID.","format":"int32","example":456},"integrationSettings":{"title":"InvoiceProductIntegrationSettingsPublicApiDTO","type":"object","properties":{"inheritTaxRateFromAgreement":{"type":"boolean","description":"Whether to inherit tax rate from agreement.","example":true},"taxRate":{"type":"string","description":"Tax rate id from integration","example":"INPUT"}},"description":"Integration settings for invoice product."},"group":{"type":"boolean","description":"Whether this is a product group.","example":false},"productIds":{"type":"array","description":"Product IDs if this is a group.","items":{"type":"integer","description":"Product IDs if this is a group.","format":"int32"}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true}},"description":"Representation of an invoice product/line item."}},"tax":{"title":"NinjaOneBillingInternalTaxResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax configuration.","example":"Sales Tax"},"taxRates":{"type":"array","description":"List of tax rates applied.","items":{"title":"NinjaOneBillingInternalTaxRateResponse","type":"object","properties":{"name":{"type":"string","description":"Name of the tax rate.","example":"State Tax"},"rate":{"type":"number","description":"Tax rate value.","example":0.08},"compounded":{"type":"boolean","description":"Whether this rate is compounded on top of previous rates.","example":false}},"description":"Individual tax rate within a tax snapshot."}}},"description":"Snapshot of the tax configuration at the time it was applied to this invoice product.","nullable":true},"paymentStatus":{"type":"string","description":"Payment status of the invoice.","example":"UNPAID","enum":["UNPAID","PARTIALLY","FULL","OVER"]},"outstandingBalance":{"type":"number","description":"Outstanding balance remaining on the invoice.","example":500},"lastPaymentDate":{"type":"string","description":"Date of the last payment received, in YYYY-MM-DD format.","nullable":true,"example":"2024-02-10T00:00:00.000Z"},"deleted":{"type":"boolean","description":"Whether the invoice is deleted.","example":false}},"description":"Representation of a ninja billing invoice."},"NinjaPsaInvoiceCreatePublicApiRequest":{"title":"NinjaOneBillingInvoiceCreateRequest","required":["agreementId"],"type":"object","properties":{"agreementId":{"type":"integer","description":"The ID of the agreement for which to generate the invoice.","format":"int32","example":123}},"description":"Representation of a ninja billing Invoice creation request."},"NinjaPsaInvoiceExportPublicApiRequest":{"required":["invoiceIds"],"type":"object","properties":{"invoiceIds":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}},"NinjaPsaInvoiceListItemPublicApiDTO":{"required":["createTime","currency","hasActiveIntegrationData","invoiceGenerationType","status","subTotal","total","totalTax","updateTime"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the invoice","format":"int32","example":123},"invoiceNumber":{"type":"string","description":"Invoice number","example":"INV-2024-001"},"agreementName":{"type":"string","description":"Name of the agreement associated with this invoice","example":"Monthly Service Agreement"},"agreementId":{"type":"integer","description":"Unique identifier for the agreement","format":"int32","example":456},"subTotal":{"type":"number","description":"Subtotal amount before taxes and discounts","example":1000},"totalTax":{"type":"number","description":"Total tax amount","example":80},"total":{"type":"number","description":"Total amount including taxes and discounts","example":1080},"createTime":{"type":"number","description":"Timestamp when the invoice was created","format":"double"},"updateTime":{"type":"number","description":"Timestamp when the invoice was last updated","format":"double"},"invoiceGenerationType":{"type":"string","description":"Type of invoice generation (MANUAL or AUTOMATIC)","example":"AUTOMATIC","enum":["AUTOMATIC","MANUAL","ONE_OFF"]},"status":{"type":"string","description":"Current status of the invoice","example":"PENDING","enum":["PENDING","APPROVED","COMPLETE","EXPORTING","FAILED","EXPORTED","ARCHIVED"]},"client":{"required":["deleted"],"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the client","format":"int32","example":789},"name":{"type":"string","description":"Name of the client","example":"Acme Corporation"},"deleted":{"type":"boolean","description":"Indicates if the client has been deleted","example":false}},"description":"Client information associated with this invoice"},"failureReason":{"type":"string","description":"Reason for failure if the invoice export failed","nullable":true,"example":"Connection timeout to external system"},"currency":{"type":"string","description":"Currency used for this invoice","example":"USD","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]},"billingPeriodStartDate":{"type":"string","description":"Start date of the billing period in YYYY-MM-DD format","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"End date of the billing period in YYYY-MM-DD format","example":"2024-01-31T00:00:00.000Z"},"dueDate":{"type":"string","description":"Due date for payment in YYYY-MM-DD format","example":"2024-02-15T00:00:00.000Z"},"hasActiveIntegrationData":{"type":"boolean","description":"Indicates if the invoice has active integration data configured","example":true},"paymentStatus":{"type":"string","description":"Payment status of the invoice.","example":"UNPAID","enum":["UNPAID","PARTIALLY","FULL","OVER"]},"outstandingBalance":{"type":"number","description":"Outstanding balance remaining on the invoice.","example":500},"lastPaymentDate":{"type":"string","description":"Date of the last payment received, in YYYY-MM-DD format.","nullable":true,"example":"2024-02-10T00:00:00.000Z"}}},"NinjaPsaInvoiceUnarchivePublicApiRequest":{"required":["invoiceIds"],"type":"object","properties":{"invoiceIds":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}}}},"NinjaPsaInvoiceProductPublicApiRequest":{"title":"NinjaOneBillingInvoiceProductRequest","required":["cost","description","name","price","quantity","taxable"],"type":"object","properties":{"id":{"type":"integer","description":"ID of the invoice product (required for updates, null for new products).","format":"int32","example":123},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the product.","example":"Hardware Support"},"productId":{"type":"integer","description":"ID of the product from the catalog.","format":"int32","example":456},"ticketProductId":{"type":"integer","description":"ID of the ticket product.","format":"int32","example":789},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"price":{"type":"number","description":"Price per unit of the product.","format":"double","example":500},"cost":{"type":"number","description":"Cost per unit of the product.","format":"double","example":250},"quantity":{"type":"number","description":"Quantity of the product.","example":2},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the product.","example":"Monthly hardware support service"}},"description":"Representation of a product within an invoice."},"NinjaPsaInvoicePublicApiRequest":{"title":"NinjaOneBillingInvoiceRequest","type":"object","properties":{"invoiceDate":{"type":"string","description":"Invoice date in ISO format (YYYY-MM-DD).","example":"2024-01-15T00:00:00.000Z"},"products":{"type":"array","description":"List of catalog products to include in the invoice.","items":{"title":"NinjaOneBillingInvoiceProductRequest","required":["cost","description","name","price","quantity","taxable"],"type":"object","properties":{"id":{"type":"integer","description":"ID of the invoice product (required for updates, null for new products).","format":"int32","example":123},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the product.","example":"Hardware Support"},"productId":{"type":"integer","description":"ID of the product from the catalog.","format":"int32","example":456},"ticketProductId":{"type":"integer","description":"ID of the ticket product.","format":"int32","example":789},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"price":{"type":"number","description":"Price per unit of the product.","format":"double","example":500},"cost":{"type":"number","description":"Cost per unit of the product.","format":"double","example":250},"quantity":{"type":"number","description":"Quantity of the product.","example":2},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the product.","example":"Monthly hardware support service"}},"description":"Representation of a product within an invoice."}},"agreementProducts":{"type":"array","description":"List of agreement products to include in the invoice.","items":{"title":"NinjaOneBillingInvoiceProductRequest","required":["cost","description","name","price","quantity","taxable"],"type":"object","properties":{"id":{"type":"integer","description":"ID of the invoice product (required for updates, null for new products).","format":"int32","example":123},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the product.","example":"Hardware Support"},"productId":{"type":"integer","description":"ID of the product from the catalog.","format":"int32","example":456},"ticketProductId":{"type":"integer","description":"ID of the ticket product.","format":"int32","example":789},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"price":{"type":"number","description":"Price per unit of the product.","format":"double","example":500},"cost":{"type":"number","description":"Cost per unit of the product.","format":"double","example":250},"quantity":{"type":"number","description":"Quantity of the product.","example":2},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the product.","example":"Monthly hardware support service"}},"description":"Representation of a product within an invoice."}},"ticketProducts":{"type":"array","description":"List of ticket products to include in the invoice.","items":{"title":"NinjaOneBillingInvoiceProductRequest","required":["cost","description","name","price","quantity","taxable"],"type":"object","properties":{"id":{"type":"integer","description":"ID of the invoice product (required for updates, null for new products).","format":"int32","example":123},"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the product.","example":"Hardware Support"},"productId":{"type":"integer","description":"ID of the product from the catalog.","format":"int32","example":456},"ticketProductId":{"type":"integer","description":"ID of the ticket product.","format":"int32","example":789},"taxable":{"type":"boolean","description":"Whether the product is taxable.","example":true},"price":{"type":"number","description":"Price per unit of the product.","format":"double","example":500},"cost":{"type":"number","description":"Cost per unit of the product.","format":"double","example":250},"quantity":{"type":"number","description":"Quantity of the product.","example":2},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the product.","example":"Monthly hardware support service"}},"description":"Representation of a product within an invoice."}},"billingPeriodStartDate":{"type":"string","description":"Billing period start date in ISO format (YYYY-MM-DD).","example":"2024-01-01T00:00:00.000Z"},"billingPeriodEndDate":{"type":"string","description":"Billing period end date in ISO format (YYYY-MM-DD).","example":"2024-01-31T00:00:00.000Z"},"invoiceNote":{"maxLength":250,"minLength":0,"type":"string","description":"Note to include in the invoice.","example":"Monthly service invoice"},"dueDate":{"type":"string","description":"Due date for the invoice in ISO format (YYYY-MM-DD).","example":"2024-02-15T00:00:00.000Z"},"invoiceNumber":{"maxLength":21,"minLength":0,"type":"string","description":"Invoice number.","example":"INV-2024-001"}},"description":"Representation of a ninja billing Invoice update request."},"NinjaPsaInvoiceNoteRequest":{"title":"NinjaOneBillingInvoiceNoteRequest","type":"object","properties":{"invoiceNote":{"maxLength":250,"minLength":0,"type":"string","description":"The note to be associated with the invoice. Can be null to clear the note.","nullable":true,"example":"Payment received via wire transfer on January 15, 2026"}},"description":"Request to update the note field of an invoice. This operation is allowed even for COMPLETE invoices."},"NinjaPsaProductDetailPublicApiDTO":{"title":"NinjaOneBillingProductDetailResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the product.","format":"int32","example":1},"name":{"type":"string","description":"Name of the product.","example":"Hardware Support"},"description":{"type":"string","description":"Description of the product.","example":"Monthly hardware support service"},"quantityType":{"type":"string","description":"Quantity type of the product.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","description":"Additional content/configuration for the product. Structure varies by quantity type."},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings for exporting invoices with this product."},"createTime":{"type":"number","description":"Timestamp when the product was created.","format":"double"},"updateTime":{"type":"number","description":"Timestamp when the product was last updated.","format":"double"},"productUserRole":{"title":"NinjaOneBillingProductUserRoleResponse","type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user roles that can access this product. Empty when allowAllTechnicians is true.","items":{"title":"NinjaOneBillingUserRoleResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the user role.","format":"int32","example":1},"name":{"type":"string","description":"Name of the user role.","example":"Admin"}},"description":"Representation of a user role."}}},"description":"Representation of a ninja billing product user role response."},"accountId":{"type":"integer","description":"Account ID associated with the product.","format":"int32","example":8},"group":{"type":"boolean","description":"Whether the product is a group product.","example":false},"taxId":{"type":"integer","description":"Tax ID associated with the product. Null if no specific tax is set.","format":"int32","nullable":true,"example":1},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether the product inherits tax from the agreement.","example":true},"active":{"type":"boolean","description":"Indicates if the product is active.","example":true}},"description":"Detailed representation of a ninja billing Product response."},"NinjaPsaProductPublicApiRequest":{"title":"NinjaOneBillingProductRequest","required":["accountId","content","description","group","name","productUserRole","quantityType"],"type":"object","properties":{"name":{"maxLength":50,"minLength":0,"type":"string","description":"Name of the product.","example":"Hardware Support"},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Description of the product.","example":"Monthly hardware support service"},"quantityType":{"type":"string","description":"Quantity type of the product.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"accountId":{"type":"integer","description":"Account ID associated with the product.","format":"int32","example":1},"group":{"type":"boolean","description":"Whether the product should be grouped.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"content":{"type":"object","additionalProperties":true,"description":"Additional content/configuration for the product. Structure varies by quantity type."},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true}},"description":"Representation of a ninja billing Product request."},"NinjaPsaProductPublicApiDTO":{"title":"NinjaOneBillingProductResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the product.","format":"int32","example":1},"name":{"type":"string","description":"Name of the product.","example":"Hardware Support"},"description":{"type":"string","description":"Description of the product.","example":"Monthly hardware support service"},"quantityType":{"type":"string","description":"Quantity type of the product.","example":"DEVICE_COUNTS","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","description":"Additional content/configuration for the product. Structure varies by quantity type. Includes price, cost, taxable, and other type-specific fields."},"createTime":{"type":"number","description":"Timestamp when the product was created.","format":"double"},"updateTime":{"type":"number","description":"Timestamp when the product was last updated.","format":"double"},"accountId":{"type":"integer","description":"Account ID associated with the product.","format":"int32","example":8},"group":{"type":"boolean","description":"Whether the product is a group product.","example":false},"taxId":{"type":"integer","description":"Tax ID associated with the product. Null if no specific tax is set.","format":"int32","nullable":true,"example":1},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether the product inherits tax from the agreement.","example":true},"active":{"type":"boolean","description":"Indicates if the product is active.","example":true}},"description":"Representation of a ninja billing Product response."},"NinjaPsaTicketProductPublicApiDTO":{"title":"NinjaOneBillingTicketProductResponse","type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"billingStatus":{"type":"string","enum":["BILLED","PENDING","NOT_BILLABLE","UNASSIGNED"]},"quantityType":{"type":"string","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true},"technician":{"title":"NinjaOneBillingTicketTechnician","type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"id":{"type":"integer","format":"int32"},"email":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Representation of a ninja billing Technician."},"productId":{"type":"integer","format":"int32"},"integrationSettings":{"type":"object","additionalProperties":true},"taxId":{"type":"integer","format":"int32"},"inheritTaxFromAgreement":{"type":"boolean"}},"description":"Representation of a ninja billing Ticket Product."},"NinjaPsaTicketProductTechnicianPublicApiDTO":{"title":"NinjaOneBillingTicketTechnician","type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"id":{"type":"integer","format":"int32"},"email":{"type":"string"},"deleted":{"type":"boolean"}},"description":"Representation of a ninja billing Technician."},"NinjaPsaTicketProductPublicApiRequest":{"title":"NinjaOneBillingTicketProductRequest","required":["accountId","content","description","group","name","productId","quantityType","ticketId"],"type":"object","properties":{"name":{"maxLength":50,"minLength":0,"type":"string","description":"Ticket product name.","example":"Billable Ticket Product Name."},"description":{"maxLength":10000,"minLength":0,"type":"string","description":"Ticket product description.","example":"This is a billable ticket product description."},"quantityType":{"type":"string","description":"How the product quantity is calculated. in billing.","example":"MANUAL","enum":["MANUAL","DEVICE_COUNTS","TIME_ENTRIES","END_USER_COUNTS","BACKUP_STORAGE_COUNTS","SOFTWARE_LICENSE"]},"content":{"type":"object","additionalProperties":true,"description":"Product basic information needed to its calculations."},"ticketId":{"minimum":1,"type":"integer","description":"Ticket ID where the product is assigned.","format":"int32","example":12},"productId":{"minimum":1,"type":"integer","description":"Product ID of the catalog product, if assigned.","format":"int32","nullable":true,"example":19},"accountId":{"type":"integer","description":"Account ID assigned to the product.","format":"int32","example":1},"taxId":{"type":"integer","description":"Tax ID assigned to the product. If null, the product will use the agreement's tax.","format":"int32","example":5},"inheritTaxFromAgreement":{"type":"boolean","description":"Whether this product inherits its tax configuration from the agreement.","example":true},"productUserRole":{"title":"NinjaOneBillingProductUserRoleRequest","required":["allowAllTechnicians","userRoles"],"type":"object","properties":{"allowAllTechnicians":{"type":"boolean","description":"Whether all technicians are allowed to access this product or specific roles will be specified.","example":true},"userRoles":{"uniqueItems":true,"type":"array","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","example":[1,2],"items":{"type":"integer","description":"Set of user role IDs that can access this product. Only used when allowAllTechnicians is false.","format":"int32"}}},"description":"Representation of a ninja billing product user role request.","nullable":true},"integrationSettings":{"type":"object","additionalProperties":true,"description":"If 3rd party integration is enabled, the settings needed to export invoices with this product."},"group":{"type":"boolean","description":"Whether the product can be built as group.","example":true}},"description":"Representation of a ninja billing ticket product request."},"NinjaPsaRemoveTicketProductPublicApiRequest":{"title":"NinjaOneBillingTicketProductRemovalRequest","required":["ticketId","ticketProductIds"],"type":"object","properties":{"ticketId":{"minimum":1,"type":"integer","description":"Ticket ID from which products will be removed.","format":"int32","example":19},"ticketProductIds":{"uniqueItems":true,"type":"array","description":"List of Ticket Product IDs to be removed","items":{"type":"integer","description":"Ticket Product ID to be removed.","format":"int32","example":19}}},"description":"Needed data to remove a list of ticket products from an existing ticket."},"NinjaPsaTicketTimeEntryPublicApiDTO":{"title":"NinjaOneBillingTicketTimeEntryResponse","type":"object","properties":{"id":{"type":"integer","description":"Unique identifier of the time entry (same as ticket log entry ID).","format":"int64","example":12345},"ticketId":{"type":"integer","description":"ID of the ticket this time entry belongs to.","format":"int32","example":1001},"timeTracked":{"type":"integer","description":"Time tracked in seconds.","format":"int32","example":3600},"startDate":{"type":"number","description":"Start date of the time entry.","format":"double"},"remote":{"type":"boolean","description":"Whether the time entry was performed remotely.","example":false},"createTime":{"type":"number","description":"Creation timestamp of the time entry.","format":"double"},"updateTime":{"type":"number","description":"Last update timestamp of the time entry.","format":"double"},"billingNote":{"type":"string","description":"Note added to give context on the comment|work being billed.","example":"should be charged weekly"}},"description":"Representation of a ninja billing Ticket Time Entry."},"TicketTimeEntryBillingDataRequest":{"type":"object","properties":{"agreementId":{"type":"integer","format":"int32"},"agreementProductId":{"type":"integer","format":"int32"},"billingType":{"type":"string","enum":["BILLABLE","NOT_BILLABLE","NO_CHARGE"]},"timeTracked":{"type":"integer","format":"int32"},"agreementOriginType":{"type":"string","enum":["NONE","SELF","TICKET"]}}},"TicketTimeEntryUpdateRequest":{"type":"object","properties":{"startDate":{"type":"string"},"remote":{"type":"boolean"},"inHours":{"type":"object","properties":{"agreementId":{"type":"integer","format":"int32"},"agreementProductId":{"type":"integer","format":"int32"},"billingType":{"type":"string","enum":["BILLABLE","NOT_BILLABLE","NO_CHARGE"]},"timeTracked":{"type":"integer","format":"int32"},"agreementOriginType":{"type":"string","enum":["NONE","SELF","TICKET"]}}},"offHours":{"type":"object","properties":{"agreementId":{"type":"integer","format":"int32"},"agreementProductId":{"type":"integer","format":"int32"},"billingType":{"type":"string","enum":["BILLABLE","NOT_BILLABLE","NO_CHARGE"]},"timeTracked":{"type":"integer","format":"int32"},"agreementOriginType":{"type":"string","enum":["NONE","SELF","TICKET"]}}},"billingNote":{"maxLength":2000,"minLength":0,"type":"string"}}},"CreateStagedDevicePublicApiResponse":{"type":"object","properties":{"nodeId":{"type":"integer","format":"int32"}}},"CreateStagedDevicePublicApiRequest":{"required":["locationId","name","orgId","roleId"],"type":"object","properties":{"name":{"maxLength":200,"minLength":0,"type":"string","description":"The display name of the device to be created"},"orgId":{"type":"integer","description":"The id of the organization the device belongs to","format":"int32"},"locationId":{"type":"integer","description":"The id of the location the device belongs to","format":"int32"},"roleId":{"type":"integer","description":"The id of the role to use for this device","format":"int32"},"assignedUserUid":{"type":"string","description":"The UUID of the user this device is assigned to","format":"uuid"},"warrantyStartDate":{"type":"number","description":"The warranty start date for the device, in unix epoch seconds","format":"double"},"warrantyEndDate":{"type":"number","description":"The warranty end date for the device, in unix epoch seconds","format":"double"},"itamAssetId":{"type":"string","description":"The asset id to use for the new device"},"itamAssetStatus":{"type":"string","description":"The asset status to use for the new device"},"itamAssetPurchaseDate":{"type":"number","description":"The purchase date of the new device","format":"double"},"itamAssetPurchaseAmount":{"type":"number","description":"The purchase amount of the new device","format":"float"},"itamAssetExpectedLifetime":{"type":"string","description":"The expected lifetime of the new device"},"itamAssetEndOfLifeDate":{"type":"number","description":"The end of life date for the new device","format":"double"},"itamAssetSerialNumber":{"type":"string"}}},"AttributeContentPublicApiDTO":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean","description":"Whether the attribute should be customized for end users"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","description":"For multi-select attributes, this is the list of values available","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean","description":"Boolean representing whether the attribute is required or not"},"footerText":{"type":"string","description":"Text to include after rendering the attribute"},"tooltipText":{"type":"string","description":"Text to use as a tooltip for the attribute"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"For multi-select attributes, these are the available content options"},"AttributeFormContentCommonItemPublicApiDTO":{"type":"object","properties":{"id":{"type":"integer","description":"ID of an attribute","format":"int32"},"name":{"type":"string","description":"Name of the content item"},"fieldName":{"type":"string","description":"Field name of the attribute"},"description":{"type":"string","description":"Description of the content item"},"entityType":{"type":"string","description":"Entity type that this custom field or operation applies to","enum":["USER","NODE","TICKET","DOCUMENT","INPUT_FIELD_FORM"]},"attributeType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"attributeScope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition scopes of the attribute","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"defaultValue":{"type":"string","description":"For multi-select attributes, this is the id of the default value"},"content":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean","description":"Whether the attribute should be customized for end users"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","description":"For multi-select attributes, this is the list of values available","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean","description":"Boolean representing whether the attribute is required or not"},"footerText":{"type":"string","description":"Text to include after rendering the attribute"},"tooltipText":{"type":"string","description":"Text to use as a tooltip for the attribute"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"For multi-select attributes, these are the available content options"},"active":{"type":"boolean","description":"Whether the attribute is active or not"},"createTime":{"type":"number","description":"The time that the attribute was created (unix epoch)","format":"double"},"updateTime":{"type":"number","description":"The time that the attribute was last updated (unix epoch)","format":"double"},"uiElementUid":{"type":"string","description":"For UI elements, the uuid of the element","format":"uuid"},"uiElementType":{"type":"string","description":"For UI elements, type of the element","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"For UI elements, value of the element"},"uiElementCreateTime":{"type":"number","description":"For UI elements, timestamp of when the element was created (unix epoch)","format":"double"},"uiElementUpdateTime":{"type":"number","description":"For UI elements, timestamp of when the element was last updated (unix epoch)","format":"double"}},"description":"This object represents either an attribute, or a UI Element. The available attributes will depend on which type it is"},"CustomTabPublicApiDTO":{"type":"object","properties":{"default":{"type":"boolean"},"id":{"type":"integer","description":"Tab ID","format":"int32"},"name":{"type":"string","description":"Display name of tab"},"description":{"type":"string","description":"The description to use for the custom tab"},"entityType":{"type":"string","description":"The type of object the tab is for (ie, NODE_ROLE, ORGANIZATION, END_USER, etc)","enum":["NODE_ROLE","ORGANIZATION","END_USER","SYSTEM","GLOBAL"]},"entityId":{"type":"integer","description":"For entity types that are bound to an ID, this will be the id of the object. Otherwise, omitted","format":"int32"},"parentTabId":{"type":"integer","description":"For tab extensions, this will be the id of the tab that was extended (ie, the 'root tab')","format":"int32"},"items":{"type":"array","description":"The content of the tab","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID of an attribute","format":"int32"},"name":{"type":"string","description":"Name of the content item"},"fieldName":{"type":"string","description":"Field name of the attribute"},"description":{"type":"string","description":"Description of the content item"},"entityType":{"type":"string","description":"Entity type that this custom field or operation applies to","enum":["USER","NODE","TICKET","DOCUMENT","INPUT_FIELD_FORM"]},"attributeType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"attributeScope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition scopes of the attribute","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"defaultValue":{"type":"string","description":"For multi-select attributes, this is the id of the default value"},"content":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean","description":"Whether the attribute should be customized for end users"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","description":"For multi-select attributes, this is the list of values available","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean","description":"Boolean representing whether the attribute is required or not"},"footerText":{"type":"string","description":"Text to include after rendering the attribute"},"tooltipText":{"type":"string","description":"Text to use as a tooltip for the attribute"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"For multi-select attributes, these are the available content options"},"active":{"type":"boolean","description":"Whether the attribute is active or not"},"createTime":{"type":"number","description":"The time that the attribute was created (unix epoch)","format":"double"},"updateTime":{"type":"number","description":"The time that the attribute was last updated (unix epoch)","format":"double"},"uiElementUid":{"type":"string","description":"For UI elements, the uuid of the element","format":"uuid"},"uiElementType":{"type":"string","description":"For UI elements, type of the element","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"For UI elements, value of the element"},"uiElementCreateTime":{"type":"number","description":"For UI elements, timestamp of when the element was created (unix epoch)","format":"double"},"uiElementUpdateTime":{"type":"number","description":"For UI elements, timestamp of when the element was last updated (unix epoch)","format":"double"}},"description":"This object represents either an attribute, or a UI Element. The available attributes will depend on which type it is"}},"position":{"type":"integer","description":"Integer representing the position of the tab. Used when ordering multiple tabs","format":"int32"},"isDefault":{"type":"boolean","description":"True if this is a default tab, false otherwise"}}},"AttributeFormContentItemPublicApiDTO":{"type":"object","properties":{"itemType":{"type":"string","description":"Specifies whether this item is an ATTRIBUTE or a UI_ELEMENT","enum":["ATTRIBUTE","UI_ELEMENT"]},"id":{"type":"integer","description":"If the content item is an attribute, then this will be the id of that attribute otherwise this should be omitted","format":"int32"},"name":{"type":"string"},"uiElementUid":{"type":"string","format":"uuid"},"uiElementType":{"type":"string","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string"},"uiElementCreateTime":{"type":"number","format":"double"},"uiElementUpdateTime":{"type":"number","format":"double"}}},"NewCustomTabPublicApiRequest":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The display name to use for the custom tab"},"description":{"maxLength":250,"minLength":0,"type":"string","description":"The description to use for the custom tab"},"entityType":{"type":"string","description":"The type to use for the custom tab. Organizations and Locations share the same type of tab","enum":["NODE_ROLE","ORGANIZATION","END_USER","SYSTEM","GLOBAL"]},"entityId":{"minimum":1,"type":"integer","description":"For tab types that require an id to create (currently, only NODE_ROLE types), this field is the ID of the entity","format":"int32"},"items":{"type":"array","description":"The initial list of content items to include in the tab","items":{"type":"object","properties":{"itemType":{"type":"string","description":"Specifies whether this item is an ATTRIBUTE or a UI_ELEMENT","enum":["ATTRIBUTE","UI_ELEMENT"]},"id":{"type":"integer","description":"If the content item is an attribute, then this will be the id of that attribute otherwise this should be omitted","format":"int32"},"name":{"type":"string"},"uiElementUid":{"type":"string","format":"uuid"},"uiElementType":{"type":"string","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string"},"uiElementCreateTime":{"type":"number","format":"double"},"uiElementUpdateTime":{"type":"number","format":"double"}}}},"position":{"type":"integer","format":"int32"}}},"CustomTabHierarchyPublicApiDTO":{"type":"object","properties":{"tabs":{"type":"array","description":"list of objects representing the root tab and any tab extensions added from the role hierarchy","items":{"type":"object","properties":{"default":{"type":"boolean"},"id":{"type":"integer","description":"Tab ID","format":"int32"},"name":{"type":"string","description":"Display name of tab"},"description":{"type":"string","description":"The description to use for the custom tab"},"entityType":{"type":"string","description":"The type of object the tab is for (ie, NODE_ROLE, ORGANIZATION, END_USER, etc)","enum":["NODE_ROLE","ORGANIZATION","END_USER","SYSTEM","GLOBAL"]},"entityId":{"type":"integer","description":"For entity types that are bound to an ID, this will be the id of the object. Otherwise, omitted","format":"int32"},"parentTabId":{"type":"integer","description":"For tab extensions, this will be the id of the tab that was extended (ie, the 'root tab')","format":"int32"},"items":{"type":"array","description":"The content of the tab","items":{"type":"object","properties":{"id":{"type":"integer","description":"ID of an attribute","format":"int32"},"name":{"type":"string","description":"Name of the content item"},"fieldName":{"type":"string","description":"Field name of the attribute"},"description":{"type":"string","description":"Description of the content item"},"entityType":{"type":"string","description":"Entity type that this custom field or operation applies to","enum":["USER","NODE","TICKET","DOCUMENT","INPUT_FIELD_FORM"]},"attributeType":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]},"attributeScope":{"type":"string","description":"Scope that determines where the custom field applies (NOTE: This is depricated and will be removed in a future release. The use of DefinitionScope is strongly preferred)","enum":["NODE_GLOBAL","NODE_ROLE","NODE_CLASS"]},"definitionScope":{"uniqueItems":true,"type":"array","description":"Definition scopes of the attribute","items":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]}},"technicianPermission":{"type":"string","description":"Technician access level for custom fields","enum":["NONE","EDITABLE","READ_ONLY","ROLE_BASED"]},"scriptPermission":{"type":"string","description":"Script access level for custom fields via automation","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"apiPermission":{"type":"string","description":"Public API access level for custom fields (NOTE: This permission affects attribute VALUES, not attributes themselves)","enum":["NONE","READ_ONLY","WRITE_ONLY","READ_WRITE"]},"defaultValue":{"type":"string","description":"For multi-select attributes, this is the id of the default value"},"content":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean","description":"Whether the attribute should be customized for end users"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","description":"For multi-select attributes, this is the list of values available","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean","description":"Boolean representing whether the attribute is required or not"},"footerText":{"type":"string","description":"Text to include after rendering the attribute"},"tooltipText":{"type":"string","description":"Text to use as a tooltip for the attribute"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}},"description":"For multi-select attributes, these are the available content options"},"active":{"type":"boolean","description":"Whether the attribute is active or not"},"createTime":{"type":"number","description":"The time that the attribute was created (unix epoch)","format":"double"},"updateTime":{"type":"number","description":"The time that the attribute was last updated (unix epoch)","format":"double"},"uiElementUid":{"type":"string","description":"For UI elements, the uuid of the element","format":"uuid"},"uiElementType":{"type":"string","description":"For UI elements, type of the element","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string","description":"For UI elements, value of the element"},"uiElementCreateTime":{"type":"number","description":"For UI elements, timestamp of when the element was created (unix epoch)","format":"double"},"uiElementUpdateTime":{"type":"number","description":"For UI elements, timestamp of when the element was last updated (unix epoch)","format":"double"}},"description":"This object represents either an attribute, or a UI Element. The available attributes will depend on which type it is"}},"position":{"type":"integer","description":"Integer representing the position of the tab. Used when ordering multiple tabs","format":"int32"},"isDefault":{"type":"boolean","description":"True if this is a default tab, false otherwise"}}}}},"description":"When rendering custom tabs with extensions, multiple tab objects will be returned. The first will be the root, and the rest will be 'extensions'"},"CustomTabLabelPublicApiDTO":{"type":"object","properties":{"promoted":{"type":"boolean"},"id":{"type":"integer","description":"Tab ID","format":"int32"},"name":{"type":"string","description":"Display name of tab"},"description":{"type":"string","description":"The description to use for the custom tab"},"nodeRoleId":{"type":"integer","description":"For tabs associated with a role, this will be the roleId the tab is associated with","format":"int32"},"position":{"type":"integer","description":"When tabs are ordered, such as when retrieving a tab summary, this is the position that the tab should be rendered in","format":"int32"},"hiddenForRoles":{"type":"array","description":"Array of roleIds that should not display this custom tab","items":{"type":"integer","description":"Array of roleIds that should not display this custom tab","format":"int32"}},"default":{"type":"boolean","description":"True if this tab is a 'default tab'"},"contentType":{"type":"string","description":"Type of content this tab references. Determines the structure of contentConfig.","example":"KNOWLEDGE_BASE_ARTICLE","enum":["KNOWLEDGE_BASE_ARTICLE"]},"contentConfig":{"type":"string","description":"Type-specific configuration for the tab content. Structure determined by contentType.","example":"{\"type\":\"KNOWLEDGE_BASE_ARTICLE\",\"articleId\":123,\"global\":true}"},"isPromoted":{"type":"boolean","description":"True if this tab is promoted/featured"}},"description":"Simplified view of a tab that omits the content of the tab. Used when retrieving tab summaries/lists"},"CustomTabSummaryPublicApiDTO":{"type":"object","properties":{"labels":{"type":"array","description":"Each tab will be returned as a CustomTabLabelPublicApiDTO object. These will not be sorted. It is the callers responsibility to sort the tabs if that is desired","items":{"type":"object","properties":{"promoted":{"type":"boolean"},"id":{"type":"integer","description":"Tab ID","format":"int32"},"name":{"type":"string","description":"Display name of tab"},"description":{"type":"string","description":"The description to use for the custom tab"},"nodeRoleId":{"type":"integer","description":"For tabs associated with a role, this will be the roleId the tab is associated with","format":"int32"},"position":{"type":"integer","description":"When tabs are ordered, such as when retrieving a tab summary, this is the position that the tab should be rendered in","format":"int32"},"hiddenForRoles":{"type":"array","description":"Array of roleIds that should not display this custom tab","items":{"type":"integer","description":"Array of roleIds that should not display this custom tab","format":"int32"}},"default":{"type":"boolean","description":"True if this tab is a 'default tab'"},"contentType":{"type":"string","description":"Type of content this tab references. Determines the structure of contentConfig.","example":"KNOWLEDGE_BASE_ARTICLE","enum":["KNOWLEDGE_BASE_ARTICLE"]},"contentConfig":{"type":"string","description":"Type-specific configuration for the tab content. Structure determined by contentType.","example":"{\"type\":\"KNOWLEDGE_BASE_ARTICLE\",\"articleId\":123,\"global\":true}"},"isPromoted":{"type":"boolean","description":"True if this tab is promoted/featured"}},"description":"Simplified view of a tab that omits the content of the tab. Used when retrieving tab summaries/lists"}},"roleHierarchy":{"type":"array","description":"When retrieving tab summaries for roles, we will return the role hierarchy as a list of roleIds in order from the root node to the requested roleId. This is useful for sorting tabs, since that is done on a per-role basis","items":{"type":"integer","description":"When retrieving tab summaries for roles, we will return the role hierarchy as a list of roleIds in order from the root node to the requested roleId. This is useful for sorting tabs, since that is done on a per-role basis","format":"int32"}}}},"UpdateTabDetailPublicApiRequest":{"required":["name"],"type":"object","properties":{"tabId":{"minimum":1,"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"maxLength":250,"minLength":0,"type":"string"}}},"UpdateCustomTabPublicApiRequest":{"type":"object","properties":{"roleId":{"minimum":1,"type":"integer","format":"int32"},"items":{"type":"array","items":{"type":"object","properties":{"itemType":{"type":"string","description":"Specifies whether this item is an ATTRIBUTE or a UI_ELEMENT","enum":["ATTRIBUTE","UI_ELEMENT"]},"id":{"type":"integer","description":"If the content item is an attribute, then this will be the id of that attribute otherwise this should be omitted","format":"int32"},"name":{"type":"string"},"uiElementUid":{"type":"string","format":"uuid"},"uiElementType":{"type":"string","enum":["TITLE","DESCRIPTION","SEPARATOR"]},"uiElementValue":{"type":"string"},"uiElementCreateTime":{"type":"number","format":"double"},"uiElementUpdateTime":{"type":"number","format":"double"}}}},"position":{"type":"integer","format":"int32"}}},"CustomTabsVisibilityPublicApiDTO":{"type":"object","properties":{"tabId":{"type":"integer","format":"int32"},"hidden":{"type":"boolean"}}},"CustomTabsOrderPublicApiDTO":{"type":"object","properties":{"tabId":{"type":"integer","format":"int32"},"position":{"type":"integer","format":"int32"}}},"CustomTabLabelDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"nodeRoleId":{"type":"integer","format":"int32"},"position":{"type":"integer","format":"int32"},"hiddenForRoles":{"type":"array","items":{"type":"integer","format":"int32"}},"default":{"type":"boolean"},"contentType":{"type":"string"},"contentConfig":{"type":"string"},"translationKey":{"type":"string"},"promoted":{"type":"boolean"}}},"CustomTabsOrderDTO":{"type":"object","properties":{"tabId":{"type":"integer","format":"int32"},"position":{"type":"integer","format":"int32"}}},"CarbonCopy":{"type":"object","properties":{"uids":{"uniqueItems":true,"type":"array","description":"List of user uids to be carbon-copied","nullable":true,"example":["1fa74a18-a329-40d8-b5b7-0a22624f7800","b0558cb6-3c4e-438c-b8fd-5247c648bbbe"],"items":{"type":"string","description":"List of user uids to be carbon-copied","format":"uuid","nullable":true}},"emails":{"uniqueItems":true,"type":"array","description":"emails","nullable":true,"example":["example1@example.com","example2@example.com"],"items":{"type":"string","description":"emails","nullable":true,"example":"[\"example1@example.com\",\"example2@example.com\"]"}}},"nullable":true},"NewTicket":{"required":["clientId","status","subject","ticketFormId"],"type":"object","properties":{"clientId":{"type":"integer","description":"Client (Organization) identifier","format":"int32","example":1},"ticketFormId":{"type":"integer","description":"Ticket form identifier","format":"int32","example":1},"locationId":{"type":"integer","description":"Location identifier","format":"int32","nullable":true,"example":1},"nodeId":{"type":"integer","description":"Device identifier","format":"int32","nullable":true,"example":1},"subject":{"maxLength":200,"minLength":0,"type":"string","example":"CPU with problems"},"description":{"required":["public"],"type":"object","properties":{"public":{"type":"boolean","default":true},"body":{"type":"string","nullable":true,"example":"new comment"},"htmlBody":{"type":"string","nullable":true,"example":"<p>new comment</p>"},"timeTracked":{"type":"integer","description":"time in seconds","format":"int32","nullable":true,"example":60},"duplicateInIncidents":{"type":"boolean"}}},"status":{"type":"string","default":"1000"},"type":{"type":"string","description":"Type of ticket","nullable":true,"example":"PROBLEM","enum":["PROBLEM","QUESTION","INCIDENT","TASK","CHANGE_REQUEST","SERVICE_REQUEST","PROJECT","APPOINTMENT","MISCELLANEOUS"]},"cc":{"type":"object","properties":{"uids":{"uniqueItems":true,"type":"array","description":"List of user uids to be carbon-copied","nullable":true,"example":["1fa74a18-a329-40d8-b5b7-0a22624f7800","b0558cb6-3c4e-438c-b8fd-5247c648bbbe"],"items":{"type":"string","description":"List of user uids to be carbon-copied","format":"uuid","nullable":true}},"emails":{"uniqueItems":true,"type":"array","description":"emails","nullable":true,"example":["example1@example.com","example2@example.com"],"items":{"type":"string","description":"emails","nullable":true,"example":"[\"example1@example.com\",\"example2@example.com\"]"}}},"nullable":true},"assignedAppUserId":{"type":"integer","format":"int32","nullable":true},"requesterUid":{"type":"string","format":"uuid"},"severity":{"type":"string","nullable":true,"enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"],"default":"NONE"},"priority":{"type":"string","nullable":true,"enum":["NONE","LOW","MEDIUM","HIGH"],"default":"NONE"},"parentTicketId":{"type":"integer","description":"Ticket parent identifier","format":"int32","nullable":true,"example":1},"tags":{"type":"array","nullable":true,"example":["tag1","tag2"],"items":{"type":"string","nullable":true,"example":"[\"tag1\",\"tag2\"]"}},"attributes":{"type":"array","nullable":true,"items":{"required":["attributeId","value"],"type":"object","properties":{"id":{"type":"integer","format":"int32","nullable":true,"example":1},"attributeId":{"type":"integer","description":"Attribute identifier","format":"int32","example":1},"value":{"type":"string","description":"Attribute value"}},"nullable":true}},"additionalAssignedTechnicianIds":{"uniqueItems":true,"type":"array","description":"Additional assigned technician identifiers","nullable":true,"example":[300,789],"items":{"type":"integer","description":"Additional assigned technician identifiers","format":"int32","nullable":true}},"followupTime":{"type":"number","description":"Follow-up time for the ticket in epoch seconds","format":"double","nullable":true}}},"NewTicketLogEntry":{"required":["public"],"type":"object","properties":{"public":{"type":"boolean","default":true},"body":{"type":"string","nullable":true,"example":"new comment"},"htmlBody":{"type":"string","nullable":true,"example":"<p>new comment</p>"},"timeTracked":{"type":"integer","description":"time in seconds","format":"int32","nullable":true,"example":60},"duplicateInIncidents":{"type":"boolean"}}},"TicketingAttributeValue":{"required":["attributeId","value"],"type":"object","properties":{"id":{"type":"integer","format":"int32","nullable":true,"example":1},"attributeId":{"type":"integer","description":"Attribute identifier","format":"int32","example":1},"value":{"type":"string","description":"Attribute value"}},"nullable":true},"AttributeValueDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"attributeId":{"type":"integer","format":"int32"},"value":{"type":"object"}}},"CcList":{"type":"object","properties":{"uids":{"uniqueItems":true,"type":"array","items":{"type":"string","format":"uuid"}},"emails":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"TicketDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"version":{"type":"integer","format":"int32"},"nodeId":{"type":"integer","format":"int32"},"clientId":{"type":"integer","format":"int32"},"locationId":{"type":"integer","format":"int32"},"assignedAppUserId":{"type":"integer","format":"int32"},"requesterUid":{"type":"string","format":"uuid"},"subject":{"type":"string"},"status":{"type":"object","properties":{"name":{"type":"string"},"displayName":{"type":"string"},"parentId":{"type":"integer","format":"int32"},"statusId":{"type":"integer","format":"int32"}}},"type":{"type":"string","enum":["PROBLEM","QUESTION","INCIDENT","TASK","CHANGE_REQUEST","SERVICE_REQUEST","PROJECT","APPOINTMENT","MISCELLANEOUS"]},"priority":{"type":"string","enum":["NONE","LOW","MEDIUM","HIGH"]},"severity":{"type":"string","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"]},"ticketFormId":{"type":"integer","format":"int32"},"source":{"type":"string","enum":["TECHNICIAN","EMAIL","WEB_FORM","HELP_REQUEST","END_USER","CONDITION","SCHEDULED_SCRIPT","ACTIVITY"]},"tags":{"type":"array","items":{"type":"string"}},"ccList":{"type":"object","properties":{"uids":{"uniqueItems":true,"type":"array","items":{"type":"string","format":"uuid"}},"emails":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"createTime":{"type":"number","format":"double"},"deleted":{"type":"boolean"},"attributeValues":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"attributeId":{"type":"integer","format":"int32"},"value":{"type":"object"}}}},"additionalAssignedTechnicianIds":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"followupTime":{"type":"number","format":"double"}}},"TicketStatusPublicApiDTO":{"type":"object","properties":{"name":{"type":"string"},"displayName":{"type":"string"},"parentId":{"type":"integer","format":"int32"},"statusId":{"type":"integer","format":"int32"}}},"AgreementDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"AgreementProductTimeEntryDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"TechniciansTaggedMetadataDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"email":{"type":"string"},"displayName":{"type":"string"},"deleted":{"type":"boolean"},"permitted":{"type":"boolean"}}},"TicketLogEntryAutomationDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"system":{"type":"boolean"},"type":{"type":"string"}}},"TicketLogEntryPublicApiDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"appUserContactUid":{"type":"string","format":"uuid"},"appUserContactId":{"type":"integer","format":"int32"},"appUserContactType":{"type":"string","enum":["TECHNICIAN","END_USER","CONTACT"]},"type":{"type":"string","enum":["DESCRIPTION","COMMENT","CONDITION","SAVE","DELETE","PRODUCT","INFO"]},"body":{"type":"string"},"htmlBody":{"type":"string"},"fullEmailBody":{"type":"string"},"publicEntry":{"type":"boolean"},"system":{"type":"boolean"},"createTime":{"type":"number","format":"double"},"changeDiff":{"type":"object"},"activityId":{"type":"integer","format":"int64"},"timeTracked":{"type":"integer","format":"int32"},"technicianTagged":{"type":"array","items":{"type":"integer","format":"int32"}},"techniciansTaggedMetadata":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"email":{"type":"string"},"displayName":{"type":"string"},"deleted":{"type":"boolean"},"permitted":{"type":"boolean"}}}},"automation":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"system":{"type":"boolean"},"type":{"type":"string"}}},"ticketTimeEntry":{"type":"object","properties":{"ticketLogEntryId":{"type":"integer","format":"int64"},"startDate":{"type":"integer","format":"int64"},"remote":{"type":"boolean"},"timeTracked":{"type":"integer","format":"int32"},"inHours":{"type":"object","properties":{"price":{"type":"number"},"timeTracked":{"type":"integer","format":"int32"},"billing":{"type":"string","enum":["BILLABLE","NOT_BILLABLE","NO_CHARGE"]},"billingStatus":{"type":"string","enum":["BILLED","PENDING","NOT_BILLABLE","UNASSIGNED"]},"agreementOriginType":{"type":"string","enum":["NONE","SELF","TICKET"]},"agreementProduct":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"agreement":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"invoiceId":{"type":"integer","format":"int32"}}},"offHours":{"type":"object","properties":{"price":{"type":"number"},"timeTracked":{"type":"integer","format":"int32"},"billing":{"type":"string","enum":["BILLABLE","NOT_BILLABLE","NO_CHARGE"]},"billingStatus":{"type":"string","enum":["BILLED","PENDING","NOT_BILLABLE","UNASSIGNED"]},"agreementOriginType":{"type":"string","enum":["NONE","SELF","TICKET"]},"agreementProduct":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"agreement":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"invoiceId":{"type":"integer","format":"int32"}}},"billingNote":{"type":"string"}}},"emailResponse":{"type":"boolean"}}},"TicketTimeEntryDTO":{"type":"object","properties":{"ticketLogEntryId":{"type":"integer","format":"int64"},"startDate":{"type":"integer","format":"int64"},"remote":{"type":"boolean"},"timeTracked":{"type":"integer","format":"int32"},"inHours":{"type":"object","properties":{"price":{"type":"number"},"timeTracked":{"type":"integer","format":"int32"},"billing":{"type":"string","enum":["BILLABLE","NOT_BILLABLE","NO_CHARGE"]},"billingStatus":{"type":"string","enum":["BILLED","PENDING","NOT_BILLABLE","UNASSIGNED"]},"agreementOriginType":{"type":"string","enum":["NONE","SELF","TICKET"]},"agreementProduct":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"agreement":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"invoiceId":{"type":"integer","format":"int32"}}},"offHours":{"type":"object","properties":{"price":{"type":"number"},"timeTracked":{"type":"integer","format":"int32"},"billing":{"type":"string","enum":["BILLABLE","NOT_BILLABLE","NO_CHARGE"]},"billingStatus":{"type":"string","enum":["BILLED","PENDING","NOT_BILLABLE","UNASSIGNED"]},"agreementOriginType":{"type":"string","enum":["NONE","SELF","TICKET"]},"agreementProduct":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"agreement":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"invoiceId":{"type":"integer","format":"int32"}}},"billingNote":{"type":"string"}}},"TimeTimeEntryBillingDataDTO":{"type":"object","properties":{"price":{"type":"number"},"timeTracked":{"type":"integer","format":"int32"},"billing":{"type":"string","enum":["BILLABLE","NOT_BILLABLE","NO_CHARGE"]},"billingStatus":{"type":"string","enum":["BILLED","PENDING","NOT_BILLABLE","UNASSIGNED"]},"agreementOriginType":{"type":"string","enum":["NONE","SELF","TICKET"]},"agreementProduct":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"agreement":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"}}},"invoiceId":{"type":"integer","format":"int32"}}},"UpdateTicket":{"required":["clientId","requesterUid","status","subject","ticketFormId","version"],"type":"object","properties":{"version":{"type":"integer","description":"ticket version","format":"int32","example":1},"clientId":{"type":"integer","description":"Client (Organization) identifier","format":"int32","example":1},"ticketFormId":{"type":"integer","description":"Ticket form identifier","format":"int32","example":1},"locationId":{"type":"integer","description":"Location identifier","format":"int32","nullable":true,"example":1},"nodeId":{"type":"integer","description":"Device identifier","format":"int32","nullable":true,"example":1},"subject":{"maxLength":200,"minLength":0,"type":"string","example":"CPU with problems"},"status":{"type":"string","default":"1000"},"type":{"type":"string","description":"Type of ticket","nullable":true,"example":"PROBLEM","enum":["PROBLEM","QUESTION","INCIDENT","TASK","CHANGE_REQUEST","SERVICE_REQUEST","PROJECT","APPOINTMENT","MISCELLANEOUS"]},"cc":{"type":"object","properties":{"uids":{"uniqueItems":true,"type":"array","description":"List of user uids to be carbon-copied","nullable":true,"example":["1fa74a18-a329-40d8-b5b7-0a22624f7800","b0558cb6-3c4e-438c-b8fd-5247c648bbbe"],"items":{"type":"string","description":"List of user uids to be carbon-copied","format":"uuid","nullable":true}},"emails":{"uniqueItems":true,"type":"array","description":"emails","nullable":true,"example":["example1@example.com","example2@example.com"],"items":{"type":"string","description":"emails","nullable":true,"example":"[\"example1@example.com\",\"example2@example.com\"]"}}},"nullable":true},"assignedAppUserId":{"type":"integer","format":"int32","nullable":true},"requesterUid":{"type":"string","format":"uuid"},"severity":{"type":"string","nullable":true,"enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"],"default":"NONE"},"priority":{"type":"string","nullable":true,"enum":["NONE","LOW","MEDIUM","HIGH"],"default":"NONE"},"parentTicketId":{"type":"integer","description":"Ticket parent identifier","format":"int32","nullable":true,"example":1},"tags":{"type":"array","nullable":true,"example":["tag1","tag2"],"items":{"type":"string","nullable":true,"example":"[\"tag1\",\"tag2\"]"}},"attributes":{"type":"array","nullable":true,"items":{"required":["attributeId","value"],"type":"object","properties":{"id":{"type":"integer","format":"int32","nullable":true,"example":1},"attributeId":{"type":"integer","description":"Attribute identifier","format":"int32","example":1},"value":{"type":"string","description":"Attribute value"}},"nullable":true}},"additionalAssignedTechnicianIds":{"uniqueItems":true,"type":"array","description":"Additional assigned technician identifiers","nullable":true,"example":[300,789],"items":{"type":"integer","description":"Additional assigned technician identifiers","format":"int32","nullable":true}},"followupTime":{"type":"number","description":"Follow-up time for the ticket in epoch seconds","format":"double","nullable":true}}},"PublicScanGroup":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"groupName":{"type":"string"},"fileName":{"type":"string"},"status":{"type":"string","enum":["COMPLETE","IN_PROGRESS","FAILED"]},"vendor":{"type":"string"},"thirdPartyApiTile":{"type":"string"},"deviceIdHeader":{"type":"string"},"deviceInternalMapping":{"type":"string"},"cveIdHeader":{"type":"string"},"lastFileUploadDate":{"type":"string"},"recordsProcessed":{"type":"integer","format":"int32"}}},"CsvUploadRequest":{"required":["csv"],"type":"object","properties":{"csv":{"type":"string","description":"The CSV file containing vulnerability data. The maximum file size is 200MB.","format":"binary"}}},"WindowsServiceControlRequest":{"type":"object","properties":{"action":{"type":"string","description":"Action","enum":["START","PAUSE","STOP","RESTART"]}}},"AgentDevice":{"title":"Agent device","required":["deviceType"],"type":"object","description":"Device with an installed agent","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"os":{"type":"object","properties":{"manufacturer":{"type":"string","description":"Manufacturer"},"name":{"type":"string","description":"Name"},"architecture":{"type":"string","description":"Architecture"},"lastBootTime":{"type":"number","description":"Last boot time","format":"double"},"buildNumber":{"type":"string","description":"Build number"},"releaseId":{"type":"string","description":"Release ID"},"servicePackMajorVersion":{"type":"integer","description":"Service Pack Major Version","format":"int32"},"servicePackMinorVersion":{"type":"integer","description":"Service Pack Minor Version","format":"int32"},"locale":{"type":"string","description":"Locale"},"language":{"type":"string","description":"Language"},"needsReboot":{"type":"boolean","description":"Operating system has pending reboot requests"}},"description":"Operating System"},"system":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"manufacturer":{"type":"string","description":"Manufacturer"},"model":{"type":"string","description":"Model"},"biosSerialNumber":{"type":"string","description":"Bios Serial Number"},"serialNumber":{"type":"string","description":"Serial Number"},"assetSerialNumber":{"type":"string","description":"Asset Serial Number"},"domain":{"type":"string"},"domainRole":{"type":"string"},"numberOfProcessors":{"type":"integer","format":"int32"},"totalPhysicalMemory":{"type":"integer","format":"int64"},"virtualMachine":{"type":"boolean"},"chassisType":{"type":"string"}},"description":"Computer System (Chassis)"},"memory":{"type":"object","properties":{"capacity":{"type":"integer","description":"Capacity","format":"int64"}},"description":"Memory information"},"processors":{"type":"array","description":"Processors","items":{"type":"object","properties":{"architecture":{"type":"string","description":"Architecture"},"maxClockSpeed":{"type":"integer","description":"Max Clock Speed","format":"int64"},"clockSpeed":{"type":"integer","description":"Current Clock Speed","format":"int64"},"name":{"type":"string","description":"Name"},"numCores":{"type":"integer","description":"Number of Cores","format":"int32"},"numLogicalCores":{"type":"integer","description":"Number of Logical Cores]","format":"int32"}},"description":"Processors"}},"volumes":{"type":"array","description":"Disk Volumes","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"driveLetter":{"type":"string","description":"Drive Letter"},"label":{"type":"string","description":"Volume Label"},"deviceType":{"type":"string","description":"Device Type"},"fileSystem":{"type":"string","description":"File System Type"},"autoMount":{"type":"boolean","description":"Automatically Mounted"},"compressed":{"type":"boolean","description":"Compressed"},"capacity":{"type":"integer","description":"Capacity (bytes)","format":"int64"},"freeSpace":{"type":"integer","description":"Free Space (bytes)","format":"int64"},"serialNumber":{"type":"string","description":"Serial Number"},"bitLockerStatus":{"type":"object","properties":{"conversionStatus":{"type":"string","description":"Volume encryption or decryption status.","enum":["FULLY_DECRYPTED","FULLY_ENCRYPTED","ENCRYPTION_IN_PROGRESS","DECRYPTION_IN_PROGRESS","ENCRYPTION_PAUSED","DECRYPTION_PAUSED","UNKNOWN"]},"encryptionMethod":{"type":"string","description":"Indicated the encryption algorithm and key size used on the volume","enum":["NONE","AES_128_WITH_DIFFUSER","AES_256_WITH_DIFFUSER","AES_128","AES_256","HARDWARE_ENCRYPTION","XTS_AES_128","XTS_AES_256","UNKNOWN"]},"protectionStatus":{"type":"string","description":" indicates whether the volume and its encryption key (if any) are secured.","enum":["UNPROTECTED","PROTECTED","UNKNOWN","PENDING"]},"lockStatus":{"type":"string","description":"Indicates whether the contents of the volume are accessible from Windows","enum":["UNKNOWN","UNLOCKED","LOCKED"]},"initializedForProtection":{"type":"boolean","description":"Is initialized for protection"}},"description":"BitLocker Status"}},"description":"Disk Volumes"}},"lastLoggedInUser":{"type":"string","description":"Username that logged in most recently"},"deviceType":{"type":"string","description":"Device type","enum":["AgentDevice"]}}}]},"BackupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"ComputerSystem":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"manufacturer":{"type":"string","description":"Manufacturer"},"model":{"type":"string","description":"Model"},"biosSerialNumber":{"type":"string","description":"Bios Serial Number"},"serialNumber":{"type":"string","description":"Serial Number"},"assetSerialNumber":{"type":"string","description":"Asset Serial Number"},"domain":{"type":"string"},"domainRole":{"type":"string"},"numberOfProcessors":{"type":"integer","format":"int32"},"totalPhysicalMemory":{"type":"integer","format":"int64"},"virtualMachine":{"type":"boolean"},"chassisType":{"type":"string"}},"description":"Computer System (Chassis)"},"Maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"Memory":{"type":"object","properties":{"capacity":{"type":"integer","description":"Capacity","format":"int64"}},"description":"Memory information"},"NodeReferences":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"NodeRole":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"Note":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"},"OperatingSystem":{"type":"object","properties":{"manufacturer":{"type":"string","description":"Manufacturer"},"name":{"type":"string","description":"Name"},"architecture":{"type":"string","description":"Architecture"},"lastBootTime":{"type":"number","description":"Last boot time","format":"double"},"buildNumber":{"type":"string","description":"Build number"},"releaseId":{"type":"string","description":"Release ID"},"servicePackMajorVersion":{"type":"integer","description":"Service Pack Major Version","format":"int32"},"servicePackMinorVersion":{"type":"integer","description":"Service Pack Minor Version","format":"int32"},"locale":{"type":"string","description":"Locale"},"language":{"type":"string","description":"Language"},"needsReboot":{"type":"boolean","description":"Operating system has pending reboot requests"}},"description":"Operating System"},"Organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"Policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"Processor":{"type":"object","properties":{"architecture":{"type":"string","description":"Architecture"},"maxClockSpeed":{"type":"integer","description":"Max Clock Speed","format":"int64"},"clockSpeed":{"type":"integer","description":"Current Clock Speed","format":"int64"},"name":{"type":"string","description":"Name"},"numCores":{"type":"integer","description":"Number of Cores","format":"int32"},"numLogicalCores":{"type":"integer","description":"Number of Logical Cores]","format":"int32"}},"description":"Processors"},"User":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"Volume":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"driveLetter":{"type":"string","description":"Drive Letter"},"label":{"type":"string","description":"Volume Label"},"deviceType":{"type":"string","description":"Device Type"},"fileSystem":{"type":"string","description":"File System Type"},"autoMount":{"type":"boolean","description":"Automatically Mounted"},"compressed":{"type":"boolean","description":"Compressed"},"capacity":{"type":"integer","description":"Capacity (bytes)","format":"int64"},"freeSpace":{"type":"integer","description":"Free Space (bytes)","format":"int64"},"serialNumber":{"type":"string","description":"Serial Number"},"bitLockerStatus":{"type":"object","properties":{"conversionStatus":{"type":"string","description":"Volume encryption or decryption status.","enum":["FULLY_DECRYPTED","FULLY_ENCRYPTED","ENCRYPTION_IN_PROGRESS","DECRYPTION_IN_PROGRESS","ENCRYPTION_PAUSED","DECRYPTION_PAUSED","UNKNOWN"]},"encryptionMethod":{"type":"string","description":"Indicated the encryption algorithm and key size used on the volume","enum":["NONE","AES_128_WITH_DIFFUSER","AES_256_WITH_DIFFUSER","AES_128","AES_256","HARDWARE_ENCRYPTION","XTS_AES_128","XTS_AES_256","UNKNOWN"]},"protectionStatus":{"type":"string","description":" indicates whether the volume and its encryption key (if any) are secured.","enum":["UNPROTECTED","PROTECTED","UNKNOWN","PENDING"]},"lockStatus":{"type":"string","description":"Indicates whether the contents of the volume are accessible from Windows","enum":["UNKNOWN","UNLOCKED","LOCKED"]},"initializedForProtection":{"type":"boolean","description":"Is initialized for protection"}},"description":"BitLocker Status"}},"description":"Disk Volumes"},"VolumeBitLockerStatus":{"type":"object","properties":{"conversionStatus":{"type":"string","description":"Volume encryption or decryption status.","enum":["FULLY_DECRYPTED","FULLY_ENCRYPTED","ENCRYPTION_IN_PROGRESS","DECRYPTION_IN_PROGRESS","ENCRYPTION_PAUSED","DECRYPTION_PAUSED","UNKNOWN"]},"encryptionMethod":{"type":"string","description":"Indicated the encryption algorithm and key size used on the volume","enum":["NONE","AES_128_WITH_DIFFUSER","AES_256_WITH_DIFFUSER","AES_128","AES_256","HARDWARE_ENCRYPTION","XTS_AES_128","XTS_AES_256","UNKNOWN"]},"protectionStatus":{"type":"string","description":" indicates whether the volume and its encryption key (if any) are secured.","enum":["UNPROTECTED","PROTECTED","UNKNOWN","PENDING"]},"lockStatus":{"type":"string","description":"Indicates whether the contents of the volume are accessible from Windows","enum":["UNKNOWN","UNLOCKED","LOCKED"]},"initializedForProtection":{"type":"boolean","description":"Is initialized for protection"}},"description":"BitLocker Status"},"WarrantyDates":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"CloudMonitorPing":{"title":"Cloud monitor: Ping","required":["deviceType"],"type":"object","description":"Cloud monitor that checks a target with ping","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is enabled?"},"interval":{"type":"integer","description":"Monitoring interval (seconds)","format":"int32"},"timeout":{"type":"integer","description":"Timeout (seconds)","format":"int32"},"target":{"type":"string","description":"Monitoring target (hostname, IP address or URL)"},"deviceType":{"type":"string","description":"Device type","enum":["CloudMonitorPing"]}}}]},"CloudMonitorDNS":{"title":"Cloud monitor: DNS","required":["deviceType"],"type":"object","description":"Cloud monitor that checks DNS resolution","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is enabled?"},"interval":{"type":"integer","description":"Monitoring interval (seconds)","format":"int32"},"timeout":{"type":"integer","description":"Timeout (seconds)","format":"int32"},"target":{"type":"string","description":"Monitoring target (hostname, IP address or URL)"},"deviceType":{"type":"string","description":"Device type","enum":["CloudMonitorDNS"]}}}]},"CloudMonitorHTTP":{"title":"Cloud monitor: HTTP","required":["deviceType"],"type":"object","description":"Cloud monitor that checks an HTTP/HTTPS endpoint","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is enabled?"},"interval":{"type":"integer","description":"Monitoring interval (seconds)","format":"int32"},"timeout":{"type":"integer","description":"Timeout (seconds)","format":"int32"},"target":{"type":"string","description":"Monitoring target (hostname, IP address or URL)"},"deviceType":{"type":"string","description":"Device type","enum":["CloudMonitorHTTP"]}}}]},"CloudMonitorPortScan":{"title":"Cloud monitor: Port scan","required":["deviceType"],"type":"object","description":"Cloud monitor that checks open ports on a target","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is enabled?"},"interval":{"type":"integer","description":"Monitoring interval (seconds)","format":"int32"},"timeout":{"type":"integer","description":"Timeout (seconds)","format":"int32"},"target":{"type":"string","description":"Monitoring target (hostname, IP address or URL)"},"deviceType":{"type":"string","description":"Device type","enum":["CloudMonitorPortScan"]}}}]},"CloudMonitorEmailServer":{"title":"Cloud monitor: Email server","required":["deviceType"],"type":"object","description":"Cloud monitor that checks an email server","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"enabled":{"type":"boolean","description":"Is enabled?"},"interval":{"type":"integer","description":"Monitoring interval (seconds)","format":"int32"},"timeout":{"type":"integer","description":"Timeout (seconds)","format":"int32"},"target":{"type":"string","description":"SMTP Host (hostname or IP address)"},"smtpPort":{"type":"integer","description":"SMTP Port","format":"int32"},"senderEmail":{"type":"string","description":"Sender's email (FROM)"},"recipientEmail":{"type":"string","description":"Recipient's email (TO)"},"deviceType":{"type":"string","description":"Device type","enum":["CloudMonitorEmailServer"]}}}]},"NMSServer":{"title":"NMS server","required":["deviceType"],"type":"object","description":"Network management system server","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"deviceType":{"type":"string","description":"Device type","enum":["NMSServer"]}}}]},"NMSTarget":{"title":"NMS target","required":["deviceType"],"type":"object","description":"Network device monitored by an NMS server","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"deviceType":{"type":"string","description":"Device type","enum":["NMSTarget"]}}}]},"VMHost":{"title":"VM host","required":["deviceType"],"type":"object","description":"Virtualization host (VMware or Hyper-V)","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"cpuMhz":{"type":"integer","description":"CPU Frequency","format":"int64"},"cpuModel":{"type":"string","description":"CPU Model"},"htActive":{"type":"boolean","description":"Is Hyper-Threading active?"},"htAvailable":{"type":"boolean","description":"Is Hyper-Threading available?"},"lastBootTime":{"type":"number","description":"Last toot time","format":"double"},"memorySize":{"type":"integer","description":"Total memory size (bytes)","format":"int64"},"model":{"type":"string","description":"Model"},"name":{"type":"string","description":"Name"},"cpuCores":{"type":"integer","description":"Number of CPU Cores","format":"int32"},"cpuPackages":{"type":"integer","description":"Number of CPUs","format":"int32"},"cpuThreads":{"type":"integer","description":"Total number of logical CPU cores","format":"int32"},"serviceTag":{"type":"string","description":"Service Tag"},"vendor":{"type":"string","description":"Vendor"},"releaseName":{"type":"string","description":"Release Name"},"version":{"type":"string","description":"Version"},"buildNumber":{"type":"string","description":"Build number"},"deviceType":{"type":"string","description":"Device type","enum":["VMHost"]}}}]},"VMGuest":{"title":"VM guest","required":["deviceType"],"type":"object","description":"Virtual machine guest (VMware or Hyper-V)","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"files":{"type":"string","description":"Guest VM Files"},"fullName":{"type":"string","description":"Full Name"},"lastBootTime":{"type":"number","description":"Last VM Boot Time","format":"double"},"memorySize":{"type":"integer","description":"VM Memory size (bytes)","format":"int64"},"coresPerSocket":{"type":"integer","description":"Number of Cores per Socket","format":"int32"},"cpuCores":{"type":"integer","description":"Total Number of CPU Cores","format":"int32"},"powerState":{"type":"string","description":"Current power state"},"toolsInstallType":{"type":"string","description":"Guest tools installation type"},"toolStatus":{"type":"string","description":"Guest tools status"},"toolsVersion":{"type":"string","description":"Guest tools version"},"guestOSFullName":{"type":"string","description":"Guest OS full name"},"guestOSFamily":{"type":"string","description":"Guest OS family"},"guestOSId":{"type":"string","description":"Guest OS identifier"},"toolsVersionStatus":{"type":"string","description":"Guest tools version status"},"snapshotCount":{"type":"integer","description":"Number of snapshots","format":"int32"},"snapshotTotalSize":{"type":"integer","description":"Total snapshot size (bytes)","format":"int64"},"deviceType":{"type":"string","description":"Device type","enum":["VMGuest"]}}}]},"MdmDevice":{"title":"MDM device","required":["deviceType"],"type":"object","description":"Mobile device managed through MDM","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"system":{"type":"object","properties":{"displayName":{"type":"string","description":"Display Name"},"name":{"type":"string","description":"Name"},"manufacturer":{"type":"string","description":"Manufacturer"},"model":{"type":"string","description":"Model"},"serialNumber":{"type":"string","description":"Serial Number"},"build":{"type":"string","description":"Build"}},"description":"Mdm System"},"memory":{"type":"object","properties":{"capacity":{"type":"integer","description":"Capacity","format":"int64"}},"description":"Memory information"},"network":{"type":"array","description":"Network information","items":{"type":"object","properties":{"imei":{"type":"string","description":"International Mobile Equipment Identity"},"eid":{"type":"string","description":"eUICC Identifier"},"meid":{"type":"string","description":"Mobile Equipment Identifier"},"phoneNumber":{"type":"string","description":"Device phone number"},"carrier":{"type":"string","description":"Network carrier name"},"iccId":{"type":"string","description":"Integrated Circuit Card Identifier"}},"description":"Network information"}},"volumes":{"type":"array","description":"Disk Volumes","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"driveLetter":{"type":"string","description":"Drive Letter"},"label":{"type":"string","description":"Volume Label"},"deviceType":{"type":"string","description":"Device Type"},"fileSystem":{"type":"string","description":"File System Type"},"autoMount":{"type":"boolean","description":"Automatically Mounted"},"compressed":{"type":"boolean","description":"Compressed"},"capacity":{"type":"integer","description":"Capacity (bytes)","format":"int64"},"freeSpace":{"type":"integer","description":"Free Space (bytes)","format":"int64"},"serialNumber":{"type":"string","description":"Serial Number"},"bitLockerStatus":{"type":"object","properties":{"conversionStatus":{"type":"string","description":"Volume encryption or decryption status.","enum":["FULLY_DECRYPTED","FULLY_ENCRYPTED","ENCRYPTION_IN_PROGRESS","DECRYPTION_IN_PROGRESS","ENCRYPTION_PAUSED","DECRYPTION_PAUSED","UNKNOWN"]},"encryptionMethod":{"type":"string","description":"Indicated the encryption algorithm and key size used on the volume","enum":["NONE","AES_128_WITH_DIFFUSER","AES_256_WITH_DIFFUSER","AES_128","AES_256","HARDWARE_ENCRYPTION","XTS_AES_128","XTS_AES_256","UNKNOWN"]},"protectionStatus":{"type":"string","description":" indicates whether the volume and its encryption key (if any) are secured.","enum":["UNPROTECTED","PROTECTED","UNKNOWN","PENDING"]},"lockStatus":{"type":"string","description":"Indicates whether the contents of the volume are accessible from Windows","enum":["UNKNOWN","UNLOCKED","LOCKED"]},"initializedForProtection":{"type":"boolean","description":"Is initialized for protection"}},"description":"BitLocker Status"}},"description":"Disk Volumes"}},"lastLoggedInUser":{"type":"string","description":"Last logged in user"},"deviceType":{"type":"string","description":"Device type","enum":["MdmDevice"]}}}]},"MdmNetworkInterface":{"type":"object","properties":{"imei":{"type":"string","description":"International Mobile Equipment Identity"},"eid":{"type":"string","description":"eUICC Identifier"},"meid":{"type":"string","description":"Mobile Equipment Identifier"},"phoneNumber":{"type":"string","description":"Device phone number"},"carrier":{"type":"string","description":"Network carrier name"},"iccId":{"type":"string","description":"Integrated Circuit Card Identifier"}},"description":"Network information"},"MdmSystem":{"type":"object","properties":{"displayName":{"type":"string","description":"Display Name"},"name":{"type":"string","description":"Name"},"manufacturer":{"type":"string","description":"Manufacturer"},"model":{"type":"string","description":"Model"},"serialNumber":{"type":"string","description":"Serial Number"},"build":{"type":"string","description":"Build"}},"description":"Mdm System"},"UnmanagedDevice":{"title":"Unmanaged device","required":["deviceType"],"type":"object","description":"Device tracked without an agent or monitor","allOf":[{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},{"type":"object","properties":{"deviceType":{"type":"string","description":"Device type","enum":["UnmanagedDevice"]}}}]},"Device":{"required":["deviceType"],"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"ipAddresses":{"type":"array","description":"Device IP addresses","items":{"type":"string","description":"Device IP addresses"}},"macAddresses":{"type":"array","description":"Device MAC addresses","items":{"type":"string","description":"Device MAC addresses"}},"publicIP":{"type":"string","description":"Device Public IP Address"},"notes":{"type":"array","description":"Device Notes","items":{"type":"object","properties":{"text":{"type":"string","description":"Note text"}},"description":"Device Notes"}},"deviceType":{"type":"string","description":"Concrete device type. Use it to determine which additional fields are present.","enum":["AgentDevice","CloudMonitorPing","CloudMonitorDNS","CloudMonitorHTTP","CloudMonitorPortScan","CloudMonitorEmailServer","NMSServer","NMSTarget","VMHost","VMGuest","MdmDevice","UnmanagedDevice"]}},"description":"Base device model. The concrete shape depends on deviceType.","discriminator":{"propertyName":"deviceType","mapping":{"AgentDevice":"#/components/schemas/AgentDevice","CloudMonitorPing":"#/components/schemas/CloudMonitorPing","CloudMonitorDNS":"#/components/schemas/CloudMonitorDNS","CloudMonitorHTTP":"#/components/schemas/CloudMonitorHTTP","CloudMonitorPortScan":"#/components/schemas/CloudMonitorPortScan","CloudMonitorEmailServer":"#/components/schemas/CloudMonitorEmailServer","NMSServer":"#/components/schemas/NMSServer","NMSTarget":"#/components/schemas/NMSTarget","VMHost":"#/components/schemas/VMHost","VMGuest":"#/components/schemas/VMGuest","MdmDevice":"#/components/schemas/MdmDevice","UnmanagedDevice":"#/components/schemas/UnmanagedDevice"}}},"Job":{"type":"object","properties":{"uid":{"type":"string","description":"Task/Job UID (activity series UID)","format":"uuid"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"message":{"type":"string","description":"Job message"},"createTime":{"type":"number","description":"Job start timestamp","format":"double"},"updateTime":{"type":"number","description":"Job last updated","format":"double"},"sourceType":{"type":"string","description":"Job origin","enum":["AGENT_OFFLINE","CONDITION_AGENT_CPU","CONDITION_AGENT_MEMORY","CONDITION_AGENT_NETWORK","CONDITION_AGENT_DISK_IO","CONDITION_AGENT_DISK_FREE_SPACE","CONDITION_AGENT_DISK_USAGE","CONDITION_AGENT_CVSS_SCORE","CONDITION_AGENT_PATCH_LAST_INSTALLED","CONDITION_NMS_CPU","CONDITION_NMS_MEMORY","CONDITION_NMS_NETWORK_TRAFFIC_BITS","CONDITION_NMS_NETWORK_ADAPTER_STATUS","CONDITION_NMS_NETWORK_TRAFFIC_PERCENT","CONDITION_NMS_NETWORK_STATUS","CONDITION_NMS_NETWORK_STATUS_CHANGE","CONDITION_NMS_SYSTEM_UPTIME","CONDITION_PING","CONDITION_PING_LATENCY","CONDITION_PING_PACKET_LOSS","CONDITION_PING_RESPONSE","CONDITION_SYSTEM_UPTIME","CONDITION_SMART_STATUS_DEGRATED","CONDITION_RAID_HEALTH_STATUS","CONDITION_SCRIPT_RESULT","CONDITION_HTTP","CONDITION_HTTP_RESPONSE","CONDITION_PORT","CONDITION_PORT_SCAN","CONDITION_SYSLOG","CONDITION_CONFIGURATION_FILE","CONDITION_SNMPTRAP","CONDITION_CRITICAL_EVENT","CONDITION_BATTERY_MONITORING","CONDITION_DNS","CONDITION_EMAIL","CONDITION_CUSTOM_SNMP","CONDITION_COMPOUND","SHADOWPROTECT_BACKUPJOB_CREATE","SHADOWPROTECT_BACKUPJOB_UPDATE","SHADOWPROTECT_BACKUPJOB_DELETE","SHADOWPROTECT_BACKUPJOB_EXECUTE","IMAGEMANAGER_MANAGEDFOLDER_CREATE","IMAGEMANAGER_MANAGEDFOLDER_UPDATE","IMAGEMANAGER_MANAGEDFOLDER_DELETE","IMAGEMANAGER_MANAGEDFOLDER_EXECUTE","TEAMVIEWER_CONNECTION","RETRIEVE_AGENT_LOGS","SCHEDULED_TASK","CONDITION_WINDOWS_EVENT_LOG_TRIGGERED","CONDITION_WINDOWS_SERVICE_STATE_CHANGED","UI_MESSAGE_ACTION_REBOOT","UI_MESSAGE_BD_INSTALLATION_ISSUES","GRAVITYZONE_UI_MESSAGE_INSTALLATION_ISSUES","AV_QUARANTINE_THREAT","AV_RESTORE_THREAT","AV_DELETE_THREAT","AV_REMOVE_THREAT","BITDEFENDER_RESTORE_THREAT","BITDEFENDER_DELETE_THREAT","CONDITION_BITLOCKER_STATUS","CONDITION_FILEVAULT_STATUS","CONDITION_LINUX_PROCESS","CONDITION_LINUX_Daemon","CONDITION_LINUX_PROCESS_RESOURCE","CONDITION_LINUX_PROCESS_RESOURCE_CPU","CONDITION_LINUX_PROCESS_RESOURCE_MEMORY","CONDITION_LINUX_DISK_FREE_SPACE","CONDITION_LINUX_DISK_USAGE","CONDITION_VM_AGGREGATE_CPU_USAGE","CONDITION_VM_DISK_USAGE","CONDITION_VM_HOST_DATASTORE","CONDITION_VM_HOST_UPTIME","CONDITION_VM_HOST_DEVICE_DOWN","CONDITION_VM_HOST_BAD_SENSORS","CONDITION_VM_HOST_SENSOR_HEALTH","CONDITION_VM_GUEST_GUEST_OPERATIONAL_MODE","CONDITION_VM_GUEST_SNAPSHOT_SIZE","CONDITION_VM_GUEST_SNAPSHOT_LIFESPAN","CONDITION_VM_GUEST_TOOLS_NOT_RUNNING","CONDITION_HV_GUEST_CHECKPOINT_SIZE","CONDITION_HV_GUEST_CHECKPOINT_LIFESPAN","CONDITION_SOFTWARE","CONDITION_WINDOWS_PROCESS_STATE","CONDITION_WINDOWS_PROCESS_RESOURCE_CPU","CONDITION_WINDOWS_PROCESS_RESOURCE_MEMORY","CONDITION_MAC_PROCESS_STATE","CONDITION_MAC_PROCESS_RESOURCE_CPU","CONDITION_MAC_PROCESS_RESOURCE_MEMORY","CONDITION_MAC_DEAMON","CONDITION_CUSTOM_FIELD","CONDITION_PENDING_REBOOT","CONDITION_LOCKHART_LAST_SUCCESSFUL_BACKUP"]},"sourceConfigUid":{"type":"string","description":"Source configuration/policy element reference","format":"uuid"},"sourceName":{"type":"string","description":"Source configuration/policy element name"},"subject":{"type":"string","description":"Job subject"},"userId":{"type":"integer","description":"User identifier","format":"int32"},"psaTicketId":{"type":"object","description":"Related PSA ticket ID"},"ticketTemplateId":{"type":"integer","description":"PSA ticket template","format":"int32"},"data":{"type":"object","additionalProperties":true,"description":"Job data"},"device":{"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"}},"description":"Device information."},"jobStatus":{"type":"string","description":"Job Status","enum":["START_REQUESTED","STARTED","IN_PROCESS","COMPLETED","CANCEL_REQUESTED","CANCELLED","WAITING_FOR_USER_RESPONSE","SUPERSEDED","TRIGGERED","RESET","ACKNOWLEDGED","DISABLED"]},"jobResult":{"type":"string","description":"Job result","enum":["SUCCESS","FAILURE","UNSUPPORTED","UNCOMPLETED","MISSED"]},"jobType":{"type":"string","description":"Job Type","enum":["ACTIONSET","ACTION","CONDITION","CONDITION_ACTIONSET","CONDITION_ACTION","ANTIVIRUS","PATCH_MANAGEMENT","TEAMVIEWER","MONITOR","SYSTEM","COMMENT","SHADOWPROTECT","IMAGEMANAGER","HELP_REQUEST","SOFTWARE_PATCH_MANAGEMENT","SPLASHTOP","CLOUDBERRY","CLOUDBERRY_BACKUP","SCHEDULED_TASK","RDP","SCRIPTING","SECURITY","REMOTE_TOOLS","VIRTUALIZATION","PSA","MDM","NINJA_REMOTE","NINJA_QUICK_CONNECT","NINJA_NETWORK_DISCOVERY","NINJA_BACKUP","NINJA_TICKETING","KNOWLEDGE_BASE","RELATED_ITEM","CLIENT_CHECKLIST","CHECKLIST_TEMPLATE","DOCUMENTATION","MICROSOFT_INTUNE","DYNAMIC_POLICY","MAINTENANCE_MODE","AOSP_ACTION","AOSP_POLICY","AOSP"]}}},"NodeWithDetailedReferences":{"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"}},"description":"Device information."},"Activity":{"type":"object","properties":{"id":{"type":"integer","description":"Activity identifier","format":"int64"},"activityTime":{"type":"number","description":"Activity timestamp","format":"double"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"severity":{"type":"string","description":"Severity","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"]},"priority":{"type":"string","description":"Priority","enum":["NONE","LOW","MEDIUM","HIGH"]},"seriesUid":{"type":"string","description":"Activity series UID (job/condition UID)","format":"uuid"},"activityType":{"type":"string","description":"Activity type code","enum":["ACTIONSET","ACTION","CONDITION","CONDITION_ACTIONSET","CONDITION_ACTION","ANTIVIRUS","PATCH_MANAGEMENT","TEAMVIEWER","MONITOR","SYSTEM","COMMENT","SHADOWPROTECT","IMAGEMANAGER","HELP_REQUEST","SOFTWARE_PATCH_MANAGEMENT","SPLASHTOP","CLOUDBERRY","CLOUDBERRY_BACKUP","SCHEDULED_TASK","RDP","SCRIPTING","SECURITY","REMOTE_TOOLS","VIRTUALIZATION","PSA","MDM","NINJA_REMOTE","NINJA_QUICK_CONNECT","NINJA_NETWORK_DISCOVERY","NINJA_BACKUP","NINJA_TICKETING","KNOWLEDGE_BASE","RELATED_ITEM","CLIENT_CHECKLIST","CHECKLIST_TEMPLATE","DOCUMENTATION","MICROSOFT_INTUNE","DYNAMIC_POLICY","MAINTENANCE_MODE","AOSP_ACTION","AOSP_POLICY","AOSP"]},"statusCode":{"type":"string","description":"Activity status code","enum":["START_REQUESTED","STARTED","IN_PROCESS","COMPLETED","CANCEL_REQUESTED","CANCELLED","BLOCKED","QUEUED","TRIGGERED","RESET","ACKNOWLEDGED","DISABLED","EVALUATION_FAILURE","CLIENT_CREATED","CLIENT_UPDATED","CLIENT_DELETED","CREDENTIAL_CREATED","CREDENTIAL_UPDATED","CREDENTIAL_DELETED","LOCATION_CREATED","LOCATION_UPDATED","LOCATION_DELETED","POLICY_CREATED","POLICY_UPDATED","POLICY_DELETED","NODE_CREATED","NODE_UPDATED","NODE_DELETED","NODE_RE_ENROLLED","NODE_ACCESS_GRANTED","NODE_ACCESS_DENIED","NODE_REGISTRATION_REJECTED","NODE_IDENTIFICATION_UPDATED","NODE_CLONING_DETECTED","NODE_CLONE_ADVISED_TO_REGISTER","NODE_MANUALLY_APPROVED","NODE_AUTOMATICALLY_APPROVED","NODE_MANUALLY_REJECTED","NODE_AUTOMATICALLY_REJECTED","REJECTED_NODE_CLEARED","REJECTED_NODE_DELETED","MOBILE_DEVICE_UNREGISTERED","APP_USER_CREATED","APP_USER_UPDATED","APP_USER_DELETED","APP_USER_LOGGED_IN","APP_USER_LOGGED_OUT","APP_USER_MFA_SETUP","APP_USER_MFA_DELETED","APP_USER_CRITICAL_ACTION","APP_USER_AUDIT_FAILED_LOGIN","APP_USER_AUTO_ASSIGN_CHANGED","END_USER_CREATED","END_USER_CREATED_API","END_USER_UPDATED","END_USER_UPDATED_API","END_USER_DELETED","END_USER_DELETED_API","END_USER_LOGGED_IN","END_USER_LOGGED_OUT","END_USER_MFA_SETUP","END_USER_MFA_DELETED","END_USER_AUDIT_FAILED_LOGIN","END_USER_CRITICAL_ACTION","CONTACT_CREATED","CONTACT_CREATED_API","CONTACT_UPDATED","CONTACT_UPDATED_API","CONTACT_DELETED","CONTACT_DELETED_API","DEVICE_GROUP_CREATED","DEVICE_GROUP_UPDATED","DEVICE_GROUP_DELETED","TICKET_TEMPLATE_CREATED","TICKET_TEMPLATE_UPDATED","TICKET_TEMPLATE_DELETED","CUSTOM_HEALTH_STATUS_CHANGED","CUSTOM_HEALTH_STATUS_RESET","PSA_TICKET_CREATION_FAILED","PSA_TICKET_CREATION_SUCCEEDED","RESET_BY_PSA_TICKET_CALLBACK","PSA_TICKET_CREATION_TEST","PSA_ENABLED","PSA_DISABLED","PSA_CREDENTIALS_FAILED","CONNECTWISE_AGREEMENTS_SYNC_COMPLETED","CONNECTWISE_AGREEMENTS_SYNC_STARTED","CONNECTWISE_NODE_SYNC_COMPLETED","CONNECTWISE_NODE_SYNC_STARTED","CONNECTWISE_NODE_SYNC_NODE_CREATED","CONNECTWISE_NODE_SYNC_NODE_UPDATED","CONNECTWISE_NODE_SYNC_NODE_DELETED","CONNECTWISE_UPDATED","CONNECTWISECONTROL_ATTEMPT","AUTOTASK_NODE_SYNC_STARTED","AUTOTASK_NODE_SYNC_COMPLETED","AUTOTASK_NODE_SYNC_NODE_CREATED","AUTOTASK_NODE_SYNC_NODE_UPDATED","AUTOTASK_NODE_SYNC_NODE_DELETED","AUTOTASK_UPDATED","AUTOTASK_ATTACHMENT_FAILURE","PSA_TICKET_UPDATED_FAILED","PSA_TICKET_UPDATED_SUCCEEDED","REPORT_CREATED","REPORT_UPDATED","REPORT_DELETED","TIME_ZONE_UPDATED","LANGUAGE_TAG_UPDATED","NODE_ROLE_CREATED","NODE_ROLE_UPDATED","NODE_ROLE_DELETED","COMMENT","VIPREAV_INSTALLED","VIPREAV_INSTALL_FAILED","VIPREAV_UNINSTALLED","VIPREAV_UNINSTALL_FAILED","VIPREAV_SCAN_THREAT_QUARANTINED","VIPREAV_ACTIVEPROTECTION_THREAT_QUARANTINED","VIPREAV_USERINITIATED_THREAT_QUARANTINED","VIPREAV_QUARANTINED_THREAT_REMOVED","VIPREAV_REBOOT_REQUIRED","VIPREAV_SCAN_STARTED","VIPREAV_SCAN_COMPLETED","VIPREAV_SCAN_ABORTED","VIPREAV_SCAN_FAILED","VIPREAV_SCAN_PAUSED","VIPREAV_DISABLED","WEBROOT_COMMAND_SUBMITTED","WEBROOT_THREAT_DETECTED","WEBROOT_INSTALL_FAILED","BITDEFENDER_SCAN_STARTED","BITDEFENDER_SCAN_COMPLETED","BITDEFENDER_THREAT_DELETE_FROM_QUARANTINE","BITDEFENDER_THREAT_RESTORE_FROM_QUARANTINE","BITDEFENDER_SCAN_FAILED","BITDEFENDER_THREAT_DELETE_FROM_QUARANTINE_FAILED","BITDEFENDER_THREAT_RESTORE_FROM_QUARANTINE_FAILED","BITDEFENDER_DOWNLOAD_STARTED","BITDEFENDER_DOWNLOAD_SUCCEEDED","BITDEFENDER_DOWNLOAD_FAILED","BITDEFENDER_INSTALLATION_STARTED","BITDEFENDER_INSTALLATION_SUCCEEDED","BITDEFENDER_INSTALLATION_FAILED","BITDEFENDER_UNINSTALLATION_STARTED","BITDEFENDER_UNINSTALLATION_SUCCEEDED","BITDEFENDER_UNINSTALLATION_FAILED","BITDEFENDER_UNPACKING_FAILED","BDAS_BITDEFENDER_THREAT_IGNORED","BDAS_BITDEFENDER_THREAT_PRESENT","BDAS_BITDEFENDER_THREAT_DELETED","BDAS_BITDEFENDER_THREAT_BLOCKED","BDAS_BITDEFENDER_THREAT_QUARANTINED","BDAS_BITDEFENDER_THREAT_CLEANED","BDAS_BITDEFENDER_PURGE_QUARANTINE_FAILED","BDAS_BITDEFENDER_PURGE_QUARANTINE_SUCCESS","BDAS_BITDEFENDER_THREAT_QUARANTINE_RESTORED","BDAS_BITDEFENDER_THREAT_QUARANTINE_RESTORED_CUSTOMPATH","BDAS_BITDEFENDER_THREAT_QUARANTINE_DELETED","BITDEFENDER_RETRY_INSTALL_COMPLETED","BITDEFENDER_DISABLED","BITDEFENDER_EXISTING_PRODUCT_UNINSTALL","COMPETITOR_EXISTING_PRODUCT_UNINSTALL","SCHEDULE_INSTALL_OPTION_CHANGED","SECURITY_CREDENTIAL_ACCESS_GRANTED","SECURITY_CREDENTIAL_ACCESS_DENIED","PATCH_MANAGEMENT_SCAN_STARTED","PATCH_MANAGEMENT_SCAN_COMPLETED","PATCH_MANAGEMENT_APPLY_PATCH_STARTED","PATCH_MANAGEMENT_APPLY_PATCH_COMPLETED","PATCH_MANAGEMENT_INSTALLED","PATCH_MANAGEMENT_INSTALL_FAILED","PATCH_MANAGEMENT_MESSAGE","PATCH_MANAGEMENT_FAILURE","PATCH_MANAGEMENT_ROLLBACK_PATCH_REQUESTED","PATCH_MANAGEMENT_ROLLBACK_PATCH_STARTED","PATCH_MANAGEMENT_ROLLBACK_PATCH_COMPLETED","PATCH_MANAGEMENT_PATCH_APPROVED","PATCH_MANAGEMENT_PATCH_REJECTED","SOFTWARE_PATCH_MANAGEMENT_SCAN_STARTED","SOFTWARE_PATCH_MANAGEMENT_SCAN_COMPLETED","SOFTWARE_PATCH_MANAGEMENT_APPLY_PATCH_STARTED","SOFTWARE_PATCH_MANAGEMENT_APPLY_PATCH_COMPLETED","SOFTWARE_PATCH_MANAGEMENT_INSTALLED","SOFTWARE_PATCH_MANAGEMENT_INSTALL_FAILED","SOFTWARE_PATCH_MANAGEMENT_MESSAGE","SOFTWARE_PATCH_MANAGEMENT_PATCH_APPROVED","SOFTWARE_PATCH_MANAGEMENT_PATCH_REJECTED","SPLASHTOP_CONNECTION_INITIATED","SPLASHTOP_CONNECTION_ESTABLISHED","SPLASHTOP_CONNECTION_TERMINATED","REMOTE_TOOLS_UPLOAD_FILE_INITIATED","REMOTE_TOOLS_DOWNLOAD_FILE_INITIATED","REMOTE_TOOLS_COMPRESS_FILE_INITIATED","REMOTE_TOOLS_COMPRESS_FILE_SUCCESS","REMOTE_TOOLS_COMPRESS_FILE_FAILED","REMOTE_TOOLS_CREATE_DIRECTORY_INITIATED","REMOTE_TOOLS_RENAME_FILE_INITIATED","REMOTE_TOOLS_DELETE_FILE_INITIATED","REMOTE_TOOLS_MODIFY_OBJECT_SUCCESS","REMOTE_TOOLS_MODIFY_OBJECT_FAILED","REMOTE_TOOLS_COPY_OBJECT_SUCCESS","REMOTE_TOOLS_COPY_OBJECT_FAILED","REMOTE_TOOLS_MOVE_OBJECT_SUCCESS","REMOTE_TOOLS_MOVE_OBJECT_FAILED","REMOTE_TOOLS_DELETE_OBJECT_SUCCESS","REMOTE_TOOLS_DELETE_OBJECT_FAILED","REMOTE_TOOLS_CREATE_DIRECTORY_SUCCESS","REMOTE_TOOLS_CREATE_DIRECTORY_FAILED","REMOTE_TOOLS_FILE_TRANSFER_SUCCESS","REMOTE_TOOLS_FILE_TRANSFER_FAILED","REMOTE_TOOLS_SERVICE_CONTROL_INITIATED","REMOTE_TOOLS_START_SERVICE_SUCCESS","REMOTE_TOOLS_START_SERVICE_FAILED","REMOTE_TOOLS_STOP_SERVICE_SUCCESS","REMOTE_TOOLS_STOP_SERVICE_FAILED","REMOTE_TOOLS_RESTART_SERVICE_SUCCESS","REMOTE_TOOLS_RESTART_SERVICE_FAILED","REMOTE_TOOLS_START_TYPE_CHANGE_SUCCESS","REMOTE_TOOLS_START_TYPE_CHANGE_FAILED","REMOTE_TOOLS_PROCESS_CONTROL_INITIATED","REMOTE_TOOLS_SET_PROCESS_PRIORITY_SUCESS","REMOTE_TOOLS_SET_PROCESS_PRIORITY_FAILED","REMOTE_TOOLS_TERMINATE_PROCESS_SUCCESS","REMOTE_TOOLS_TERMINATE_PROCESS_FAILED","REMOTE_TOOLS_TERMINATE_PROCESS_TREE_SUCCESS","REMOTE_TOOLS_TERMINATE_PROCESS_TREE_FAILED","REMOTE_TOOLS_REGISTRY_CONTROL_INITIATED","REMOTE_TOOLS_CREATE_KEY_SUCCESS","REMOTE_TOOLS_CREATE_KEY_FAILED","REMOTE_TOOLS_RENAME_KEY_SUCCESS","REMOTE_TOOLS_RENAME_KEY_FAILED","REMOTE_TOOLS_DELETE_KEY_SUCCESS","REMOTE_TOOLS_DELETE_KEY_FAILED","REMOTE_TOOLS_CREATE_PARAMETER_SUCCESS","REMOTE_TOOLS_CREATE_PARAMETER_FAILED","REMOTE_TOOLS_RENAME_PARAMETER_SUCCESS","REMOTE_TOOLS_RENAME_PARAMETER_FAILED","REMOTE_TOOLS_DELETE_PARAMETER_SUCCESS","REMOTE_TOOLS_DELETE_PARAMETER_FAILED","REMOTE_TOOLS_MODIFY_PARAMETER_SUCCESS","REMOTE_TOOLS_MODIFY_PARAMETER_FAILED","REMOTE_TOOLS_ACTIVE_DIRECTORY_INITIATED","ADAPTER_ADDED","ADAPTER_REMOVED","ADAPTER_CONFIG_CHANGED","ADAPTER_STATUS_CHANGED","CPU_ADDED","CPU_REMOVED","MEMORY_ADDED","MEMORY_REMOVED","DISK_DRIVE_ADDED","DISK_DRIVE_REMOVED","USER_LOGGED_IN","USER_LOGGED_OUT","PORT_OPENED","PORT_CLOSED","WINDOWS_SERVICE_STARTED","WINDOWS_SERVICE_STOPPED","MAC_DAEMON_STARTED","MAC_DAEMON_STOPPED","USER_ACCOUNT_ADDED","USER_ACCOUNT_REMOVED","PROCESS_STARTED","PROCESS_STOPPED","SYSTEM_REBOOTED","SOFTWARE_ADDED","SOFTWARE_REMOVED","SOFTWARE_UPDATED","SOFTWARE_OS_UPDATED","DISK_PARTITION_ADDED","DISK_PARTITION_REMOVED","DISK_VOLUME_ADDED","DISK_VOLUME_REMOVED","CREDENTIALS_CHANGED","RAID_CONTROLLER_ADDED","RAID_CONTROLLER_REMOVED","RAID_PHYSICAL_DRIVE_ADDED","RAID_PHYSICAL_DRIVE_REMOVED","RAID_LOGICAL_DISK_ADDED","RAID_LOGICAL_DISK_REMOVED","BITLOCKER_ENABLED","BITLOCKER_DISABLED","FILEVAULT_ENABLED","FILEVAULT_DISABLED","TRUSTED_PLATFORM_MODULE_ENABLED","TRUSTED_PLATFORM_MODULE_DISABLED","TRUSTED_PLATFORM_MODULE_INSTALLED","TRUSTED_PLATFORM_MODULE_UNINSTALLED","SHADOWPROTECT_INSTALLED","SHADOWPROTECT_INSTALL_FAILED","SHADOWPROTECT_UNINSTALLED","SHADOWPROTECT_UNINSTALL_FAILED","SHADOWPROTECT_BACKUPJOB_FAILED","SHADOWPROTECT_BACKUPJOB_ABORTED","SHADOWPROTECT_LICENSE_PROVISIONED","SHADOWPROTECT_LICENSE_PROVISION_FAILED","SHADOWPROTECT_LICENSE_ACTIVATED","SHADOWPROTECT_LICENSE_ACTIVATION_FAILED","SHADOWPROTECT_LICENSE_DEACTIVATED","SHADOWPROTECT_LICENSE_DEACTIVATION_FAILED","IMAGEMANAGER_INSTALLED","IMAGEMANAGER_INSTALL_FAILED","IMAGEMANAGER_UNINSTALLED","IMAGEMANAGER_UNINSTALL_FAILED","IMAGEMANAGER_LICENSE_PROVISIONED","IMAGEMANAGER_LICENSE_PROVISION_FAILED","IMAGEMANAGER_LICENSE_ACTIVATED","IMAGEMANAGER_LICENSE_ACTIVATION_FAILED","IMAGEMANAGER_LICENSE_DEACTIVATED","IMAGEMANAGER_LICENSE_DEACTIVATION_FAILED","IMAGEMANAGER_CONSOLIDATION_FAILED","IMAGEMANAGER_VERIFICATION_FAILED","HELP_REQUEST_SUBMITTED","CLOUDBERRY_INSTALLED","CLOUDBERRY_INSTALL_FAILED","CLOUDBERRY_UNINSTALLED","CLOUDBERRY_UNINSTALL_FAILED","CLOUDBERRY_BACKUPPLAN_CREATED","CLOUDBERRY_BACKUPPLAN_EDITED","CLOUDBERRY_BACKUPPLAN_DELETED","CLOUDBERRY_BACKUPPLAN_CREATION_FAILED","CLOUDBERRY_BACKUPJOB_STARTED","CLOUDBERRY_BACKUPJOB_SUCCEEDED","CLOUDBERRY_BACKUPJOB_FAILED","CLOUDBERRY_BACKUPJOB_COMPLETED_WITH_WARNING","CLOUDBERRY_USER_CREATED","CLOUDBERRY_NETWORK_CREDENTIAL_CREATED","CLOUDBERRY_NETWORK_CREDENTIAL_CREATION_FAILED","RDP_CONNECTION_INITIATED","RDP_AUTO_PROVISION","SCHEDULED_TASK_CREATED","SCHEDULED_TASK_UPDATED","SCHEDULED_TASK_DELETED","SCRIPT_CREATED","SCRIPT_UPDATED","SCRIPT_DELETED","NINJA_BACKUP_BACKUPJOB_START_REQUESTED","NINJA_BACKUP_BACKUPJOB_STARTED","NINJA_BACKUP_BACKUPJOB_IN_PROCESS","NINJA_BACKUP_BACKUPJOB_COMPLETED","NINJA_BACKUP_BACKUPJOB_FAILED","NINJA_BACKUP_RESTOREJOB_START_REQUESTED","NINJA_BACKUP_RESTOREJOB_STARTED","NINJA_BACKUP_RESTOREJOB_IN_PROCESS","NINJA_BACKUP_RESTOREJOB_COMPLETED","NINJA_BACKUP_RESTOREJOB_FAILED","NINJA_BACKUP_BACKUPJOB_COMPLETED_WITH_WARNING","NINJA_BACKUP_BACKUP_DOWNLOADED","NINJA_BACKUP_BACKUPPLAN_ADDED","NINJA_BACKUP_BACKUPPLAN_EDITED","NINJA_BACKUP_BACKUPPLAN_DELETED","NINJA_BACKUP_BACKUPJOB_CANCELLED","NINJA_BACKUP_BACKUPJOB_PROCESSING","NINJA_BACKUP_INSTALL_FAILED","NINJA_BACKUP_UNINSTALL_FAILED","NINJA_BACKUP_INSTALLED","NINJA_BACKUP_UNINSTALLED","NINJA_BACKUP_RESTOREJOB_CANCELLED","NINJA_BACKUP_BACKUPPLAN_CREATION_FAILED","NINJA_BACKUP_BACKUP_CONFIGURE_FAILED","NINJA_BACKUP_FILE_DOWNLOAD","NINJA_BACKUP_FOLDER_DOWNLOAD","NINJA_BACKUP_UPSYNCJOB_START_REQUESTED","NINJA_BACKUP_UPSYNCJOB_PROCESSING","NINJA_BACKUP_UPSYNCJOB_IN_PROCESS","NINJA_BACKUP_UPSYNCJOB_STARTED","NINJA_BACKUP_UPSYNCJOB_COMPLETED","NINJA_BACKUP_UPSYNCJOB_CANCELLED","NINJA_BACKUP_UPSYNCJOB_FAILED","NINJA_BACKUP_BACKUP_NAS_ACCESS_FAILED","NINJA_BACKUP_IMAGE_RESTORE_STARTED","NINJA_BACKUP_IMAGE_RESTORE_COMPLETED","NINJA_BACKUP_IMAGE_RESTORE_FAILED","NINJA_BACKUP_IMAGE_DOWNLOAD_STARTED","NINJA_BACKUP_IMAGE_DOWNLOAD_COMPLETED","NINJA_BACKUP_IMAGE_DOWNLOAD_FAILED","NINJA_BACKUP_IMAGE_DOWNLOAD_FILE_STARTED","NINJA_BACKUP_IMAGE_DOWNLOAD_FILE_COMPLETED","NINJA_BACKUP_IMAGE_DOWNLOAD_FILE_FAILED","NINJA_BACKUP_IMAGE_MOUNT_COMPLETED","NINJA_BACKUP_IMAGE_MOUNT_FAILED","NINJA_BACKUP_INTEGRITY_CHECK_START_REQUESTED","NINJA_BACKUP_INTEGRITY_CHECK_STARTED","NINJA_BACKUP_INTEGRITY_CHECK_IN_PROCESS","NINJA_BACKUP_INTEGRITY_CHECK_COMPLETED","NINJA_BACKUP_INTEGRITY_CHECK_FAILED","NINJA_BACKUP_INTEGRITY_CHECK_CANCELLED","NINJA_BACKUP_IMAGE_DOWNLOAD_FOLDER_STARTED","NINJA_BACKUP_IMAGE_DOWNLOAD_FOLDER_COMPLETED","NINJA_BACKUP_IMAGE_DOWNLOAD_FOLDER_FAILED","BACKUP_IMAGE_RESTORE_CANCELED","BACKUP_IMAGE_DOWNLOAD_CANCELED","QC_INVITATION_CREATED","QC_INVITATION_DISABLED","QC_EXPIRED_INVITATION_BLOCKED","QC_INVITATION_UPDATED","QC_DEVICE_DELETED","QC_DEVICE_AGENT_INSTALL_REQUESTED","QC_SESSION_STARTED","QC_SESSION_TERMINATED","QC_SESSION_REPORT_SUBMITTED","REMOTE_SUPPORT_CREATED","REMOTE_SUPPORT_UPDATED","REMOTE_SUPPORT_DELETED","MDM_LOCK_DEVICE_STATUS_CREATED","MDM_REBOOT_DEVICE_STATUS_CREATED","MDM_RESET_PASSCODE_DEVICE_STATUS_CREATED","MDM_RELINQUISH_OWNERSHIP_DEVICE_STATUS_CREATED","MDM_LOCK_DEVICE_STATUS_UPDATED","MDM_REBOOT_DEVICE_STATUS_UPDATED","MDM_RESET_PASSCODE_DEVICE_STATUS_UPDATED","MDM_RELINQUISH_OWNERSHIP_DEVICE_STATUS_UPDATED","MDM_CLEAR_PASSCODE_STATUS_CREATED","MDM_CLEAR_PASSCODE_STATUS_UPDATED","MDM_ERASE_STATUS_CREATED","MDM_ERASE_STATUS_UPDATED","MDM_UPDATE_POLICY_STATUS_CREATED","MDM_UPDATE_POLICY_STATUS_UPDATED","MDM_ASSIGN_POLICY_STATUS_CREATED","MDM_ASSIGN_POLICY_STATUS_UPDATED","MDM_DIVISION_CONFIG_ENABLED","MDM_DIVISION_CONFIG_DISABLED","MDM_DIVISION_CONFIG_UPDATED","MDM_APN_CERTIFICATE_UPLOADED","MDM_ACTION_DEVICE_STATUS_FAILED","MDM_DISOWN_STATUS_FORBIDDEN","MDM_DISOWN_STATUS_COMPLETED","MDM_ADE_TOKEN_UPLOADED","MDM_ADE_TOKEN_RENEWED","MDM_RENEW_ENROLLMENT_PROFILE_STATUS_CREATED","MDM_RENEW_ENROLLMENT_PROFILE_STATUS_UPDATED","MDM_INSTALL_APP_STATUS_CREATED","MDM_APN_CERTIFICATE_RENEWED","MDM_CONNECTION_ANDROID_ENTERPRISE_RENAME_SUCCESS","MDM_CLEAR_APP_DATA_STATUS_CREATED","MDM_CLEAR_APP_DATA_STATUS_UPDATED","AOSP_ERASE_DEVICE_STATUS_CREATED","AOSP_ERASE_DEVICE_STATUS_COMPLETED","AOSP_LOCK_DEVICE_STATUS_CREATED","AOSP_LOCK_DEVICE_STATUS_UPDATED","AOSP_REBOOT_DEVICE_STATUS_CREATED","AOSP_REBOOT_DEVICE_STATUS_COMPLETED","AOSP_RESET_PASSCODE_DEVICE_STATUS_CREATED","AOSP_RESET_PASSCODE_DEVICE_STATUS_COMPLETED","AOSP_UPDATE_POLICY_STATUS_UPDATED","AOSP_NC_SESSION_REQUESTED","AOSP_NC_SESSION_STARTED","AOSP_NC_SESSION_TERMINATED","REPORT_TEMPLATE_CREATED","REPORT_TEMPLATE_UPDATED","REPORT_TEMPLATE_DELETED","REPORT_SCHEDULE_CREATED","REPORT_SCHEDULE_UPDATED","REPORT_SCHEDULE_DELETED","REPORT_TEMPLATE_DUPLICATED","REPORT_SCHEDULE_DUPLICATED","GRAVITYZONE_ENABLED","GRAVITYZONE_DISABLED","GRAVITYZONE_SCAN_STARTED","GRAVITYZONE_SCAN_COMPLETED","GRAVITYZONE_SCAN_FAILED","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE_FAILED","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE_FAILED","GRAVITYZONE_INSTALLATION_SUCCEEDED","GRAVITYZONE_INSTALLATION_SUCCEEDED_WITH_WARNINGS","GRAVITYZONE_INSTALLATION_FAILED","GRAVITYZONE_THREAT_IGNORED","GRAVITYZONE_THREAT_PRESENT","GRAVITYZONE_THREAT_DELETED","GRAVITYZONE_THREAT_BLOCKED","GRAVITYZONE_THREAT_REPORTED","GRAVITYZONE_THREAT_QUARANTINED","GRAVITYZONE_THREAT_CLEANED","GRAVITYZONE_PURGE_QUARANTINE_FAILED","GRAVITYZONE_PURGE_QUARANTINE_SUCCESS","GRAVITYZONE_THREAT_RESTORE_AND_EXCLUDED_FROM_QUARANTINE","GRAVITYZONE_THREAT_RESTORE_AND_EXCLUDED_FROM_QUARANTINE_FAILED","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE_COMPLETED","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE_COMPLETED","GRAVITYZONE_PROVISION_COMPLETED","GRAVITYZONE_PROVISION_FAILED","GRAVITYZONE_RETRY_INSTALL_COMPLETED","GRAVITYZONE_PARTNER_ASSIST_DISABLED","GRAVITYZONE_SCAN_ATTEMPT_COMPLETED","GRAVITYZONE_RESET_INACCESSIBLE_LICENSE_COMPLETED","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE_REQUESTED","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE_REQUESTED","GRAVITYZONE_THREAT_RESTORE_AND_EXCLUDED_FROM_QUARANTINE_REQUESTED","GRAVITYZONE_INSTALLATION_STARTED","GRAVITYZONE_DOWNLOAD_FAILED","GRAVITYZONE_INSTALLATION_RETRY_STARTED","GRAVITYZONE_SCAN_CANCELLED","GRAVITYZONE_DISABLING_FAILED","GRAVITYZONE_INSTALLATION_EXISTS_DETECTED","GRAVITYZONE_THREAT_BLOCKED_FROM_ACTIVE_REQUESTED","GRAVITYZONE_THREAT_BLOCKED_FROM_ACTIVE_COMPLETED","GRAVITYZONE_THREAT_BLOCKED_FROM_ACTIVE_FAILED","GRAVITYZONE_DEVICE_MANAGED","GRAVITYZONE_DEVICE_UNMANAGED","GRAVITYZONE_COMPANY_CANNOT_BE_ACCESSED","GRAVITYZONE_QUARANTINED_THREAT_DELETED_OR_RESTORED","GRAVITYZONE_SUCCEEDED_TO_REQUEST_RECONFIGURE_TASK","GRAVITYZONE_FAILED_TO_REQUEST_RECONFIGURE_TASK","GRAVITYZONE_ADVANCED_THREAT_DISINFECTED","GRAVITYZONE_ADVANCED_THREAT_BLOCKED","GRAVITYZONE_INCIDENT_REPORTED","GRAVITYZONE_INCIDENT_VISIBILITY_FLAG_UPDATED","GRAVITYZONE_EXTENDED_INCIDENT_REPORTED","GRAVITYZONE_THREAT_STILL_PRESENT_AFTER_SCAN","ATTACHMENT_FILE_SUSPICIOUS","SMTP_SEND_ERROR","TECHNICIAN_ROLE_CREATED","TECHNICIAN_ROLE_UPDATED","TECHNICIAN_ROLE_DELETED","TECHNICIAN_ROLE_ASSIGNMENT_CHANGED","TECHNICIAN_PERMISSIONS_CHANGED","END_USER_ROLE_CREATED","END_USER_ROLE_UPDATED","END_USER_ROLE_DELETED","END_USER_ROLE_ASSIGNMENT_CHANGED","END_USER_PERMISSIONS_CHANGED","SENTINEL_ONE_AGENT_ENABLED","SENTINEL_ONE_AGENT_DISABLED","SENTINEL_ONE_AGENT_STARTED","SENTINEL_ONE_AGENT_UPGRADED","SENTINEL_ONE_AGENT_SHUT_DOWN","SENTINEL_ONE_AGENT_INSTALLATION_SUCCEEDED","SENTINEL_ONE_INSTALLATION_ANOTHER_AV_DETECTED","SENTINEL_ONE_AGENT_INSTALLATION_FAILED","SENTINEL_ONE_POLICY_CHANGED","SENTINEL_ONE_LOCAL_CONFIG_CHANGE_FAILED","SENTINEL_ONE_REGISTRATION_SUCCEEDED","SENTINEL_ONE_REGISTRATION_FAILED","SENTINEL_ONE_REMEDIATION_SUCCEEDED","SENTINEL_ONE_REMEDIATION_FAILED","SENTINEL_ONE_MITIGATION_SUCCEEDED","SENTINEL_ONE_MITIGATION_FAILED","SENTINEL_ONE_MITIGATION_REQUIRE_REBOOT","SENTINEL_ONE_MITIGATION_CANNOT_KILL","SENTINEL_ONE_MITIGATION_FAILED_TO_KILL","SENTINEL_ONE_QUARANTINE_SUCCEEDED","SENTINEL_ONE_QUARANTINE_FAILED","SENTINEL_ONE_UNQUARANTINE_SUCCEEDED","SENTINEL_ONE_UNQUARANTINE_FAILED","SENTINEL_ONE_THREAT_DETECTED","SENTINEL_ONE_SCAN_STARTED","SENTINEL_ONE_SCAN_COMPLETED","SENTINEL_ONE_SCAN_FAILED","SENTINEL_ONE_SCAN_ABORTED","SENTINEL_ONE_COMMAND_RECEIVED","SENTINEL_ONE_COMMAND_FAILED","SENTINEL_ONE_AGENT_UPGRADE_SUCCEEDED","SENTINEL_ONE_SITE_TOKEN_REGENERATED","SENTINEL_ONE_ON_DEMAND_SCAN_STARTED","SENTINEL_ONE_ON_DEMAND_SCAN_COMPLETED","SENTINEL_ONE_ON_DEMAND_SCAN_ABORTED","SENTINEL_ONE_RETRY_INSTALL_COMPLETED","SENTINEL_ONE_REFRESH_API_TOKEN_SUCCEEDED","SENTINEL_ONE_REFRESH_API_TOKEN_FAILED","SENTINEL_ONE_INTEGRATION_ENABLED","SENTINEL_ONE_INTEGRATION_DISABLED","SENTINEL_ONE_INTEGRATION_CREDENTIALS_UPDATED","SENTINEL_ONE_INTEGRATION_RESYNC_INITIATED","SENTINEL_ONE_INTEGRATION_RESYNC_REQUIRED","SENTINEL_ONE_EXISTING_INSTALLATION_DETECTED","SENTINEL_ONE_AGENT_SYNC_SUCCESS","SENTINEL_ONE_AGENT_SYNC_FAILED_RETRY","SENTINEL_ONE_AGENT_SYNC_FAILED","SENTINEL_ONE_AGENT_SYNC_CANCELLED","SENTINEL_ONE_AGENT_SYNC_MAPPING_FAILED","OAUTH2_CREATED","OAUTH2_UPDATED","OAUTH2_DELETED","CROWDSTRIKE_SENSOR_ENABLED","CROWDSTRIKE_SENSOR_DISABLED","CROWDSTRIKE_SENSOR_STARTED","CROWDSTRIKE_SENSOR_UPGRADED","CROWDSTRIKE_SENSOR_SHUT_DOWN","CROWDSTRIKE_SENSOR_INSTALLATION_SUCCEEDED","CROWDSTRIKE_SENSOR_INSTALLATION_FAILED","CROWDSTRIKE_REGISTRATION_SUCCEEDED","CROWDSTRIKE_REGISTRATION_FAILED","CROWDSTRIKE_REMEDIATION_SUCCEEDED","CROWDSTRIKE_REMEDIATION_FAILED","CROWDSTRIKE_MITIGATION_SUCCEEDED","CROWDSTRIKE_MITIGATION_FAILED","CROWDSTRIKE_QUARANTINE_SUCCEEDED","CROWDSTRIKE_QUARANTINE_FAILED","CROWDSTRIKE_THREAT_DETECTED","CROWDSTRIKE_MISSING_PERMISSIONS","CROWDSTRIKE_CREDENTIAL_INVALID","CROWDSTRIKE_INSTALLATION_ANOTHER_AV_DETECTED","CROWDSTRIKE_ENABLED","CROWDSTRIKE_DISABLED","CROWDSTRIKE_CREDENTIALS_UPDATED","CROWDSTRIKE_EXISTING_INSTALLATION_DETECTED","CROWDSTRIKE_RETRY_INSTALL_COMPLETED","CROWDSTRIKE_MISSING_API_CLIENT_SCOPE","CROWDSTRIKE_PARTNER_PROVISION_IN_PROGRESS","CROWDSTRIKE_PARTNER_PROVISION_COMPLETED","CROWDSTRIKE_PARTNER_PROVISION_FAILED","CROWDSTRIKE_CUSTOMER_PROVISION_IN_PROGRESS","CROWDSTRIKE_CUSTOMER_PROVISION_COMPLETED","CROWDSTRIKE_CUSTOMER_PROVISION_FAILED","CROWDSTRIKE_FALCON_COMPLETE_CREDENTIAL_INVALID","CROWDSTRIKE_MISSING_FALCON_COMPLETE_API_CLIENT_SCOPE","CROWDSTRIKE_UNMANAGED_INSTALLATION_DETECTED","CROWDSTRIKE_SENSOR_PROVISIONING","CROWDSTRIKE_SENSOR_MIGRATED","CROWDSTRIKE_CUSTOMER_BUNDLE_UPDATED","CROWDSTRIKE_CREDENTIAL_UNHEALTHY","CROWDSTRIKE_CREDENTIAL_VALIDATED","CROWDSTRIKE_FALCON_COMPLETE_CREDENTIAL_UNHEALTHY","CROWDSTRIKE_FALCON_COMPLETE_CREDENTIAL_VALIDATED","SERVICE_NOW_UPDATED","SERVICE_NOW_CONFIGURATION_ITEM_CLASS_MAPPING_CREATED","SERVICE_NOW_CONFIGURATION_ITEM_CLASS_MAPPING_UPDATED","SERVICE_NOW_CONFIGURATION_ITEM_CLASS_MAPPING_DELETED","SERVICE_NOW_RESET_AUTHENTICATION","SERVICE_NOW_NODE_SYNC_NODE_CREATED","SERVICE_NOW_NODE_SYNC_NODE_UPDATED","SERVICE_NOW_NODE_SYNC_NODE_ERROR","SERVICE_NOW_NODE_SYNC_BY_CLIENT_STARTED","SERVICE_NOW_NODE_SYNC_BY_CLIENT_COMPLETED","SERVICE_NOW_CLIENT_MAPPING_CREATED","SERVICE_NOW_CLIENT_MAPPING_UPDATED","SERVICE_NOW_CLIENT_MAPPING_DELETED","SERVICE_NOW_SYNC_CLIENT_ON_DEMAND","SERVICE_NOW_CLIENT_MAPPING_STATUS_UPDATED","ZENDESK_UPDATED","FRESHSERVICE_UPDATED","NINJA_TICKETING_CREATION_FAILED","NINJA_TICKETING_FORM_CREATED","NINJA_TICKETING_FORM_UPDATED","NINJA_TICKETING_FORM_ACTIVED","NINJA_TICKETING_FORM_DEACTIVED","NINJA_TICKETING_ATTRIBUTE_CREATED","NINJA_TICKETING_ATTRIBUTE_UPDATED","NINJA_TICKETING_ATTRIBUTE_ACTIVED","NINJA_TICKETING_ATTRIBUTE_DEACTIVATED","NINJA_TICKETING_RULESET_CREATED","NINJA_TICKETING_RULESET_UPDATED","NINJA_TICKETING_RULESET_DELETED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_CREATED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_UPDATED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_DELETED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_MAKE_DEFAULT","NINJA_TICKETING_TRIGGER_CREATED","NINJA_TICKETING_TRIGGER_UPDATED","NINJA_TICKETING_TRIGGER_DELETED","NINJA_TICKETING_TICKET_CREATED","NINJA_TICKETING_TICKET_DELETED","NINJA_TICKETING_PENDING_EMAIL_CREATION_APPROVED","NINJA_TICKETING_PENDING_EMAIL_UPDATE_APPROVED","NINJA_TICKETING_PENDING_EMAIL_REJECTED","NINJA_TICKETING_ENABLED","NINJA_TICKETING_DISABLED","NINJA_TICKETING_UPDATED","NINJA_TICKETING_FORM_MAKE_DEFAULT","NINJA_TICKETING_CONDITION_RULE_MAKE_DEFAULT","NINJA_TICKETING_SCRIPT_RULE_MAKE_DEFAULT","NINJA_TICKETING_PENDING_EMAIL_RECEIVED","NINJA_TICKETING_EMAIL_ALLOWLIST_ITEM_CREATED","NINJA_TICKETING_EMAIL_ALLOWLIST_ITEM_UPDATED","NINJA_TICKETING_EMAIL_ALLOWLIST_ITEM_DELETED","NINJA_TICKETING_EMAIL_BLOCKLIST_ITEM_CREATED","NINJA_TICKETING_EMAIL_BLOCKLIST_ITEM_UPDATED","NINJA_TICKETING_EMAIL_BLOCKLIST_ITEM_DELETED","NINJA_TICKETING_TICKET_REINSTATED","NINJA_TICKETING_STATUS_CREATED","NINJA_TICKETING_STATUS_UPDATED","NINJA_TICKETING_STATUS_DELETED","NINJA_TICKETING_AGREEMENT_BULK_UPDATED","KNOWLEDGE_BASE_DOCUMENT_CREATED","KNOWLEDGE_BASE_DOCUMENT_UPDATED","KNOWLEDGE_BASE_DOCUMENT_ARCHIVED","KNOWLEDGE_BASE_DOCUMENT_RESTORED","KNOWLEDGE_BASE_DOCUMENT_DELETED","KNOWLEDGE_BASE_FOLDER_CREATED","KNOWLEDGE_BASE_FOLDER_UPDATED","KNOWLEDGE_BASE_FOLDER_ARCHIVED","KNOWLEDGE_BASE_FOLDER_RESTORED","KNOWLEDGE_BASE_FOLDER_DELETED","KNOWLEDGE_BASE_PUBLIC_TEMPORARY_TOKEN_CREATED","KNOWLEDGE_BASE_PUBLIC_LINK_CREATED","KNOWLEDGE_BASE_PUBLIC_LINK_UPDATED","KNOWLEDGE_BASE_PUBLIC_LINK_DELETED","KNOWLEDGE_BASE_FOLDER_MOVED","KNOWLEDGE_BASE_DOCUMENT_MOVED","KNOWLEDGE_BASE_FOLDER_SHARED","KNOWLEDGE_BASE_FOLDER_ACCESS_RESTRICTED","DOCUMENT_TEMPLATE_CREATED","DOCUMENT_TEMPLATE_UPDATED","DOCUMENT_TEMPLATE_ARCHIVED","DOCUMENT_TEMPLATE_RESTORED","DOCUMENT_TEMPLATE_DELETED","CLIENT_DOCUMENT_CREATED","CLIENT_DOCUMENT_UPDATED","CLIENT_DOCUMENT_ARCHIVED","CLIENT_DOCUMENT_RESTORED","CLIENT_DOCUMENT_DELETED","CLIENT_DOCUMENT_ATTRIBUTE_VALUE_DECRYPTED","CLIENT_DOCUMENT_REVISION_DELETED","CLIENT_DOCUMENTATION_DELEGATE_NODE_RESPONSIBILITY_ADDED","CLIENT_DOCUMENTATION_DELEGATE_NODE_RESPONSIBILITY_REMOVED","CLIENT_DOCUMENT_ATTRIBUTE_TEMPORARY_PUBLIC_TOKEN_CREATED","CLIENT_CHECKLIST_CREATED","CLIENT_CHECKLIST_UPDATED","CLIENT_CHECKLIST_DELETED","CLIENT_CHECKLIST_PROMOTED","CLIENT_CHECKLIST_TEMPORARY_PUBLIC_TOKEN_CREATED","CLIENT_CHECKLIST_ARCHIVED","CLIENT_CHECKLIST_RESTORED","CHECKLIST_TEMPLATE_CREATED","CHECKLIST_TEMPLATE_UPDATED","CHECKLIST_TEMPLATE_DELETED","CHECKLIST_TEMPLATE_ARCHIVED","CHECKLIST_TEMPLATE_RESTORED","RELATED_ITEM_CREATED","RELATED_ITEM_UPDATED","RELATED_ITEM_DELETED","RELATED_ITEM_SECURE_VALUE_DECRYPTED","RELATED_ITEM_TEMPORARY_PUBLIC_TOKEN_CREATED","ANTIVIRUS_THREAT_MUTED","ANTIVIRUS_THREAT_UNMUTED","SUPPLIER_CREATED","SUPPLIER_UPDATED","SUPPLIER_DELETED","MAINTENANCE_MODE_CONFIGURED","MAINTENANCE_MODE_DELETED","MAINTENANCE_MODE_MODIFIED","MAINTENANCE_MODE_FAILED","MAINTENANCE_MODE_ACTIVE","MAINTENANCE_MODE_UPDATED","MAINTENANCE_MODE_COMPLETED","SIEM_EXPORTER_WEBHOOK_CREATED","SIEM_EXPORTER_WEBHOOK_DELETED","SIEM_EXPORTER_WEBHOOK_ENABLED","SIEM_EXPORTER_WEBHOOK_DISABLED","SIEM_EXPORTER_WEBHOOK_UPDATED","SIEM_EXPORTER_WEBHOOK_DISPATCH_FAILURE","SIEM_EXPORTER_ENABLED","SIEM_EXPORTER_DISABLED"]},"status":{"type":"string","description":"Status description"},"activityResult":{"type":"string","description":"Activity result","enum":["SUCCESS","FAILURE","UNSUPPORTED","UNCOMPLETED","MISSED"]},"sourceConfigUid":{"type":"string","description":"Source configuration/policy element reference","format":"uuid"},"sourceName":{"type":"string","description":"Source configuration/policy element name"},"subject":{"type":"string","description":"Activity subject"},"userId":{"type":"integer","description":"User identifier","format":"int32"},"message":{"type":"string","description":"Activity message"},"type":{"type":"string","description":"Activity type description"},"data":{"type":"object","additionalProperties":true,"description":"Activity data"}}},"NodeActivitiesResponse":{"type":"object","properties":{"lastActivityId":{"type":"integer","description":"Last recorded activity ID for account","format":"int64"},"activities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Activity identifier","format":"int64"},"activityTime":{"type":"number","description":"Activity timestamp","format":"double"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"severity":{"type":"string","description":"Severity","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"]},"priority":{"type":"string","description":"Priority","enum":["NONE","LOW","MEDIUM","HIGH"]},"seriesUid":{"type":"string","description":"Activity series UID (job/condition UID)","format":"uuid"},"activityType":{"type":"string","description":"Activity type code","enum":["ACTIONSET","ACTION","CONDITION","CONDITION_ACTIONSET","CONDITION_ACTION","ANTIVIRUS","PATCH_MANAGEMENT","TEAMVIEWER","MONITOR","SYSTEM","COMMENT","SHADOWPROTECT","IMAGEMANAGER","HELP_REQUEST","SOFTWARE_PATCH_MANAGEMENT","SPLASHTOP","CLOUDBERRY","CLOUDBERRY_BACKUP","SCHEDULED_TASK","RDP","SCRIPTING","SECURITY","REMOTE_TOOLS","VIRTUALIZATION","PSA","MDM","NINJA_REMOTE","NINJA_QUICK_CONNECT","NINJA_NETWORK_DISCOVERY","NINJA_BACKUP","NINJA_TICKETING","KNOWLEDGE_BASE","RELATED_ITEM","CLIENT_CHECKLIST","CHECKLIST_TEMPLATE","DOCUMENTATION","MICROSOFT_INTUNE","DYNAMIC_POLICY","MAINTENANCE_MODE","AOSP_ACTION","AOSP_POLICY","AOSP"]},"statusCode":{"type":"string","description":"Activity status code","enum":["START_REQUESTED","STARTED","IN_PROCESS","COMPLETED","CANCEL_REQUESTED","CANCELLED","BLOCKED","QUEUED","TRIGGERED","RESET","ACKNOWLEDGED","DISABLED","EVALUATION_FAILURE","CLIENT_CREATED","CLIENT_UPDATED","CLIENT_DELETED","CREDENTIAL_CREATED","CREDENTIAL_UPDATED","CREDENTIAL_DELETED","LOCATION_CREATED","LOCATION_UPDATED","LOCATION_DELETED","POLICY_CREATED","POLICY_UPDATED","POLICY_DELETED","NODE_CREATED","NODE_UPDATED","NODE_DELETED","NODE_RE_ENROLLED","NODE_ACCESS_GRANTED","NODE_ACCESS_DENIED","NODE_REGISTRATION_REJECTED","NODE_IDENTIFICATION_UPDATED","NODE_CLONING_DETECTED","NODE_CLONE_ADVISED_TO_REGISTER","NODE_MANUALLY_APPROVED","NODE_AUTOMATICALLY_APPROVED","NODE_MANUALLY_REJECTED","NODE_AUTOMATICALLY_REJECTED","REJECTED_NODE_CLEARED","REJECTED_NODE_DELETED","MOBILE_DEVICE_UNREGISTERED","APP_USER_CREATED","APP_USER_UPDATED","APP_USER_DELETED","APP_USER_LOGGED_IN","APP_USER_LOGGED_OUT","APP_USER_MFA_SETUP","APP_USER_MFA_DELETED","APP_USER_CRITICAL_ACTION","APP_USER_AUDIT_FAILED_LOGIN","APP_USER_AUTO_ASSIGN_CHANGED","END_USER_CREATED","END_USER_CREATED_API","END_USER_UPDATED","END_USER_UPDATED_API","END_USER_DELETED","END_USER_DELETED_API","END_USER_LOGGED_IN","END_USER_LOGGED_OUT","END_USER_MFA_SETUP","END_USER_MFA_DELETED","END_USER_AUDIT_FAILED_LOGIN","END_USER_CRITICAL_ACTION","CONTACT_CREATED","CONTACT_CREATED_API","CONTACT_UPDATED","CONTACT_UPDATED_API","CONTACT_DELETED","CONTACT_DELETED_API","DEVICE_GROUP_CREATED","DEVICE_GROUP_UPDATED","DEVICE_GROUP_DELETED","TICKET_TEMPLATE_CREATED","TICKET_TEMPLATE_UPDATED","TICKET_TEMPLATE_DELETED","CUSTOM_HEALTH_STATUS_CHANGED","CUSTOM_HEALTH_STATUS_RESET","PSA_TICKET_CREATION_FAILED","PSA_TICKET_CREATION_SUCCEEDED","RESET_BY_PSA_TICKET_CALLBACK","PSA_TICKET_CREATION_TEST","PSA_ENABLED","PSA_DISABLED","PSA_CREDENTIALS_FAILED","CONNECTWISE_AGREEMENTS_SYNC_COMPLETED","CONNECTWISE_AGREEMENTS_SYNC_STARTED","CONNECTWISE_NODE_SYNC_COMPLETED","CONNECTWISE_NODE_SYNC_STARTED","CONNECTWISE_NODE_SYNC_NODE_CREATED","CONNECTWISE_NODE_SYNC_NODE_UPDATED","CONNECTWISE_NODE_SYNC_NODE_DELETED","CONNECTWISE_UPDATED","CONNECTWISECONTROL_ATTEMPT","AUTOTASK_NODE_SYNC_STARTED","AUTOTASK_NODE_SYNC_COMPLETED","AUTOTASK_NODE_SYNC_NODE_CREATED","AUTOTASK_NODE_SYNC_NODE_UPDATED","AUTOTASK_NODE_SYNC_NODE_DELETED","AUTOTASK_UPDATED","AUTOTASK_ATTACHMENT_FAILURE","PSA_TICKET_UPDATED_FAILED","PSA_TICKET_UPDATED_SUCCEEDED","REPORT_CREATED","REPORT_UPDATED","REPORT_DELETED","TIME_ZONE_UPDATED","LANGUAGE_TAG_UPDATED","NODE_ROLE_CREATED","NODE_ROLE_UPDATED","NODE_ROLE_DELETED","COMMENT","VIPREAV_INSTALLED","VIPREAV_INSTALL_FAILED","VIPREAV_UNINSTALLED","VIPREAV_UNINSTALL_FAILED","VIPREAV_SCAN_THREAT_QUARANTINED","VIPREAV_ACTIVEPROTECTION_THREAT_QUARANTINED","VIPREAV_USERINITIATED_THREAT_QUARANTINED","VIPREAV_QUARANTINED_THREAT_REMOVED","VIPREAV_REBOOT_REQUIRED","VIPREAV_SCAN_STARTED","VIPREAV_SCAN_COMPLETED","VIPREAV_SCAN_ABORTED","VIPREAV_SCAN_FAILED","VIPREAV_SCAN_PAUSED","VIPREAV_DISABLED","WEBROOT_COMMAND_SUBMITTED","WEBROOT_THREAT_DETECTED","WEBROOT_INSTALL_FAILED","BITDEFENDER_SCAN_STARTED","BITDEFENDER_SCAN_COMPLETED","BITDEFENDER_THREAT_DELETE_FROM_QUARANTINE","BITDEFENDER_THREAT_RESTORE_FROM_QUARANTINE","BITDEFENDER_SCAN_FAILED","BITDEFENDER_THREAT_DELETE_FROM_QUARANTINE_FAILED","BITDEFENDER_THREAT_RESTORE_FROM_QUARANTINE_FAILED","BITDEFENDER_DOWNLOAD_STARTED","BITDEFENDER_DOWNLOAD_SUCCEEDED","BITDEFENDER_DOWNLOAD_FAILED","BITDEFENDER_INSTALLATION_STARTED","BITDEFENDER_INSTALLATION_SUCCEEDED","BITDEFENDER_INSTALLATION_FAILED","BITDEFENDER_UNINSTALLATION_STARTED","BITDEFENDER_UNINSTALLATION_SUCCEEDED","BITDEFENDER_UNINSTALLATION_FAILED","BITDEFENDER_UNPACKING_FAILED","BDAS_BITDEFENDER_THREAT_IGNORED","BDAS_BITDEFENDER_THREAT_PRESENT","BDAS_BITDEFENDER_THREAT_DELETED","BDAS_BITDEFENDER_THREAT_BLOCKED","BDAS_BITDEFENDER_THREAT_QUARANTINED","BDAS_BITDEFENDER_THREAT_CLEANED","BDAS_BITDEFENDER_PURGE_QUARANTINE_FAILED","BDAS_BITDEFENDER_PURGE_QUARANTINE_SUCCESS","BDAS_BITDEFENDER_THREAT_QUARANTINE_RESTORED","BDAS_BITDEFENDER_THREAT_QUARANTINE_RESTORED_CUSTOMPATH","BDAS_BITDEFENDER_THREAT_QUARANTINE_DELETED","BITDEFENDER_RETRY_INSTALL_COMPLETED","BITDEFENDER_DISABLED","BITDEFENDER_EXISTING_PRODUCT_UNINSTALL","COMPETITOR_EXISTING_PRODUCT_UNINSTALL","SCHEDULE_INSTALL_OPTION_CHANGED","SECURITY_CREDENTIAL_ACCESS_GRANTED","SECURITY_CREDENTIAL_ACCESS_DENIED","PATCH_MANAGEMENT_SCAN_STARTED","PATCH_MANAGEMENT_SCAN_COMPLETED","PATCH_MANAGEMENT_APPLY_PATCH_STARTED","PATCH_MANAGEMENT_APPLY_PATCH_COMPLETED","PATCH_MANAGEMENT_INSTALLED","PATCH_MANAGEMENT_INSTALL_FAILED","PATCH_MANAGEMENT_MESSAGE","PATCH_MANAGEMENT_FAILURE","PATCH_MANAGEMENT_ROLLBACK_PATCH_REQUESTED","PATCH_MANAGEMENT_ROLLBACK_PATCH_STARTED","PATCH_MANAGEMENT_ROLLBACK_PATCH_COMPLETED","PATCH_MANAGEMENT_PATCH_APPROVED","PATCH_MANAGEMENT_PATCH_REJECTED","SOFTWARE_PATCH_MANAGEMENT_SCAN_STARTED","SOFTWARE_PATCH_MANAGEMENT_SCAN_COMPLETED","SOFTWARE_PATCH_MANAGEMENT_APPLY_PATCH_STARTED","SOFTWARE_PATCH_MANAGEMENT_APPLY_PATCH_COMPLETED","SOFTWARE_PATCH_MANAGEMENT_INSTALLED","SOFTWARE_PATCH_MANAGEMENT_INSTALL_FAILED","SOFTWARE_PATCH_MANAGEMENT_MESSAGE","SOFTWARE_PATCH_MANAGEMENT_PATCH_APPROVED","SOFTWARE_PATCH_MANAGEMENT_PATCH_REJECTED","SPLASHTOP_CONNECTION_INITIATED","SPLASHTOP_CONNECTION_ESTABLISHED","SPLASHTOP_CONNECTION_TERMINATED","REMOTE_TOOLS_UPLOAD_FILE_INITIATED","REMOTE_TOOLS_DOWNLOAD_FILE_INITIATED","REMOTE_TOOLS_COMPRESS_FILE_INITIATED","REMOTE_TOOLS_COMPRESS_FILE_SUCCESS","REMOTE_TOOLS_COMPRESS_FILE_FAILED","REMOTE_TOOLS_CREATE_DIRECTORY_INITIATED","REMOTE_TOOLS_RENAME_FILE_INITIATED","REMOTE_TOOLS_DELETE_FILE_INITIATED","REMOTE_TOOLS_MODIFY_OBJECT_SUCCESS","REMOTE_TOOLS_MODIFY_OBJECT_FAILED","REMOTE_TOOLS_COPY_OBJECT_SUCCESS","REMOTE_TOOLS_COPY_OBJECT_FAILED","REMOTE_TOOLS_MOVE_OBJECT_SUCCESS","REMOTE_TOOLS_MOVE_OBJECT_FAILED","REMOTE_TOOLS_DELETE_OBJECT_SUCCESS","REMOTE_TOOLS_DELETE_OBJECT_FAILED","REMOTE_TOOLS_CREATE_DIRECTORY_SUCCESS","REMOTE_TOOLS_CREATE_DIRECTORY_FAILED","REMOTE_TOOLS_FILE_TRANSFER_SUCCESS","REMOTE_TOOLS_FILE_TRANSFER_FAILED","REMOTE_TOOLS_SERVICE_CONTROL_INITIATED","REMOTE_TOOLS_START_SERVICE_SUCCESS","REMOTE_TOOLS_START_SERVICE_FAILED","REMOTE_TOOLS_STOP_SERVICE_SUCCESS","REMOTE_TOOLS_STOP_SERVICE_FAILED","REMOTE_TOOLS_RESTART_SERVICE_SUCCESS","REMOTE_TOOLS_RESTART_SERVICE_FAILED","REMOTE_TOOLS_START_TYPE_CHANGE_SUCCESS","REMOTE_TOOLS_START_TYPE_CHANGE_FAILED","REMOTE_TOOLS_PROCESS_CONTROL_INITIATED","REMOTE_TOOLS_SET_PROCESS_PRIORITY_SUCESS","REMOTE_TOOLS_SET_PROCESS_PRIORITY_FAILED","REMOTE_TOOLS_TERMINATE_PROCESS_SUCCESS","REMOTE_TOOLS_TERMINATE_PROCESS_FAILED","REMOTE_TOOLS_TERMINATE_PROCESS_TREE_SUCCESS","REMOTE_TOOLS_TERMINATE_PROCESS_TREE_FAILED","REMOTE_TOOLS_REGISTRY_CONTROL_INITIATED","REMOTE_TOOLS_CREATE_KEY_SUCCESS","REMOTE_TOOLS_CREATE_KEY_FAILED","REMOTE_TOOLS_RENAME_KEY_SUCCESS","REMOTE_TOOLS_RENAME_KEY_FAILED","REMOTE_TOOLS_DELETE_KEY_SUCCESS","REMOTE_TOOLS_DELETE_KEY_FAILED","REMOTE_TOOLS_CREATE_PARAMETER_SUCCESS","REMOTE_TOOLS_CREATE_PARAMETER_FAILED","REMOTE_TOOLS_RENAME_PARAMETER_SUCCESS","REMOTE_TOOLS_RENAME_PARAMETER_FAILED","REMOTE_TOOLS_DELETE_PARAMETER_SUCCESS","REMOTE_TOOLS_DELETE_PARAMETER_FAILED","REMOTE_TOOLS_MODIFY_PARAMETER_SUCCESS","REMOTE_TOOLS_MODIFY_PARAMETER_FAILED","REMOTE_TOOLS_ACTIVE_DIRECTORY_INITIATED","ADAPTER_ADDED","ADAPTER_REMOVED","ADAPTER_CONFIG_CHANGED","ADAPTER_STATUS_CHANGED","CPU_ADDED","CPU_REMOVED","MEMORY_ADDED","MEMORY_REMOVED","DISK_DRIVE_ADDED","DISK_DRIVE_REMOVED","USER_LOGGED_IN","USER_LOGGED_OUT","PORT_OPENED","PORT_CLOSED","WINDOWS_SERVICE_STARTED","WINDOWS_SERVICE_STOPPED","MAC_DAEMON_STARTED","MAC_DAEMON_STOPPED","USER_ACCOUNT_ADDED","USER_ACCOUNT_REMOVED","PROCESS_STARTED","PROCESS_STOPPED","SYSTEM_REBOOTED","SOFTWARE_ADDED","SOFTWARE_REMOVED","SOFTWARE_UPDATED","SOFTWARE_OS_UPDATED","DISK_PARTITION_ADDED","DISK_PARTITION_REMOVED","DISK_VOLUME_ADDED","DISK_VOLUME_REMOVED","CREDENTIALS_CHANGED","RAID_CONTROLLER_ADDED","RAID_CONTROLLER_REMOVED","RAID_PHYSICAL_DRIVE_ADDED","RAID_PHYSICAL_DRIVE_REMOVED","RAID_LOGICAL_DISK_ADDED","RAID_LOGICAL_DISK_REMOVED","BITLOCKER_ENABLED","BITLOCKER_DISABLED","FILEVAULT_ENABLED","FILEVAULT_DISABLED","TRUSTED_PLATFORM_MODULE_ENABLED","TRUSTED_PLATFORM_MODULE_DISABLED","TRUSTED_PLATFORM_MODULE_INSTALLED","TRUSTED_PLATFORM_MODULE_UNINSTALLED","SHADOWPROTECT_INSTALLED","SHADOWPROTECT_INSTALL_FAILED","SHADOWPROTECT_UNINSTALLED","SHADOWPROTECT_UNINSTALL_FAILED","SHADOWPROTECT_BACKUPJOB_FAILED","SHADOWPROTECT_BACKUPJOB_ABORTED","SHADOWPROTECT_LICENSE_PROVISIONED","SHADOWPROTECT_LICENSE_PROVISION_FAILED","SHADOWPROTECT_LICENSE_ACTIVATED","SHADOWPROTECT_LICENSE_ACTIVATION_FAILED","SHADOWPROTECT_LICENSE_DEACTIVATED","SHADOWPROTECT_LICENSE_DEACTIVATION_FAILED","IMAGEMANAGER_INSTALLED","IMAGEMANAGER_INSTALL_FAILED","IMAGEMANAGER_UNINSTALLED","IMAGEMANAGER_UNINSTALL_FAILED","IMAGEMANAGER_LICENSE_PROVISIONED","IMAGEMANAGER_LICENSE_PROVISION_FAILED","IMAGEMANAGER_LICENSE_ACTIVATED","IMAGEMANAGER_LICENSE_ACTIVATION_FAILED","IMAGEMANAGER_LICENSE_DEACTIVATED","IMAGEMANAGER_LICENSE_DEACTIVATION_FAILED","IMAGEMANAGER_CONSOLIDATION_FAILED","IMAGEMANAGER_VERIFICATION_FAILED","HELP_REQUEST_SUBMITTED","CLOUDBERRY_INSTALLED","CLOUDBERRY_INSTALL_FAILED","CLOUDBERRY_UNINSTALLED","CLOUDBERRY_UNINSTALL_FAILED","CLOUDBERRY_BACKUPPLAN_CREATED","CLOUDBERRY_BACKUPPLAN_EDITED","CLOUDBERRY_BACKUPPLAN_DELETED","CLOUDBERRY_BACKUPPLAN_CREATION_FAILED","CLOUDBERRY_BACKUPJOB_STARTED","CLOUDBERRY_BACKUPJOB_SUCCEEDED","CLOUDBERRY_BACKUPJOB_FAILED","CLOUDBERRY_BACKUPJOB_COMPLETED_WITH_WARNING","CLOUDBERRY_USER_CREATED","CLOUDBERRY_NETWORK_CREDENTIAL_CREATED","CLOUDBERRY_NETWORK_CREDENTIAL_CREATION_FAILED","RDP_CONNECTION_INITIATED","RDP_AUTO_PROVISION","SCHEDULED_TASK_CREATED","SCHEDULED_TASK_UPDATED","SCHEDULED_TASK_DELETED","SCRIPT_CREATED","SCRIPT_UPDATED","SCRIPT_DELETED","NINJA_BACKUP_BACKUPJOB_START_REQUESTED","NINJA_BACKUP_BACKUPJOB_STARTED","NINJA_BACKUP_BACKUPJOB_IN_PROCESS","NINJA_BACKUP_BACKUPJOB_COMPLETED","NINJA_BACKUP_BACKUPJOB_FAILED","NINJA_BACKUP_RESTOREJOB_START_REQUESTED","NINJA_BACKUP_RESTOREJOB_STARTED","NINJA_BACKUP_RESTOREJOB_IN_PROCESS","NINJA_BACKUP_RESTOREJOB_COMPLETED","NINJA_BACKUP_RESTOREJOB_FAILED","NINJA_BACKUP_BACKUPJOB_COMPLETED_WITH_WARNING","NINJA_BACKUP_BACKUP_DOWNLOADED","NINJA_BACKUP_BACKUPPLAN_ADDED","NINJA_BACKUP_BACKUPPLAN_EDITED","NINJA_BACKUP_BACKUPPLAN_DELETED","NINJA_BACKUP_BACKUPJOB_CANCELLED","NINJA_BACKUP_BACKUPJOB_PROCESSING","NINJA_BACKUP_INSTALL_FAILED","NINJA_BACKUP_UNINSTALL_FAILED","NINJA_BACKUP_INSTALLED","NINJA_BACKUP_UNINSTALLED","NINJA_BACKUP_RESTOREJOB_CANCELLED","NINJA_BACKUP_BACKUPPLAN_CREATION_FAILED","NINJA_BACKUP_BACKUP_CONFIGURE_FAILED","NINJA_BACKUP_FILE_DOWNLOAD","NINJA_BACKUP_FOLDER_DOWNLOAD","NINJA_BACKUP_UPSYNCJOB_START_REQUESTED","NINJA_BACKUP_UPSYNCJOB_PROCESSING","NINJA_BACKUP_UPSYNCJOB_IN_PROCESS","NINJA_BACKUP_UPSYNCJOB_STARTED","NINJA_BACKUP_UPSYNCJOB_COMPLETED","NINJA_BACKUP_UPSYNCJOB_CANCELLED","NINJA_BACKUP_UPSYNCJOB_FAILED","NINJA_BACKUP_BACKUP_NAS_ACCESS_FAILED","NINJA_BACKUP_IMAGE_RESTORE_STARTED","NINJA_BACKUP_IMAGE_RESTORE_COMPLETED","NINJA_BACKUP_IMAGE_RESTORE_FAILED","NINJA_BACKUP_IMAGE_DOWNLOAD_STARTED","NINJA_BACKUP_IMAGE_DOWNLOAD_COMPLETED","NINJA_BACKUP_IMAGE_DOWNLOAD_FAILED","NINJA_BACKUP_IMAGE_DOWNLOAD_FILE_STARTED","NINJA_BACKUP_IMAGE_DOWNLOAD_FILE_COMPLETED","NINJA_BACKUP_IMAGE_DOWNLOAD_FILE_FAILED","NINJA_BACKUP_IMAGE_MOUNT_COMPLETED","NINJA_BACKUP_IMAGE_MOUNT_FAILED","NINJA_BACKUP_INTEGRITY_CHECK_START_REQUESTED","NINJA_BACKUP_INTEGRITY_CHECK_STARTED","NINJA_BACKUP_INTEGRITY_CHECK_IN_PROCESS","NINJA_BACKUP_INTEGRITY_CHECK_COMPLETED","NINJA_BACKUP_INTEGRITY_CHECK_FAILED","NINJA_BACKUP_INTEGRITY_CHECK_CANCELLED","NINJA_BACKUP_IMAGE_DOWNLOAD_FOLDER_STARTED","NINJA_BACKUP_IMAGE_DOWNLOAD_FOLDER_COMPLETED","NINJA_BACKUP_IMAGE_DOWNLOAD_FOLDER_FAILED","BACKUP_IMAGE_RESTORE_CANCELED","BACKUP_IMAGE_DOWNLOAD_CANCELED","QC_INVITATION_CREATED","QC_INVITATION_DISABLED","QC_EXPIRED_INVITATION_BLOCKED","QC_INVITATION_UPDATED","QC_DEVICE_DELETED","QC_DEVICE_AGENT_INSTALL_REQUESTED","QC_SESSION_STARTED","QC_SESSION_TERMINATED","QC_SESSION_REPORT_SUBMITTED","REMOTE_SUPPORT_CREATED","REMOTE_SUPPORT_UPDATED","REMOTE_SUPPORT_DELETED","MDM_LOCK_DEVICE_STATUS_CREATED","MDM_REBOOT_DEVICE_STATUS_CREATED","MDM_RESET_PASSCODE_DEVICE_STATUS_CREATED","MDM_RELINQUISH_OWNERSHIP_DEVICE_STATUS_CREATED","MDM_LOCK_DEVICE_STATUS_UPDATED","MDM_REBOOT_DEVICE_STATUS_UPDATED","MDM_RESET_PASSCODE_DEVICE_STATUS_UPDATED","MDM_RELINQUISH_OWNERSHIP_DEVICE_STATUS_UPDATED","MDM_CLEAR_PASSCODE_STATUS_CREATED","MDM_CLEAR_PASSCODE_STATUS_UPDATED","MDM_ERASE_STATUS_CREATED","MDM_ERASE_STATUS_UPDATED","MDM_UPDATE_POLICY_STATUS_CREATED","MDM_UPDATE_POLICY_STATUS_UPDATED","MDM_ASSIGN_POLICY_STATUS_CREATED","MDM_ASSIGN_POLICY_STATUS_UPDATED","MDM_DIVISION_CONFIG_ENABLED","MDM_DIVISION_CONFIG_DISABLED","MDM_DIVISION_CONFIG_UPDATED","MDM_APN_CERTIFICATE_UPLOADED","MDM_ACTION_DEVICE_STATUS_FAILED","MDM_DISOWN_STATUS_FORBIDDEN","MDM_DISOWN_STATUS_COMPLETED","MDM_ADE_TOKEN_UPLOADED","MDM_ADE_TOKEN_RENEWED","MDM_RENEW_ENROLLMENT_PROFILE_STATUS_CREATED","MDM_RENEW_ENROLLMENT_PROFILE_STATUS_UPDATED","MDM_INSTALL_APP_STATUS_CREATED","MDM_APN_CERTIFICATE_RENEWED","MDM_CONNECTION_ANDROID_ENTERPRISE_RENAME_SUCCESS","MDM_CLEAR_APP_DATA_STATUS_CREATED","MDM_CLEAR_APP_DATA_STATUS_UPDATED","AOSP_ERASE_DEVICE_STATUS_CREATED","AOSP_ERASE_DEVICE_STATUS_COMPLETED","AOSP_LOCK_DEVICE_STATUS_CREATED","AOSP_LOCK_DEVICE_STATUS_UPDATED","AOSP_REBOOT_DEVICE_STATUS_CREATED","AOSP_REBOOT_DEVICE_STATUS_COMPLETED","AOSP_RESET_PASSCODE_DEVICE_STATUS_CREATED","AOSP_RESET_PASSCODE_DEVICE_STATUS_COMPLETED","AOSP_UPDATE_POLICY_STATUS_UPDATED","AOSP_NC_SESSION_REQUESTED","AOSP_NC_SESSION_STARTED","AOSP_NC_SESSION_TERMINATED","REPORT_TEMPLATE_CREATED","REPORT_TEMPLATE_UPDATED","REPORT_TEMPLATE_DELETED","REPORT_SCHEDULE_CREATED","REPORT_SCHEDULE_UPDATED","REPORT_SCHEDULE_DELETED","REPORT_TEMPLATE_DUPLICATED","REPORT_SCHEDULE_DUPLICATED","GRAVITYZONE_ENABLED","GRAVITYZONE_DISABLED","GRAVITYZONE_SCAN_STARTED","GRAVITYZONE_SCAN_COMPLETED","GRAVITYZONE_SCAN_FAILED","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE_FAILED","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE_FAILED","GRAVITYZONE_INSTALLATION_SUCCEEDED","GRAVITYZONE_INSTALLATION_SUCCEEDED_WITH_WARNINGS","GRAVITYZONE_INSTALLATION_FAILED","GRAVITYZONE_THREAT_IGNORED","GRAVITYZONE_THREAT_PRESENT","GRAVITYZONE_THREAT_DELETED","GRAVITYZONE_THREAT_BLOCKED","GRAVITYZONE_THREAT_REPORTED","GRAVITYZONE_THREAT_QUARANTINED","GRAVITYZONE_THREAT_CLEANED","GRAVITYZONE_PURGE_QUARANTINE_FAILED","GRAVITYZONE_PURGE_QUARANTINE_SUCCESS","GRAVITYZONE_THREAT_RESTORE_AND_EXCLUDED_FROM_QUARANTINE","GRAVITYZONE_THREAT_RESTORE_AND_EXCLUDED_FROM_QUARANTINE_FAILED","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE_COMPLETED","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE_COMPLETED","GRAVITYZONE_PROVISION_COMPLETED","GRAVITYZONE_PROVISION_FAILED","GRAVITYZONE_RETRY_INSTALL_COMPLETED","GRAVITYZONE_PARTNER_ASSIST_DISABLED","GRAVITYZONE_SCAN_ATTEMPT_COMPLETED","GRAVITYZONE_RESET_INACCESSIBLE_LICENSE_COMPLETED","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE_REQUESTED","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE_REQUESTED","GRAVITYZONE_THREAT_RESTORE_AND_EXCLUDED_FROM_QUARANTINE_REQUESTED","GRAVITYZONE_INSTALLATION_STARTED","GRAVITYZONE_DOWNLOAD_FAILED","GRAVITYZONE_INSTALLATION_RETRY_STARTED","GRAVITYZONE_SCAN_CANCELLED","GRAVITYZONE_DISABLING_FAILED","GRAVITYZONE_INSTALLATION_EXISTS_DETECTED","GRAVITYZONE_THREAT_BLOCKED_FROM_ACTIVE_REQUESTED","GRAVITYZONE_THREAT_BLOCKED_FROM_ACTIVE_COMPLETED","GRAVITYZONE_THREAT_BLOCKED_FROM_ACTIVE_FAILED","GRAVITYZONE_DEVICE_MANAGED","GRAVITYZONE_DEVICE_UNMANAGED","GRAVITYZONE_COMPANY_CANNOT_BE_ACCESSED","GRAVITYZONE_QUARANTINED_THREAT_DELETED_OR_RESTORED","GRAVITYZONE_SUCCEEDED_TO_REQUEST_RECONFIGURE_TASK","GRAVITYZONE_FAILED_TO_REQUEST_RECONFIGURE_TASK","GRAVITYZONE_ADVANCED_THREAT_DISINFECTED","GRAVITYZONE_ADVANCED_THREAT_BLOCKED","GRAVITYZONE_INCIDENT_REPORTED","GRAVITYZONE_INCIDENT_VISIBILITY_FLAG_UPDATED","GRAVITYZONE_EXTENDED_INCIDENT_REPORTED","GRAVITYZONE_THREAT_STILL_PRESENT_AFTER_SCAN","ATTACHMENT_FILE_SUSPICIOUS","SMTP_SEND_ERROR","TECHNICIAN_ROLE_CREATED","TECHNICIAN_ROLE_UPDATED","TECHNICIAN_ROLE_DELETED","TECHNICIAN_ROLE_ASSIGNMENT_CHANGED","TECHNICIAN_PERMISSIONS_CHANGED","END_USER_ROLE_CREATED","END_USER_ROLE_UPDATED","END_USER_ROLE_DELETED","END_USER_ROLE_ASSIGNMENT_CHANGED","END_USER_PERMISSIONS_CHANGED","SENTINEL_ONE_AGENT_ENABLED","SENTINEL_ONE_AGENT_DISABLED","SENTINEL_ONE_AGENT_STARTED","SENTINEL_ONE_AGENT_UPGRADED","SENTINEL_ONE_AGENT_SHUT_DOWN","SENTINEL_ONE_AGENT_INSTALLATION_SUCCEEDED","SENTINEL_ONE_INSTALLATION_ANOTHER_AV_DETECTED","SENTINEL_ONE_AGENT_INSTALLATION_FAILED","SENTINEL_ONE_POLICY_CHANGED","SENTINEL_ONE_LOCAL_CONFIG_CHANGE_FAILED","SENTINEL_ONE_REGISTRATION_SUCCEEDED","SENTINEL_ONE_REGISTRATION_FAILED","SENTINEL_ONE_REMEDIATION_SUCCEEDED","SENTINEL_ONE_REMEDIATION_FAILED","SENTINEL_ONE_MITIGATION_SUCCEEDED","SENTINEL_ONE_MITIGATION_FAILED","SENTINEL_ONE_MITIGATION_REQUIRE_REBOOT","SENTINEL_ONE_MITIGATION_CANNOT_KILL","SENTINEL_ONE_MITIGATION_FAILED_TO_KILL","SENTINEL_ONE_QUARANTINE_SUCCEEDED","SENTINEL_ONE_QUARANTINE_FAILED","SENTINEL_ONE_UNQUARANTINE_SUCCEEDED","SENTINEL_ONE_UNQUARANTINE_FAILED","SENTINEL_ONE_THREAT_DETECTED","SENTINEL_ONE_SCAN_STARTED","SENTINEL_ONE_SCAN_COMPLETED","SENTINEL_ONE_SCAN_FAILED","SENTINEL_ONE_SCAN_ABORTED","SENTINEL_ONE_COMMAND_RECEIVED","SENTINEL_ONE_COMMAND_FAILED","SENTINEL_ONE_AGENT_UPGRADE_SUCCEEDED","SENTINEL_ONE_SITE_TOKEN_REGENERATED","SENTINEL_ONE_ON_DEMAND_SCAN_STARTED","SENTINEL_ONE_ON_DEMAND_SCAN_COMPLETED","SENTINEL_ONE_ON_DEMAND_SCAN_ABORTED","SENTINEL_ONE_RETRY_INSTALL_COMPLETED","SENTINEL_ONE_REFRESH_API_TOKEN_SUCCEEDED","SENTINEL_ONE_REFRESH_API_TOKEN_FAILED","SENTINEL_ONE_INTEGRATION_ENABLED","SENTINEL_ONE_INTEGRATION_DISABLED","SENTINEL_ONE_INTEGRATION_CREDENTIALS_UPDATED","SENTINEL_ONE_INTEGRATION_RESYNC_INITIATED","SENTINEL_ONE_INTEGRATION_RESYNC_REQUIRED","SENTINEL_ONE_EXISTING_INSTALLATION_DETECTED","SENTINEL_ONE_AGENT_SYNC_SUCCESS","SENTINEL_ONE_AGENT_SYNC_FAILED_RETRY","SENTINEL_ONE_AGENT_SYNC_FAILED","SENTINEL_ONE_AGENT_SYNC_CANCELLED","SENTINEL_ONE_AGENT_SYNC_MAPPING_FAILED","OAUTH2_CREATED","OAUTH2_UPDATED","OAUTH2_DELETED","CROWDSTRIKE_SENSOR_ENABLED","CROWDSTRIKE_SENSOR_DISABLED","CROWDSTRIKE_SENSOR_STARTED","CROWDSTRIKE_SENSOR_UPGRADED","CROWDSTRIKE_SENSOR_SHUT_DOWN","CROWDSTRIKE_SENSOR_INSTALLATION_SUCCEEDED","CROWDSTRIKE_SENSOR_INSTALLATION_FAILED","CROWDSTRIKE_REGISTRATION_SUCCEEDED","CROWDSTRIKE_REGISTRATION_FAILED","CROWDSTRIKE_REMEDIATION_SUCCEEDED","CROWDSTRIKE_REMEDIATION_FAILED","CROWDSTRIKE_MITIGATION_SUCCEEDED","CROWDSTRIKE_MITIGATION_FAILED","CROWDSTRIKE_QUARANTINE_SUCCEEDED","CROWDSTRIKE_QUARANTINE_FAILED","CROWDSTRIKE_THREAT_DETECTED","CROWDSTRIKE_MISSING_PERMISSIONS","CROWDSTRIKE_CREDENTIAL_INVALID","CROWDSTRIKE_INSTALLATION_ANOTHER_AV_DETECTED","CROWDSTRIKE_ENABLED","CROWDSTRIKE_DISABLED","CROWDSTRIKE_CREDENTIALS_UPDATED","CROWDSTRIKE_EXISTING_INSTALLATION_DETECTED","CROWDSTRIKE_RETRY_INSTALL_COMPLETED","CROWDSTRIKE_MISSING_API_CLIENT_SCOPE","CROWDSTRIKE_PARTNER_PROVISION_IN_PROGRESS","CROWDSTRIKE_PARTNER_PROVISION_COMPLETED","CROWDSTRIKE_PARTNER_PROVISION_FAILED","CROWDSTRIKE_CUSTOMER_PROVISION_IN_PROGRESS","CROWDSTRIKE_CUSTOMER_PROVISION_COMPLETED","CROWDSTRIKE_CUSTOMER_PROVISION_FAILED","CROWDSTRIKE_FALCON_COMPLETE_CREDENTIAL_INVALID","CROWDSTRIKE_MISSING_FALCON_COMPLETE_API_CLIENT_SCOPE","CROWDSTRIKE_UNMANAGED_INSTALLATION_DETECTED","CROWDSTRIKE_SENSOR_PROVISIONING","CROWDSTRIKE_SENSOR_MIGRATED","CROWDSTRIKE_CUSTOMER_BUNDLE_UPDATED","CROWDSTRIKE_CREDENTIAL_UNHEALTHY","CROWDSTRIKE_CREDENTIAL_VALIDATED","CROWDSTRIKE_FALCON_COMPLETE_CREDENTIAL_UNHEALTHY","CROWDSTRIKE_FALCON_COMPLETE_CREDENTIAL_VALIDATED","SERVICE_NOW_UPDATED","SERVICE_NOW_CONFIGURATION_ITEM_CLASS_MAPPING_CREATED","SERVICE_NOW_CONFIGURATION_ITEM_CLASS_MAPPING_UPDATED","SERVICE_NOW_CONFIGURATION_ITEM_CLASS_MAPPING_DELETED","SERVICE_NOW_RESET_AUTHENTICATION","SERVICE_NOW_NODE_SYNC_NODE_CREATED","SERVICE_NOW_NODE_SYNC_NODE_UPDATED","SERVICE_NOW_NODE_SYNC_NODE_ERROR","SERVICE_NOW_NODE_SYNC_BY_CLIENT_STARTED","SERVICE_NOW_NODE_SYNC_BY_CLIENT_COMPLETED","SERVICE_NOW_CLIENT_MAPPING_CREATED","SERVICE_NOW_CLIENT_MAPPING_UPDATED","SERVICE_NOW_CLIENT_MAPPING_DELETED","SERVICE_NOW_SYNC_CLIENT_ON_DEMAND","SERVICE_NOW_CLIENT_MAPPING_STATUS_UPDATED","ZENDESK_UPDATED","FRESHSERVICE_UPDATED","NINJA_TICKETING_CREATION_FAILED","NINJA_TICKETING_FORM_CREATED","NINJA_TICKETING_FORM_UPDATED","NINJA_TICKETING_FORM_ACTIVED","NINJA_TICKETING_FORM_DEACTIVED","NINJA_TICKETING_ATTRIBUTE_CREATED","NINJA_TICKETING_ATTRIBUTE_UPDATED","NINJA_TICKETING_ATTRIBUTE_ACTIVED","NINJA_TICKETING_ATTRIBUTE_DEACTIVATED","NINJA_TICKETING_RULESET_CREATED","NINJA_TICKETING_RULESET_UPDATED","NINJA_TICKETING_RULESET_DELETED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_CREATED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_UPDATED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_DELETED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_MAKE_DEFAULT","NINJA_TICKETING_TRIGGER_CREATED","NINJA_TICKETING_TRIGGER_UPDATED","NINJA_TICKETING_TRIGGER_DELETED","NINJA_TICKETING_TICKET_CREATED","NINJA_TICKETING_TICKET_DELETED","NINJA_TICKETING_PENDING_EMAIL_CREATION_APPROVED","NINJA_TICKETING_PENDING_EMAIL_UPDATE_APPROVED","NINJA_TICKETING_PENDING_EMAIL_REJECTED","NINJA_TICKETING_ENABLED","NINJA_TICKETING_DISABLED","NINJA_TICKETING_UPDATED","NINJA_TICKETING_FORM_MAKE_DEFAULT","NINJA_TICKETING_CONDITION_RULE_MAKE_DEFAULT","NINJA_TICKETING_SCRIPT_RULE_MAKE_DEFAULT","NINJA_TICKETING_PENDING_EMAIL_RECEIVED","NINJA_TICKETING_EMAIL_ALLOWLIST_ITEM_CREATED","NINJA_TICKETING_EMAIL_ALLOWLIST_ITEM_UPDATED","NINJA_TICKETING_EMAIL_ALLOWLIST_ITEM_DELETED","NINJA_TICKETING_EMAIL_BLOCKLIST_ITEM_CREATED","NINJA_TICKETING_EMAIL_BLOCKLIST_ITEM_UPDATED","NINJA_TICKETING_EMAIL_BLOCKLIST_ITEM_DELETED","NINJA_TICKETING_TICKET_REINSTATED","NINJA_TICKETING_STATUS_CREATED","NINJA_TICKETING_STATUS_UPDATED","NINJA_TICKETING_STATUS_DELETED","NINJA_TICKETING_AGREEMENT_BULK_UPDATED","KNOWLEDGE_BASE_DOCUMENT_CREATED","KNOWLEDGE_BASE_DOCUMENT_UPDATED","KNOWLEDGE_BASE_DOCUMENT_ARCHIVED","KNOWLEDGE_BASE_DOCUMENT_RESTORED","KNOWLEDGE_BASE_DOCUMENT_DELETED","KNOWLEDGE_BASE_FOLDER_CREATED","KNOWLEDGE_BASE_FOLDER_UPDATED","KNOWLEDGE_BASE_FOLDER_ARCHIVED","KNOWLEDGE_BASE_FOLDER_RESTORED","KNOWLEDGE_BASE_FOLDER_DELETED","KNOWLEDGE_BASE_PUBLIC_TEMPORARY_TOKEN_CREATED","KNOWLEDGE_BASE_PUBLIC_LINK_CREATED","KNOWLEDGE_BASE_PUBLIC_LINK_UPDATED","KNOWLEDGE_BASE_PUBLIC_LINK_DELETED","KNOWLEDGE_BASE_FOLDER_MOVED","KNOWLEDGE_BASE_DOCUMENT_MOVED","KNOWLEDGE_BASE_FOLDER_SHARED","KNOWLEDGE_BASE_FOLDER_ACCESS_RESTRICTED","DOCUMENT_TEMPLATE_CREATED","DOCUMENT_TEMPLATE_UPDATED","DOCUMENT_TEMPLATE_ARCHIVED","DOCUMENT_TEMPLATE_RESTORED","DOCUMENT_TEMPLATE_DELETED","CLIENT_DOCUMENT_CREATED","CLIENT_DOCUMENT_UPDATED","CLIENT_DOCUMENT_ARCHIVED","CLIENT_DOCUMENT_RESTORED","CLIENT_DOCUMENT_DELETED","CLIENT_DOCUMENT_ATTRIBUTE_VALUE_DECRYPTED","CLIENT_DOCUMENT_REVISION_DELETED","CLIENT_DOCUMENTATION_DELEGATE_NODE_RESPONSIBILITY_ADDED","CLIENT_DOCUMENTATION_DELEGATE_NODE_RESPONSIBILITY_REMOVED","CLIENT_DOCUMENT_ATTRIBUTE_TEMPORARY_PUBLIC_TOKEN_CREATED","CLIENT_CHECKLIST_CREATED","CLIENT_CHECKLIST_UPDATED","CLIENT_CHECKLIST_DELETED","CLIENT_CHECKLIST_PROMOTED","CLIENT_CHECKLIST_TEMPORARY_PUBLIC_TOKEN_CREATED","CLIENT_CHECKLIST_ARCHIVED","CLIENT_CHECKLIST_RESTORED","CHECKLIST_TEMPLATE_CREATED","CHECKLIST_TEMPLATE_UPDATED","CHECKLIST_TEMPLATE_DELETED","CHECKLIST_TEMPLATE_ARCHIVED","CHECKLIST_TEMPLATE_RESTORED","RELATED_ITEM_CREATED","RELATED_ITEM_UPDATED","RELATED_ITEM_DELETED","RELATED_ITEM_SECURE_VALUE_DECRYPTED","RELATED_ITEM_TEMPORARY_PUBLIC_TOKEN_CREATED","ANTIVIRUS_THREAT_MUTED","ANTIVIRUS_THREAT_UNMUTED","SUPPLIER_CREATED","SUPPLIER_UPDATED","SUPPLIER_DELETED","MAINTENANCE_MODE_CONFIGURED","MAINTENANCE_MODE_DELETED","MAINTENANCE_MODE_MODIFIED","MAINTENANCE_MODE_FAILED","MAINTENANCE_MODE_ACTIVE","MAINTENANCE_MODE_UPDATED","MAINTENANCE_MODE_COMPLETED","SIEM_EXPORTER_WEBHOOK_CREATED","SIEM_EXPORTER_WEBHOOK_DELETED","SIEM_EXPORTER_WEBHOOK_ENABLED","SIEM_EXPORTER_WEBHOOK_DISABLED","SIEM_EXPORTER_WEBHOOK_UPDATED","SIEM_EXPORTER_WEBHOOK_DISPATCH_FAILURE","SIEM_EXPORTER_ENABLED","SIEM_EXPORTER_DISABLED"]},"status":{"type":"string","description":"Status description"},"activityResult":{"type":"string","description":"Activity result","enum":["SUCCESS","FAILURE","UNSUPPORTED","UNCOMPLETED","MISSED"]},"sourceConfigUid":{"type":"string","description":"Source configuration/policy element reference","format":"uuid"},"sourceName":{"type":"string","description":"Source configuration/policy element name"},"subject":{"type":"string","description":"Activity subject"},"userId":{"type":"integer","description":"User identifier","format":"int32"},"message":{"type":"string","description":"Activity message"},"type":{"type":"string","description":"Activity type description"},"data":{"type":"object","additionalProperties":true,"description":"Activity data"}}}},"lastNodeActivityId":{"type":"integer","description":"Last recorded activity ID for device","format":"int64"}}},"Alert":{"type":"object","properties":{"uid":{"type":"string","description":"Alert UID (activity series UID)","format":"uuid"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"message":{"type":"string","description":"Alert message"},"createTime":{"type":"number","description":"Alert creation timestamp","format":"double"},"updateTime":{"type":"number","description":"Alert last updated","format":"double"},"sourceType":{"type":"string","description":"Alert origin","enum":["AGENT_OFFLINE","CONDITION_AGENT_CPU","CONDITION_AGENT_MEMORY","CONDITION_AGENT_NETWORK","CONDITION_AGENT_DISK_IO","CONDITION_AGENT_DISK_FREE_SPACE","CONDITION_AGENT_DISK_USAGE","CONDITION_AGENT_CVSS_SCORE","CONDITION_AGENT_PATCH_LAST_INSTALLED","CONDITION_NMS_CPU","CONDITION_NMS_MEMORY","CONDITION_NMS_NETWORK_TRAFFIC_BITS","CONDITION_NMS_NETWORK_ADAPTER_STATUS","CONDITION_NMS_NETWORK_TRAFFIC_PERCENT","CONDITION_NMS_NETWORK_STATUS","CONDITION_NMS_NETWORK_STATUS_CHANGE","CONDITION_NMS_SYSTEM_UPTIME","CONDITION_PING","CONDITION_PING_LATENCY","CONDITION_PING_PACKET_LOSS","CONDITION_PING_RESPONSE","CONDITION_SYSTEM_UPTIME","CONDITION_SMART_STATUS_DEGRATED","CONDITION_RAID_HEALTH_STATUS","CONDITION_SCRIPT_RESULT","CONDITION_HTTP","CONDITION_HTTP_RESPONSE","CONDITION_PORT","CONDITION_PORT_SCAN","CONDITION_SYSLOG","CONDITION_CONFIGURATION_FILE","CONDITION_SNMPTRAP","CONDITION_CRITICAL_EVENT","CONDITION_BATTERY_MONITORING","CONDITION_DNS","CONDITION_EMAIL","CONDITION_CUSTOM_SNMP","CONDITION_COMPOUND","SHADOWPROTECT_BACKUPJOB_CREATE","SHADOWPROTECT_BACKUPJOB_UPDATE","SHADOWPROTECT_BACKUPJOB_DELETE","SHADOWPROTECT_BACKUPJOB_EXECUTE","IMAGEMANAGER_MANAGEDFOLDER_CREATE","IMAGEMANAGER_MANAGEDFOLDER_UPDATE","IMAGEMANAGER_MANAGEDFOLDER_DELETE","IMAGEMANAGER_MANAGEDFOLDER_EXECUTE","TEAMVIEWER_CONNECTION","RETRIEVE_AGENT_LOGS","SCHEDULED_TASK","CONDITION_WINDOWS_EVENT_LOG_TRIGGERED","CONDITION_WINDOWS_SERVICE_STATE_CHANGED","UI_MESSAGE_ACTION_REBOOT","UI_MESSAGE_BD_INSTALLATION_ISSUES","GRAVITYZONE_UI_MESSAGE_INSTALLATION_ISSUES","AV_QUARANTINE_THREAT","AV_RESTORE_THREAT","AV_DELETE_THREAT","AV_REMOVE_THREAT","BITDEFENDER_RESTORE_THREAT","BITDEFENDER_DELETE_THREAT","CONDITION_BITLOCKER_STATUS","CONDITION_FILEVAULT_STATUS","CONDITION_LINUX_PROCESS","CONDITION_LINUX_Daemon","CONDITION_LINUX_PROCESS_RESOURCE","CONDITION_LINUX_PROCESS_RESOURCE_CPU","CONDITION_LINUX_PROCESS_RESOURCE_MEMORY","CONDITION_LINUX_DISK_FREE_SPACE","CONDITION_LINUX_DISK_USAGE","CONDITION_VM_AGGREGATE_CPU_USAGE","CONDITION_VM_DISK_USAGE","CONDITION_VM_HOST_DATASTORE","CONDITION_VM_HOST_UPTIME","CONDITION_VM_HOST_DEVICE_DOWN","CONDITION_VM_HOST_BAD_SENSORS","CONDITION_VM_HOST_SENSOR_HEALTH","CONDITION_VM_GUEST_GUEST_OPERATIONAL_MODE","CONDITION_VM_GUEST_SNAPSHOT_SIZE","CONDITION_VM_GUEST_SNAPSHOT_LIFESPAN","CONDITION_VM_GUEST_TOOLS_NOT_RUNNING","CONDITION_HV_GUEST_CHECKPOINT_SIZE","CONDITION_HV_GUEST_CHECKPOINT_LIFESPAN","CONDITION_SOFTWARE","CONDITION_WINDOWS_PROCESS_STATE","CONDITION_WINDOWS_PROCESS_RESOURCE_CPU","CONDITION_WINDOWS_PROCESS_RESOURCE_MEMORY","CONDITION_MAC_PROCESS_STATE","CONDITION_MAC_PROCESS_RESOURCE_CPU","CONDITION_MAC_PROCESS_RESOURCE_MEMORY","CONDITION_MAC_DEAMON","CONDITION_CUSTOM_FIELD","CONDITION_PENDING_REBOOT","CONDITION_LOCKHART_LAST_SUCCESSFUL_BACKUP"]},"sourceConfigUid":{"type":"string","description":"Source configuration/policy element reference","format":"uuid"},"sourceName":{"type":"string","description":"Source configuration/policy element name"},"subject":{"type":"string","description":"Alert subject"},"userId":{"type":"integer","description":"User identifier","format":"int32"},"psaTicketId":{"type":"object","description":"Related PSA ticket ID"},"ticketTemplateId":{"type":"integer","description":"PSA ticket template","format":"int32"},"data":{"type":"object","additionalProperties":true,"description":"Alert data"},"device":{"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"}},"description":"Device information."},"priority":{"type":"string"},"severity":{"type":"string"},"conditionName":{"type":"string"},"conditionHealthStatus":{"type":"string","enum":["UNKNOWN","HEALTHY","NEEDS_ATTENTION","UNHEALTHY"]},"useGlobalHealthStatus":{"type":"boolean"}}},"DiskDrive":{"type":"object","properties":{"bytesPerSector":{"type":"integer","description":"Number of bytes per sector","format":"int32"},"description":{"type":"string","description":"Description"},"interfaceType":{"type":"string","description":"Interface type"},"manufacturer":{"type":"string","description":"Manufacturer"},"mediaType":{"type":"string","description":"Media Type"},"model":{"type":"string","description":"Model"},"name":{"type":"string","description":"Name"},"partitionCount":{"type":"integer","description":"Number of partitions","format":"int32"},"serialNumber":{"type":"string","description":"Serial number"},"size":{"type":"integer","description":"Size (Bytes)","format":"int64"},"smartCapable":{"type":"boolean","description":"Is S.M.A.R.T. capable?"},"status":{"type":"string","description":"Status"}}},"GeolocationHistoryResponse":{"type":"object","properties":{"results":{"type":"array","description":"Geolocation records","items":{"type":"object","properties":{"latitude":{"type":"number","description":"Device latitude","format":"double","example":28.260770164828532},"longitude":{"type":"number","description":"Device longitude","format":"double","example":-82.18508102335356},"timestamp":{"type":"number","description":"Location timestamp, epoch seconds with millisecond precision","format":"double","example":1778938364.507}},"description":"Geolocation records"}},"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}}}},"GeolocationRecord":{"type":"object","properties":{"latitude":{"type":"number","description":"Device latitude","format":"double","example":28.260770164828532},"longitude":{"type":"number","description":"Device longitude","format":"double","example":-82.18508102335356},"timestamp":{"type":"number","description":"Location timestamp, epoch seconds with millisecond precision","format":"double","example":1778938364.507}},"description":"Geolocation records"},"InstallError":{"type":"object","properties":{"symbolicName":{"type":"string","description":"Vendor/OS-reported error's symbolic name, null if unknown"},"code":{"type":"string","description":"Vendor/OS-reported error code, null if unknown"},"message":{"type":"string","description":"Vendor/OS-reported error message, null if unknown"}},"description":"Install failure details; empty array when installed successfully or not applicable"},"OSPatchInstall":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Name"},"severity":{"type":"string","description":"Severity"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Patch release date","format":"double"},"version":{"type":"string","description":"Patch version"},"os":{"type":"string","description":"Operating system family the patch applies to","enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"rebootRequired":{"type":"string","description":"Whether installing the patch requires a reboot","enum":["YES","NO","MAYBE"]},"installErrors":{"type":"array","description":"Install failure details; empty when the patch installed successfully","items":{"type":"object","properties":{"symbolicName":{"type":"string","description":"Vendor/OS-reported error's symbolic name, null if unknown"},"code":{"type":"string","description":"Vendor/OS-reported error code, null if unknown"},"message":{"type":"string","description":"Vendor/OS-reported error message, null if unknown"}},"description":"Install failure details; empty array when installed successfully or not applicable"}},"kbNumber":{"type":"string","description":"KB Number"}}},"SoftwarePatchInstall":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"productIdentifier":{"type":"string","description":"Software product identifier","format":"uuid"},"title":{"type":"string","description":"Patch title"},"impact":{"type":"string","description":"Impact"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Patch type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Vendor's published release date, null if unknown","format":"double","nullable":true},"version":{"type":"string","description":"Vendor's own version string, null if not available","nullable":true},"architecture":{"type":"string","description":"Patch architecture, null if unknown","nullable":true,"enum":["X86","X64","ARM64","UNIVERSAL"]},"os":{"type":"string","description":"Operating system family, null if unknown","nullable":true,"enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"vendor":{"type":"string","description":"Vendor name, null if not available","nullable":true},"rebootRequired":{"type":"string","description":"Whether a reboot is required after installation, null if unknown","nullable":true,"enum":["YES","NO","MAYBE"]},"installErrors":{"type":"array","description":"Install failure details; empty array when installed successfully or not applicable","items":{"type":"object","properties":{"symbolicName":{"type":"string","description":"Vendor/OS-reported error's symbolic name, null if unknown"},"code":{"type":"string","description":"Vendor/OS-reported error code, null if unknown"},"message":{"type":"string","description":"Vendor/OS-reported error message, null if unknown"}},"description":"Install failure details; empty array when installed successfully or not applicable"}}}},"LoggedOnUser":{"type":"object","properties":{"userName":{"type":"string","description":"User name"},"logonTime":{"type":"number","description":"Time of logon","format":"double"}}},"DeviceLink":{"type":"object","properties":{"url":{"type":"string","description":"URL"},"expires":{"type":"number","description":"Link expiration time","format":"double"}}},"NetworkInterface":{"type":"object","properties":{"adapterName":{"type":"string","description":"Adapter Name"},"defaultGateway":{"type":"string","description":"Default Gateway"},"interfaceType":{"type":"string","description":"Interface Type"},"dnsHostName":{"type":"string","description":"DNS HostName"},"dnsServers":{"type":"string","description":"DNS Servers"},"interfaceIndex":{"type":"string","description":"Interface Index"},"interfaceName":{"type":"string","description":"Interface Name"},"ipAddress":{"type":"array","description":"IP Address","items":{"type":"string","description":"IP Address"}},"linkSpeed":{"type":"string","description":"Link Speed"},"macAddress":{"type":"array","description":"MAC Address","items":{"type":"string","description":"MAC Address"}},"mtu":{"type":"string","description":"MTU"},"status":{"type":"string","description":"Status"},"subnetMask":{"type":"string","description":"Subnet Mask"}}},"OSPatchOutstanding":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Name"},"severity":{"type":"string","description":"Severity"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Patch release date","format":"double"},"version":{"type":"string","description":"Patch version"},"os":{"type":"string","description":"Operating system family the patch applies to","enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"rebootRequired":{"type":"string","description":"Whether installing the patch requires a reboot","enum":["YES","NO","MAYBE"]},"kbNumber":{"type":"string","description":"KB Number"}}},"SoftwarePatch":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"productIdentifier":{"type":"string","description":"Software product identifier","format":"uuid"},"title":{"type":"string","description":"Patch title"},"impact":{"type":"string","description":"Impact"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Patch type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Vendor's published release date, null if unknown","format":"double","nullable":true},"version":{"type":"string","description":"Vendor's own version string, null if not available","nullable":true},"architecture":{"type":"string","description":"Patch architecture, null if unknown","nullable":true,"enum":["X86","X64","ARM64","UNIVERSAL"]},"os":{"type":"string","description":"Operating system family, null if unknown","nullable":true,"enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"vendor":{"type":"string","description":"Vendor name, null if not available","nullable":true},"rebootRequired":{"type":"string","description":"Whether a reboot is required after installation, null if unknown","nullable":true,"enum":["YES","NO","MAYBE"]}}},"WindowsService":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"displayName":{"type":"string","description":"Display Name"},"description":{"type":"string","description":"Description"},"startType":{"type":"string","description":"Start Type","enum":["AUTO_START","AUTO_START_DELAYED","BOOT_START","DEMAND_START","DISABLED","SYSTEM_START"]},"userName":{"type":"string","description":"User Name"},"state":{"type":"string","description":"State","enum":["UNKNOWN","STOPPED","START_PENDING","RUNNING","STOP_PENDING","PAUSE_PENDING","PAUSED","CONTINUE_PENDING"]}}},"Application":{"type":"object","properties":{"installDate":{"type":"string","description":"Installation Date","format":"date-time"},"location":{"type":"string","description":"Location"},"name":{"type":"string","description":"Product Name"},"publisher":{"type":"string","description":"Publisher"},"size":{"type":"integer","description":"Size on disk","format":"int64"},"version":{"type":"string","description":"Version"},"productCode":{"type":"string","description":"Product Code"},"isSystemComponent":{"type":"boolean","description":"Is System Component"}}},"PolicyOverrides":{"type":"object","properties":{"overrides":{"type":"array","description":"List of policy sections","items":{"type":"string","description":"List of policy sections"}}}},"RebootRequest":{"type":"object","properties":{"reason":{"type":"string","description":"Stated reboot reason"}}},"CredentialReference":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"type":{"type":"string","enum":["SNMPV12C","SNMPV3","TELNET_SSH","NETWORK_LOCATION","ENCRYPTION_KEY","BASIC","SNMPV1","SNMPV2"]}}},"DeviceCredentialOptions":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"string"}},"credentials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"type":{"type":"string","enum":["SNMPV12C","SNMPV3","TELNET_SSH","NETWORK_LOCATION","ENCRYPTION_KEY","BASIC","SNMPV1","SNMPV2"]}}}}}},"DeviceScriptingOptions":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"internal":{"type":"boolean"}}}},"scripts":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Type of script/action","enum":["ACTION","SCRIPT"]},"id":{"type":"integer","description":"Custom script identifier (Scripts)","format":"int32"},"uid":{"type":"string","description":"Built-in action identifier (Actions)","format":"uuid"},"name":{"type":"string","description":"Name"},"language":{"type":"string","description":"Script language"},"description":{"type":"string","description":"Description"},"architecture":{"uniqueItems":true,"type":"array","description":"Applicable architectures","items":{"type":"string","description":"Applicable architectures"}},"categoryId":{"type":"integer","description":"Script Category identifier","format":"int32"}}}},"credentials":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"string"}},"credentials":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"type":{"type":"string","enum":["SNMPV12C","SNMPV3","TELNET_SSH","NETWORK_LOCATION","ENCRYPTION_KEY","BASIC","SNMPV1","SNMPV2"]}}}}}}}},"Script":{"type":"object","properties":{"type":{"type":"string","description":"Type of script/action","enum":["ACTION","SCRIPT"]},"id":{"type":"integer","description":"Custom script identifier (Scripts)","format":"int32"},"uid":{"type":"string","description":"Built-in action identifier (Actions)","format":"uuid"},"name":{"type":"string","description":"Name"},"language":{"type":"string","description":"Script language"},"description":{"type":"string","description":"Description"},"architecture":{"uniqueItems":true,"type":"array","description":"Applicable architectures","items":{"type":"string","description":"Applicable architectures"}},"categoryId":{"type":"integer","description":"Script Category identifier","format":"int32"}}},"ScriptCategory":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"internal":{"type":"boolean"}}},"RunScriptRequest":{"type":"object","properties":{"type":{"type":"string","description":"Type","enum":["ACTION","SCRIPT"]},"id":{"type":"integer","description":"Script identifier","format":"int32"},"uid":{"type":"string","description":"Built-in action identifier","format":"uuid"},"parameters":{"type":"string","description":"Action/Script parameters"},"runAs":{"type":"string","description":"Credential role/identifier"}}},"WindowsServiceConfiguration":{"type":"object","properties":{"startType":{"type":"string","description":"Start Type","enum":["AUTO_START","AUTO_START_DELAYED","BOOT_START","DEMAND_START","DISABLED","SYSTEM_START"]},"userName":{"type":"string","description":"Username"}}},"DeviceMutableProperties":{"type":"object","properties":{"displayName":{"type":"string","description":"Display name (User assigned)"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization policy mapping, or reverts to organization policy if Null)","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"}}},"MaintenanceSettings":{"type":"object","properties":{"disabledFeatures":{"type":"array","description":"List of features that will be disabled during maintenance","items":{"type":"string","description":"List of features that will be disabled during maintenance","enum":["ALERTS","PATCHING","AVSCANS","TASKS"]}},"start":{"type":"number","description":"Maintenance window start (optional, defaults to now). Allowed formats: ISO-8601 date-time string or epoch milliseconds.","format":"double"},"end":{"type":"number","description":"Maintenance window end. Allowed formats: ISO-8601 date-time string or epoch milliseconds.","format":"double"},"reasonMessage":{"type":"string","description":"Reason for maintenance window"}}},"Link":{"type":"object","properties":{"url":{"type":"string","description":"URL"}}},"GenerateInstallerRequestDto":{"type":"object","properties":{"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"installerType":{"type":"string","description":"Agent installer type","enum":["WINDOWS_MSI","WINDOWS_ARM64_MSI","MAC_DMG","MAC_PKG","LINUX_DEB","LINUX_RPM","LINUX_ARM64_DEB","LINUX_ARMV7A_DEB","LINUX_ARM64_RPM","LINUX_ARMV7A_RPM"]},"usageLimit":{"type":"integer","description":"Usage limit","format":"int32","readOnly":true},"content":{"type":"object","properties":{"nodeRoleId":{"type":"string","description":"Identifier for the nodeRole target of this installer. Acceptable values include integers, 'auto', or an empty string. If the value is omitted, or an empty string, it defaults to 'auto'.","default":"auto"}},"description":"content"}}},"InstallerContent":{"type":"object","properties":{"nodeRoleId":{"type":"string","description":"Identifier for the nodeRole target of this installer. Acceptable values include integers, 'auto', or an empty string. If the value is omitted, or an empty string, it defaults to 'auto'.","default":"auto"}},"description":"content"},"LocationBackupUsageSummary":{"type":"object","properties":{"locationId":{"type":"integer","description":"Device location id","format":"int32"},"locationName":{"type":"string","description":"Device location name"},"locationDescription":{"type":"string","description":"Device location description"},"revisionsCurrentSize":{"type":"integer","format":"int64"},"revisionsPreviousSize":{"type":"integer","format":"int64"},"revisionsDeletedSize":{"type":"integer","format":"int64"},"localFileFolderSize":{"type":"integer","format":"int64"},"localImageSize":{"type":"integer","format":"int64"},"localImageV2Size":{"type":"integer","format":"int64"},"cloudFileFolderSize":{"type":"integer","format":"int64"},"cloudImageSize":{"type":"integer","format":"int64"},"cloudImageV2Size":{"type":"integer","format":"int64"},"cloudNetworkShareSize":{"type":"integer","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","format":"double"},"lastFailedBackupJob":{"type":"number","format":"double"},"organizationId":{"type":"integer","format":"int32"},"organizationName":{"type":"string"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}}},"OrganizationModel":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]}}},"AntivirusStatusReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"productName":{"type":"string","description":"Product name"},"productState":{"type":"string","description":"Product state"},"definitionStatus":{"type":"string","description":"Definition Status"},"version":{"type":"string","description":"Product Version"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}},"DeviceAntivirusStatus":{"type":"object","properties":{"productName":{"type":"string","description":"Product name"},"productState":{"type":"string","description":"Product state"},"definitionStatus":{"type":"string","description":"Definition Status"},"version":{"type":"string","description":"Product Version"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}},"AntivirusThreatsReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Threat name"},"productCode":{"type":"string","description":"AntiVirus vendor product code"},"quarantineId":{"type":"string","description":"Threat Quarantine ID"},"status":{"type":"string","description":"Threat Status (vendor specific)"},"type":{"type":"string","description":"Type of Threat"},"threatId":{"type":"integer","description":"Threat ID","format":"int64"},"category":{"type":"string","description":"Threat Category"},"level":{"type":"string","description":"Threat Level"},"detectionSource":{"type":"string","description":"Detection source"},"traceList":{"type":"string","description":"Trace list (Files, Cookies, etc. Vendor specific)"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}},"DeviceAntivirusThreat":{"type":"object","properties":{"name":{"type":"string","description":"Threat name"},"productCode":{"type":"string","description":"AntiVirus vendor product code"},"quarantineId":{"type":"string","description":"Threat Quarantine ID"},"status":{"type":"string","description":"Threat Status (vendor specific)"},"type":{"type":"string","description":"Type of Threat"},"threatId":{"type":"integer","description":"Threat ID","format":"int64"},"category":{"type":"string","description":"Threat Category"},"level":{"type":"string","description":"Threat Level"},"detectionSource":{"type":"string","description":"Detection source"},"traceList":{"type":"string","description":"Trace list (Files, Cookies, etc. Vendor specific)"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}},"ComputerSystemsReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"manufacturer":{"type":"string","description":"Manufacturer"},"model":{"type":"string","description":"Model"},"biosSerialNumber":{"type":"string","description":"Bios Serial Number"},"serialNumber":{"type":"string","description":"Serial Number"},"assetSerialNumber":{"type":"string","description":"Asset Serial Number"},"domain":{"type":"string"},"domainRole":{"type":"string"},"numberOfProcessors":{"type":"integer","format":"int32"},"totalPhysicalMemory":{"type":"integer","format":"int64"},"virtualMachine":{"type":"boolean"},"chassisType":{"type":"string"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}},"DeviceComputerSystem":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"manufacturer":{"type":"string","description":"Manufacturer"},"model":{"type":"string","description":"Model"},"biosSerialNumber":{"type":"string","description":"Bios Serial Number"},"serialNumber":{"type":"string","description":"Serial Number"},"assetSerialNumber":{"type":"string","description":"Asset Serial Number"},"domain":{"type":"string"},"domainRole":{"type":"string"},"numberOfProcessors":{"type":"integer","format":"int32"},"totalPhysicalMemory":{"type":"integer","format":"int64"},"virtualMachine":{"type":"boolean"},"chassisType":{"type":"string"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}},"AttributeValueUpdatedByInfo":{"type":"object","properties":{"source":{"type":"string","enum":["API","USER","SCRIPT","SYSTEM"]},"user":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"email":{"type":"string"}}}},"description":"Value source (who/what updated the value)"},"NodeAttributeInfo":{"type":"object","properties":{"name":{"type":"string","description":"Field name"},"value":{"type":"object","description":"Field Value"},"updated":{"type":"number","description":"Last field update timestamp","format":"double","writeOnly":true},"updatedBy":{"type":"object","properties":{"source":{"type":"string","enum":["API","USER","SCRIPT","SYSTEM"]},"user":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"email":{"type":"string"}}}},"description":"Value source (who/what updated the value)"},"updateTime":{"type":"number","format":"double"}},"description":"Field values"},"NodeAttributesDetailed":{"type":"object","properties":{"deviceId":{"type":"integer","description":"Entity identifier","format":"int32","writeOnly":true},"entityType":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]},"fields":{"type":"array","description":"Field values","items":{"type":"object","properties":{"name":{"type":"string","description":"Field name"},"value":{"type":"object","description":"Field Value"},"updated":{"type":"number","description":"Last field update timestamp","format":"double","writeOnly":true},"updatedBy":{"type":"object","properties":{"source":{"type":"string","enum":["API","USER","SCRIPT","SYSTEM"]},"user":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"email":{"type":"string"}}}},"description":"Value source (who/what updated the value)"},"updateTime":{"type":"number","format":"double"}},"description":"Field values"}},"entityId":{"type":"integer","format":"int32"}}},"NodeAttributesDetailedReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"deviceId":{"type":"integer","description":"Entity identifier","format":"int32","writeOnly":true},"entityType":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]},"fields":{"type":"array","description":"Field values","items":{"type":"object","properties":{"name":{"type":"string","description":"Field name"},"value":{"type":"object","description":"Field Value"},"updated":{"type":"number","description":"Last field update timestamp","format":"double","writeOnly":true},"updatedBy":{"type":"object","properties":{"source":{"type":"string","enum":["API","USER","SCRIPT","SYSTEM"]},"user":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"email":{"type":"string"}}}},"description":"Value source (who/what updated the value)"},"updateTime":{"type":"number","format":"double"}},"description":"Field values"}},"entityId":{"type":"integer","format":"int32"}}}}}},"NodeAttributes":{"type":"object","properties":{"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"fields":{"type":"object","additionalProperties":{"type":"object","description":"Field values"},"description":"Field values"}}},"NodeAttributesReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"fields":{"type":"object","additionalProperties":{"type":"object","description":"Field values"},"description":"Field values"}}}}}},"DeviceHealthReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"activeThreatsCount":{"type":"integer","description":"Active AV threats count","format":"int32"},"quarantinedThreatsCount":{"type":"integer","description":"Quarantined AV threats count","format":"int32"},"blockedThreatsCount":{"type":"integer","description":"Blocked AV threats count","format":"int32"},"failedOSPatchesCount":{"type":"integer","description":"Number of failed OS patches","format":"int32"},"pendingOSPatchesCount":{"type":"integer","description":"Number of pending OS patches","format":"int32"},"alertCount":{"type":"integer","description":"Alerts count","format":"int32"},"activeJobCount":{"type":"integer","description":"Alerts job count","format":"int32"},"failedSoftwarePatchesCount":{"type":"integer","description":"Number of failed software patches","format":"int32"},"pendingSoftwarePatchesCount":{"type":"integer","description":"Number of pending software patches","format":"int32"},"pendingRebootReason":{"type":"string","description":"Pending reboot reasons"},"avInstallStatus":{"type":"string","description":"Antivirus installation status","enum":["REQUESTED","DOWNLOAD_STARTED","DOWNLOADED","DOWNLOAD_FAILED","INSTALL_STARTED","INSTALLED","INSTALL_FAILED","UNINSTALL_REQUESTED","UNINSTALL_FAILED","UNINSTALLED"]},"productsInstallationStatuses":{"type":"object","additionalProperties":{"type":"string","description":"Integrated products' installation statuses","enum":["REQUESTED","DOWNLOAD_STARTED","DOWNLOADED","DOWNLOAD_FAILED","INSTALL_STARTED","INSTALLED","INSTALL_FAILED","UNINSTALL_REQUESTED","UNINSTALL_FAILED","UNINSTALLED"]},"description":"Integrated products' installation statuses"},"offline":{"type":"boolean","description":"Is device offline?"},"parentDeviceId":{"type":"integer","description":"Parent device identifier","format":"int32"},"parentOffline":{"type":"boolean","description":"Is parent device offline"},"healthStatus":{"type":"string","description":"Health status","enum":["UNKNOWN","HEALTHY","NEEDS_ATTENTION","UNHEALTHY"]},"criticalVulnerabilityCount":{"type":"integer","description":"Critical Vulnerability Count","format":"int32"},"highVulnerabilityCount":{"type":"integer","description":"High Vulnerability Count","format":"int32"},"mediumVulnerabilityCount":{"type":"integer","description":"Medium Vulnerability Count","format":"int32"},"lowVulnerabilityCount":{"type":"integer","description":"Low Vulnerability Count","format":"int32"},"installationIssuesCount":{"type":"integer","format":"int32"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"}}}}}},"DeviceHealthSummary":{"type":"object","properties":{"activeThreatsCount":{"type":"integer","description":"Active AV threats count","format":"int32"},"quarantinedThreatsCount":{"type":"integer","description":"Quarantined AV threats count","format":"int32"},"blockedThreatsCount":{"type":"integer","description":"Blocked AV threats count","format":"int32"},"failedOSPatchesCount":{"type":"integer","description":"Number of failed OS patches","format":"int32"},"pendingOSPatchesCount":{"type":"integer","description":"Number of pending OS patches","format":"int32"},"alertCount":{"type":"integer","description":"Alerts count","format":"int32"},"activeJobCount":{"type":"integer","description":"Alerts job count","format":"int32"},"failedSoftwarePatchesCount":{"type":"integer","description":"Number of failed software patches","format":"int32"},"pendingSoftwarePatchesCount":{"type":"integer","description":"Number of pending software patches","format":"int32"},"pendingRebootReason":{"type":"string","description":"Pending reboot reasons"},"avInstallStatus":{"type":"string","description":"Antivirus installation status","enum":["REQUESTED","DOWNLOAD_STARTED","DOWNLOADED","DOWNLOAD_FAILED","INSTALL_STARTED","INSTALLED","INSTALL_FAILED","UNINSTALL_REQUESTED","UNINSTALL_FAILED","UNINSTALLED"]},"productsInstallationStatuses":{"type":"object","additionalProperties":{"type":"string","description":"Integrated products' installation statuses","enum":["REQUESTED","DOWNLOAD_STARTED","DOWNLOADED","DOWNLOAD_FAILED","INSTALL_STARTED","INSTALLED","INSTALL_FAILED","UNINSTALL_REQUESTED","UNINSTALL_FAILED","UNINSTALLED"]},"description":"Integrated products' installation statuses"},"offline":{"type":"boolean","description":"Is device offline?"},"parentDeviceId":{"type":"integer","description":"Parent device identifier","format":"int32"},"parentOffline":{"type":"boolean","description":"Is parent device offline"},"healthStatus":{"type":"string","description":"Health status","enum":["UNKNOWN","HEALTHY","NEEDS_ATTENTION","UNHEALTHY"]},"criticalVulnerabilityCount":{"type":"integer","description":"Critical Vulnerability Count","format":"int32"},"highVulnerabilityCount":{"type":"integer","description":"High Vulnerability Count","format":"int32"},"mediumVulnerabilityCount":{"type":"integer","description":"Medium Vulnerability Count","format":"int32"},"lowVulnerabilityCount":{"type":"integer","description":"Low Vulnerability Count","format":"int32"},"installationIssuesCount":{"type":"integer","format":"int32"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"}}},"DeviceUsageReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"}},"description":"Device information."}}}},"DeviceDiskDrive":{"type":"object","properties":{"bytesPerSector":{"type":"integer","description":"Number of bytes per sector","format":"int32"},"description":{"type":"string","description":"Description"},"interfaceType":{"type":"string","description":"Interface type"},"manufacturer":{"type":"string","description":"Manufacturer"},"mediaType":{"type":"string","description":"Media Type"},"model":{"type":"string","description":"Model"},"name":{"type":"string","description":"Name"},"partitionCount":{"type":"integer","description":"Number of partitions","format":"int32"},"serialNumber":{"type":"string","description":"Serial number"},"size":{"type":"integer","description":"Size (Bytes)","format":"int64"},"smartCapable":{"type":"boolean","description":"Is S.M.A.R.T. capable?"},"status":{"type":"string","description":"Status"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}},"DiskDriveReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"bytesPerSector":{"type":"integer","description":"Number of bytes per sector","format":"int32"},"description":{"type":"string","description":"Description"},"interfaceType":{"type":"string","description":"Interface type"},"manufacturer":{"type":"string","description":"Manufacturer"},"mediaType":{"type":"string","description":"Media Type"},"model":{"type":"string","description":"Model"},"name":{"type":"string","description":"Name"},"partitionCount":{"type":"integer","description":"Number of partitions","format":"int32"},"serialNumber":{"type":"string","description":"Serial number"},"size":{"type":"integer","description":"Size (Bytes)","format":"int64"},"smartCapable":{"type":"boolean","description":"Is S.M.A.R.T. capable?"},"status":{"type":"string","description":"Status"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}},"DeviceOSPatchInstall":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Name"},"severity":{"type":"string","description":"Severity"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Patch release date","format":"double"},"version":{"type":"string","description":"Patch version"},"os":{"type":"string","description":"Operating system family the patch applies to","enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"rebootRequired":{"type":"string","description":"Whether installing the patch requires a reboot","enum":["YES","NO","MAYBE"]},"installErrors":{"type":"array","description":"Install failure details; empty when the patch installed successfully","items":{"type":"object","properties":{"symbolicName":{"type":"string","description":"Vendor/OS-reported error's symbolic name, null if unknown"},"code":{"type":"string","description":"Vendor/OS-reported error code, null if unknown"},"message":{"type":"string","description":"Vendor/OS-reported error message, null if unknown"}},"description":"Install failure details; empty array when installed successfully or not applicable"}},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"},"kbNumber":{"type":"string","description":"KB Number"}}},"OSPatchInstallReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Name"},"severity":{"type":"string","description":"Severity"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Patch release date","format":"double"},"version":{"type":"string","description":"Patch version"},"os":{"type":"string","description":"Operating system family the patch applies to","enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"rebootRequired":{"type":"string","description":"Whether installing the patch requires a reboot","enum":["YES","NO","MAYBE"]},"installErrors":{"type":"array","description":"Install failure details; empty when the patch installed successfully","items":{"type":"object","properties":{"symbolicName":{"type":"string","description":"Vendor/OS-reported error's symbolic name, null if unknown"},"code":{"type":"string","description":"Vendor/OS-reported error code, null if unknown"},"message":{"type":"string","description":"Vendor/OS-reported error message, null if unknown"}},"description":"Install failure details; empty array when installed successfully or not applicable"}},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"},"kbNumber":{"type":"string","description":"KB Number"}}}}}},"DeviceSoftwarePatchInstall":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"productIdentifier":{"type":"string","description":"Software product identifier","format":"uuid"},"title":{"type":"string","description":"Patch title"},"impact":{"type":"string","description":"Impact"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Patch type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Vendor's published release date, null if unknown","format":"double","nullable":true},"version":{"type":"string","description":"Vendor's own version string, null if not available","nullable":true},"architecture":{"type":"string","description":"Patch architecture, null if unknown","nullable":true,"enum":["X86","X64","ARM64","UNIVERSAL"]},"os":{"type":"string","description":"Operating system family, null if unknown","nullable":true,"enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"vendor":{"type":"string","description":"Vendor name, null if not available","nullable":true},"rebootRequired":{"type":"string","description":"Whether a reboot is required after installation, null if unknown","nullable":true,"enum":["YES","NO","MAYBE"]},"installErrors":{"type":"array","description":"Install failure details; empty array when installed successfully or not applicable","items":{"type":"object","properties":{"symbolicName":{"type":"string","description":"Vendor/OS-reported error's symbolic name, null if unknown"},"code":{"type":"string","description":"Vendor/OS-reported error code, null if unknown"},"message":{"type":"string","description":"Vendor/OS-reported error message, null if unknown"}},"description":"Install failure details; empty array when installed successfully or not applicable"}},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}},"SoftwarePatchInstallReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"productIdentifier":{"type":"string","description":"Software product identifier","format":"uuid"},"title":{"type":"string","description":"Patch title"},"impact":{"type":"string","description":"Impact"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Patch type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Vendor's published release date, null if unknown","format":"double","nullable":true},"version":{"type":"string","description":"Vendor's own version string, null if not available","nullable":true},"architecture":{"type":"string","description":"Patch architecture, null if unknown","nullable":true,"enum":["X86","X64","ARM64","UNIVERSAL"]},"os":{"type":"string","description":"Operating system family, null if unknown","nullable":true,"enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"vendor":{"type":"string","description":"Vendor name, null if not available","nullable":true},"rebootRequired":{"type":"string","description":"Whether a reboot is required after installation, null if unknown","nullable":true,"enum":["YES","NO","MAYBE"]},"installErrors":{"type":"array","description":"Install failure details; empty array when installed successfully or not applicable","items":{"type":"object","properties":{"symbolicName":{"type":"string","description":"Vendor/OS-reported error's symbolic name, null if unknown"},"code":{"type":"string","description":"Vendor/OS-reported error code, null if unknown"},"message":{"type":"string","description":"Vendor/OS-reported error message, null if unknown"}},"description":"Install failure details; empty array when installed successfully or not applicable"}},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}},"DeviceLoggedOnUser":{"type":"object","properties":{"userName":{"type":"string","description":"User name"},"logonTime":{"type":"number","description":"Time of logon","format":"double"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"}}},"LoggedOnUsersReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"userName":{"type":"string","description":"User name"},"logonTime":{"type":"number","description":"Time of logon","format":"double"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"}}}}}},"DeviceNetworkInterfaces":{"type":"object","properties":{"adapterName":{"type":"string","description":"Adapter Name"},"defaultGateway":{"type":"string","description":"Default Gateway"},"interfaceType":{"type":"string","description":"Interface Type"},"dnsHostName":{"type":"string","description":"DNS HostName"},"dnsServers":{"type":"string","description":"DNS Servers"},"interfaceIndex":{"type":"string","description":"Interface Index"},"interfaceName":{"type":"string","description":"Interface Name"},"ipAddress":{"type":"array","description":"IP Address","items":{"type":"string","description":"IP Address"}},"linkSpeed":{"type":"string","description":"Link Speed"},"macAddress":{"type":"array","description":"MAC Address","items":{"type":"string","description":"MAC Address"}},"mtu":{"type":"string","description":"MTU"},"status":{"type":"string","description":"Status"},"subnetMask":{"type":"string","description":"Subnet Mask"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"}}},"NetworkInterfacesReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"adapterName":{"type":"string","description":"Adapter Name"},"defaultGateway":{"type":"string","description":"Default Gateway"},"interfaceType":{"type":"string","description":"Interface Type"},"dnsHostName":{"type":"string","description":"DNS HostName"},"dnsServers":{"type":"string","description":"DNS Servers"},"interfaceIndex":{"type":"string","description":"Interface Index"},"interfaceName":{"type":"string","description":"Interface Name"},"ipAddress":{"type":"array","description":"IP Address","items":{"type":"string","description":"IP Address"}},"linkSpeed":{"type":"string","description":"Link Speed"},"macAddress":{"type":"array","description":"MAC Address","items":{"type":"string","description":"MAC Address"}},"mtu":{"type":"string","description":"MTU"},"status":{"type":"string","description":"Status"},"subnetMask":{"type":"string","description":"Subnet Mask"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"}}}}}},"DeviceOperatingSystem":{"type":"object","properties":{"manufacturer":{"type":"string","description":"Manufacturer"},"name":{"type":"string","description":"Name"},"architecture":{"type":"string","description":"Architecture"},"lastBootTime":{"type":"number","description":"Last boot time","format":"double"},"buildNumber":{"type":"string","description":"Build number"},"releaseId":{"type":"string","description":"Release ID"},"servicePackMajorVersion":{"type":"integer","description":"Service Pack Major Version","format":"int32"},"servicePackMinorVersion":{"type":"integer","description":"Service Pack Minor Version","format":"int32"},"locale":{"type":"string","description":"Locale"},"language":{"type":"string","description":"Language"},"needsReboot":{"type":"boolean","description":"Operating system has pending reboot requests"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}},"OperatingSystemsReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"manufacturer":{"type":"string","description":"Manufacturer"},"name":{"type":"string","description":"Name"},"architecture":{"type":"string","description":"Architecture"},"lastBootTime":{"type":"number","description":"Last boot time","format":"double"},"buildNumber":{"type":"string","description":"Build number"},"releaseId":{"type":"string","description":"Release ID"},"servicePackMajorVersion":{"type":"integer","description":"Service Pack Major Version","format":"int32"},"servicePackMinorVersion":{"type":"integer","description":"Service Pack Minor Version","format":"int32"},"locale":{"type":"string","description":"Locale"},"language":{"type":"string","description":"Language"},"needsReboot":{"type":"boolean","description":"Operating system has pending reboot requests"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}},"DeviceOSPatchOutstanding":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Name"},"severity":{"type":"string","description":"Severity"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Patch release date","format":"double"},"version":{"type":"string","description":"Patch version"},"os":{"type":"string","description":"Operating system family the patch applies to","enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"rebootRequired":{"type":"string","description":"Whether installing the patch requires a reboot","enum":["YES","NO","MAYBE"]},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"},"kbNumber":{"type":"string","description":"KB Number"}}},"OSPatchReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"name":{"type":"string","description":"Name"},"severity":{"type":"string","description":"Severity"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Patch release date","format":"double"},"version":{"type":"string","description":"Patch version"},"os":{"type":"string","description":"Operating system family the patch applies to","enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"rebootRequired":{"type":"string","description":"Whether installing the patch requires a reboot","enum":["YES","NO","MAYBE"]},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"},"kbNumber":{"type":"string","description":"KB Number"}}}}}},"DeviceSoftwarePatch":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"productIdentifier":{"type":"string","description":"Software product identifier","format":"uuid"},"title":{"type":"string","description":"Patch title"},"impact":{"type":"string","description":"Impact"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Patch type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Vendor's published release date, null if unknown","format":"double","nullable":true},"version":{"type":"string","description":"Vendor's own version string, null if not available","nullable":true},"architecture":{"type":"string","description":"Patch architecture, null if unknown","nullable":true,"enum":["X86","X64","ARM64","UNIVERSAL"]},"os":{"type":"string","description":"Operating system family, null if unknown","nullable":true,"enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"vendor":{"type":"string","description":"Vendor name, null if not available","nullable":true},"rebootRequired":{"type":"string","description":"Whether a reboot is required after installation, null if unknown","nullable":true,"enum":["YES","NO","MAYBE"]},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}},"SoftwarePatchReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","format":"uuid"},"productIdentifier":{"type":"string","description":"Software product identifier","format":"uuid"},"title":{"type":"string","description":"Patch title"},"impact":{"type":"string","description":"Impact"},"status":{"type":"string","description":"Status"},"type":{"type":"string","description":"Patch type"},"installedAt":{"type":"number","description":"Installation attempt timestamp","format":"double"},"releaseDate":{"type":"number","description":"Vendor's published release date, null if unknown","format":"double","nullable":true},"version":{"type":"string","description":"Vendor's own version string, null if not available","nullable":true},"architecture":{"type":"string","description":"Patch architecture, null if unknown","nullable":true,"enum":["X86","X64","ARM64","UNIVERSAL"]},"os":{"type":"string","description":"Operating system family, null if unknown","nullable":true,"enum":["WINDOWS","MACOS","LINUX","IOS","ANDROID"]},"vendor":{"type":"string","description":"Vendor name, null if not available","nullable":true},"rebootRequired":{"type":"string","description":"Whether a reboot is required after installation, null if unknown","nullable":true,"enum":["YES","NO","MAYBE"]},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}},"DevicePolicyOverrides":{"type":"object","properties":{"overrides":{"type":"array","description":"List of policy sections","items":{"type":"string","description":"List of policy sections"}},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"}}},"PolicyOverridesReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"overrides":{"type":"array","description":"List of policy sections","items":{"type":"string","description":"List of policy sections"}},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"}}}}}},"DeviceProcessor":{"type":"object","properties":{"architecture":{"type":"string","description":"Architecture"},"maxClockSpeed":{"type":"integer","description":"Max Clock Speed","format":"int64"},"clockSpeed":{"type":"integer","description":"Current Clock Speed","format":"int64"},"name":{"type":"string","description":"Name"},"numCores":{"type":"integer","description":"Number of Cores","format":"int32"},"numLogicalCores":{"type":"integer","description":"Number of Logical Cores]","format":"int32"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}},"ProcessorReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"architecture":{"type":"string","description":"Architecture"},"maxClockSpeed":{"type":"integer","description":"Max Clock Speed","format":"int64"},"clockSpeed":{"type":"integer","description":"Current Clock Speed","format":"int64"},"name":{"type":"string","description":"Name"},"numCores":{"type":"integer","description":"Number of Cores","format":"int32"},"numLogicalCores":{"type":"integer","description":"Number of Logical Cores]","format":"int32"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}},"DeviceRAIDController":{"type":"object","properties":{"backupBatteryStatus":{"type":"string","description":"Backup Battery Status"},"batteryTemperature":{"type":"integer","description":"Battery Temperature","format":"int32"},"biosVersion":{"type":"string","description":"BIOS Version"},"cacheSize":{"type":"integer","description":"Cache size (bytes)","format":"int64"},"controllerIndex":{"type":"integer","description":"Controller Index","format":"int32"},"driverName":{"type":"string","description":"Device Driver Name"},"driverVersion":{"type":"string","description":"Driver Version"},"family":{"type":"string","description":"Family"},"firmwareVersion":{"type":"string","description":"Firmware Version"},"hardwareRevision":{"type":"string","description":"Hardware Revision"},"manufacturer":{"type":"string","description":"Manufacturer"},"manufacturingDate":{"type":"number","description":"Manufacturing date","format":"double"},"model":{"type":"string","description":"Model"},"physicalDriveCount":{"type":"integer","description":"Physical drive count","format":"int32"},"slot":{"type":"string","description":"Slot"},"systemHealthStatus":{"type":"string","description":"System Health Status"},"virtualDriveCount":{"type":"integer","description":"Virtual drive count","format":"int32"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}},"RAIDControllerReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"backupBatteryStatus":{"type":"string","description":"Backup Battery Status"},"batteryTemperature":{"type":"integer","description":"Battery Temperature","format":"int32"},"biosVersion":{"type":"string","description":"BIOS Version"},"cacheSize":{"type":"integer","description":"Cache size (bytes)","format":"int64"},"controllerIndex":{"type":"integer","description":"Controller Index","format":"int32"},"driverName":{"type":"string","description":"Device Driver Name"},"driverVersion":{"type":"string","description":"Driver Version"},"family":{"type":"string","description":"Family"},"firmwareVersion":{"type":"string","description":"Firmware Version"},"hardwareRevision":{"type":"string","description":"Hardware Revision"},"manufacturer":{"type":"string","description":"Manufacturer"},"manufacturingDate":{"type":"number","description":"Manufacturing date","format":"double"},"model":{"type":"string","description":"Model"},"physicalDriveCount":{"type":"integer","description":"Physical drive count","format":"int32"},"slot":{"type":"string","description":"Slot"},"systemHealthStatus":{"type":"string","description":"System Health Status"},"virtualDriveCount":{"type":"integer","description":"Virtual drive count","format":"int32"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}},"DeviceRAIDDrive":{"type":"object","properties":{"controllerIndex":{"type":"integer","description":"Controller index","format":"int32"},"driveGroup":{"type":"string","description":"Drive Group"},"driveId":{"type":"string","description":"Drive Identifier"},"interfaceType":{"type":"string","description":"Interface type"},"location":{"type":"string","description":"Location"},"mediaType":{"type":"string","description":"Media type"},"model":{"type":"string","description":"Model"},"protectionInfo":{"type":"string","description":"Protection Information"},"selfEncrypted":{"type":"boolean","description":"Is self encrypted?"},"serial":{"type":"string","description":"Serial number"},"size":{"type":"integer","description":"Size (bytes)","format":"int64"},"spun":{"type":"boolean","description":"Spun?"},"status":{"type":"string","description":"Status"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}},"RAIDDriveReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"controllerIndex":{"type":"integer","description":"Controller index","format":"int32"},"driveGroup":{"type":"string","description":"Drive Group"},"driveId":{"type":"string","description":"Drive Identifier"},"interfaceType":{"type":"string","description":"Interface type"},"location":{"type":"string","description":"Location"},"mediaType":{"type":"string","description":"Media type"},"model":{"type":"string","description":"Model"},"protectionInfo":{"type":"string","description":"Protection Information"},"selfEncrypted":{"type":"boolean","description":"Is self encrypted?"},"serial":{"type":"string","description":"Serial number"},"size":{"type":"integer","description":"Size (bytes)","format":"int64"},"spun":{"type":"boolean","description":"Spun?"},"status":{"type":"string","description":"Status"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}},"ScopedAttributesDetailed":{"type":"object","properties":{"scope":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]},"entityId":{"type":"integer","description":"Entity identifier (device, organization, location)","format":"int32"},"fields":{"type":"array","description":"Field values","items":{"type":"object","properties":{"name":{"type":"string","description":"Field name"},"value":{"type":"object","description":"Field Value"},"updated":{"type":"number","description":"Last field update timestamp","format":"double","writeOnly":true},"updatedBy":{"type":"object","properties":{"source":{"type":"string","enum":["API","USER","SCRIPT","SYSTEM"]},"user":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"email":{"type":"string"}}}},"description":"Value source (who/what updated the value)"},"updateTime":{"type":"number","format":"double"}},"description":"Field values"}}}},"ScopedAttributesDetailedReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"scope":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]},"entityId":{"type":"integer","description":"Entity identifier (device, organization, location)","format":"int32"},"fields":{"type":"array","description":"Field values","items":{"type":"object","properties":{"name":{"type":"string","description":"Field name"},"value":{"type":"object","description":"Field Value"},"updated":{"type":"number","description":"Last field update timestamp","format":"double","writeOnly":true},"updatedBy":{"type":"object","properties":{"source":{"type":"string","enum":["API","USER","SCRIPT","SYSTEM"]},"user":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"email":{"type":"string"}}}},"description":"Value source (who/what updated the value)"},"updateTime":{"type":"number","format":"double"}},"description":"Field values"}}}}}}},"ScopedAttributes":{"type":"object","properties":{"scope":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]},"entityId":{"type":"integer","description":"Entity identifier (device, organization, location)","format":"int32"},"fields":{"type":"object","additionalProperties":{"type":"object","description":"Field values"},"description":"Field values"}}},"ScopedAttributesReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"scope":{"type":"string","description":"Defines what entity types can use this custom field definition","enum":["NODE","END_USER","LOCATION","ORGANIZATION","GLOBAL"]},"entityId":{"type":"integer","description":"Entity identifier (device, organization, location)","format":"int32"},"fields":{"type":"object","additionalProperties":{"type":"object","description":"Field values"},"description":"Field values"}}}}}},"DeviceApplication":{"type":"object","properties":{"installDate":{"type":"string","description":"Installation Date","format":"date-time"},"location":{"type":"string","description":"Location"},"name":{"type":"string","description":"Product Name"},"publisher":{"type":"string","description":"Publisher"},"size":{"type":"integer","description":"Size on disk","format":"int64"},"version":{"type":"string","description":"Version"},"productCode":{"type":"string","description":"Product Code"},"isSystemComponent":{"type":"boolean","description":"Is System Component"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}},"SoftwareReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"installDate":{"type":"string","description":"Installation Date","format":"date-time"},"location":{"type":"string","description":"Location"},"name":{"type":"string","description":"Product Name"},"publisher":{"type":"string","description":"Publisher"},"size":{"type":"integer","description":"Size on disk","format":"int64"},"version":{"type":"string","description":"Version"},"productCode":{"type":"string","description":"Product Code"},"isSystemComponent":{"type":"boolean","description":"Is System Component"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}},"DeviceVolume":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"driveLetter":{"type":"string","description":"Drive Letter"},"label":{"type":"string","description":"Volume Label"},"deviceType":{"type":"string","description":"Device Type"},"fileSystem":{"type":"string","description":"File System Type"},"autoMount":{"type":"boolean","description":"Automatically Mounted"},"compressed":{"type":"boolean","description":"Compressed"},"capacity":{"type":"integer","description":"Capacity (bytes)","format":"int64"},"freeSpace":{"type":"integer","description":"Free Space (bytes)","format":"int64"},"serialNumber":{"type":"string","description":"Serial Number"},"bitLockerStatus":{"type":"object","properties":{"conversionStatus":{"type":"string","description":"Volume encryption or decryption status.","enum":["FULLY_DECRYPTED","FULLY_ENCRYPTED","ENCRYPTION_IN_PROGRESS","DECRYPTION_IN_PROGRESS","ENCRYPTION_PAUSED","DECRYPTION_PAUSED","UNKNOWN"]},"encryptionMethod":{"type":"string","description":"Indicated the encryption algorithm and key size used on the volume","enum":["NONE","AES_128_WITH_DIFFUSER","AES_256_WITH_DIFFUSER","AES_128","AES_256","HARDWARE_ENCRYPTION","XTS_AES_128","XTS_AES_256","UNKNOWN"]},"protectionStatus":{"type":"string","description":" indicates whether the volume and its encryption key (if any) are secured.","enum":["UNPROTECTED","PROTECTED","UNKNOWN","PENDING"]},"lockStatus":{"type":"string","description":"Indicates whether the contents of the volume are accessible from Windows","enum":["UNKNOWN","UNLOCKED","LOCKED"]},"initializedForProtection":{"type":"boolean","description":"Is initialized for protection"}},"description":"BitLocker Status"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}},"VolumesReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"driveLetter":{"type":"string","description":"Drive Letter"},"label":{"type":"string","description":"Volume Label"},"deviceType":{"type":"string","description":"Device Type"},"fileSystem":{"type":"string","description":"File System Type"},"autoMount":{"type":"boolean","description":"Automatically Mounted"},"compressed":{"type":"boolean","description":"Compressed"},"capacity":{"type":"integer","description":"Capacity (bytes)","format":"int64"},"freeSpace":{"type":"integer","description":"Free Space (bytes)","format":"int64"},"serialNumber":{"type":"string","description":"Serial Number"},"bitLockerStatus":{"type":"object","properties":{"conversionStatus":{"type":"string","description":"Volume encryption or decryption status.","enum":["FULLY_DECRYPTED","FULLY_ENCRYPTED","ENCRYPTION_IN_PROGRESS","DECRYPTION_IN_PROGRESS","ENCRYPTION_PAUSED","DECRYPTION_PAUSED","UNKNOWN"]},"encryptionMethod":{"type":"string","description":"Indicated the encryption algorithm and key size used on the volume","enum":["NONE","AES_128_WITH_DIFFUSER","AES_256_WITH_DIFFUSER","AES_128","AES_256","HARDWARE_ENCRYPTION","XTS_AES_128","XTS_AES_256","UNKNOWN"]},"protectionStatus":{"type":"string","description":" indicates whether the volume and its encryption key (if any) are secured.","enum":["UNPROTECTED","PROTECTED","UNKNOWN","PENDING"]},"lockStatus":{"type":"string","description":"Indicates whether the contents of the volume are accessible from Windows","enum":["UNKNOWN","UNLOCKED","LOCKED"]},"initializedForProtection":{"type":"boolean","description":"Is initialized for protection"}},"description":"BitLocker Status"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}},"DeviceWindowsService":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"displayName":{"type":"string","description":"Display Name"},"description":{"type":"string","description":"Description"},"startType":{"type":"string","description":"Start Type","enum":["AUTO_START","AUTO_START_DELAYED","BOOT_START","DEMAND_START","DISABLED","SYSTEM_START"]},"userName":{"type":"string","description":"User Name"},"state":{"type":"string","description":"State","enum":["UNKNOWN","STOPPED","START_PENDING","RUNNING","STOP_PENDING","PAUSE_PENDING","PAUSED","CONTINUE_PENDING"]},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}},"WindowsServiceReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Name"},"displayName":{"type":"string","description":"Display Name"},"description":{"type":"string","description":"Description"},"startType":{"type":"string","description":"Start Type","enum":["AUTO_START","AUTO_START_DELAYED","BOOT_START","DEMAND_START","DISABLED","SYSTEM_START"]},"userName":{"type":"string","description":"User Name"},"state":{"type":"string","description":"State","enum":["UNKNOWN","STOPPED","START_PENDING","RUNNING","STOP_PENDING","PAUSE_PENDING","PAUSED","CONTINUE_PENDING"]},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"timestamp":{"type":"number","description":"Date/Time when data was collected/updated","format":"double"}}}}}},"PolicyInfo":{"type":"object","properties":{"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"enabled":{"type":"boolean","description":"Policy Enabled Flag","default":true}}},"ActivitiesResponse":{"type":"object","properties":{"lastActivityId":{"type":"integer","description":"Last recorded activity ID for account","format":"int64"},"activities":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","description":"Activity identifier","format":"int64"},"activityTime":{"type":"number","description":"Activity timestamp","format":"double"},"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"severity":{"type":"string","description":"Severity","enum":["NONE","MINOR","MODERATE","MAJOR","CRITICAL"]},"priority":{"type":"string","description":"Priority","enum":["NONE","LOW","MEDIUM","HIGH"]},"seriesUid":{"type":"string","description":"Activity series UID (job/condition UID)","format":"uuid"},"activityType":{"type":"string","description":"Activity type code","enum":["ACTIONSET","ACTION","CONDITION","CONDITION_ACTIONSET","CONDITION_ACTION","ANTIVIRUS","PATCH_MANAGEMENT","TEAMVIEWER","MONITOR","SYSTEM","COMMENT","SHADOWPROTECT","IMAGEMANAGER","HELP_REQUEST","SOFTWARE_PATCH_MANAGEMENT","SPLASHTOP","CLOUDBERRY","CLOUDBERRY_BACKUP","SCHEDULED_TASK","RDP","SCRIPTING","SECURITY","REMOTE_TOOLS","VIRTUALIZATION","PSA","MDM","NINJA_REMOTE","NINJA_QUICK_CONNECT","NINJA_NETWORK_DISCOVERY","NINJA_BACKUP","NINJA_TICKETING","KNOWLEDGE_BASE","RELATED_ITEM","CLIENT_CHECKLIST","CHECKLIST_TEMPLATE","DOCUMENTATION","MICROSOFT_INTUNE","DYNAMIC_POLICY","MAINTENANCE_MODE","AOSP_ACTION","AOSP_POLICY","AOSP"]},"statusCode":{"type":"string","description":"Activity status code","enum":["START_REQUESTED","STARTED","IN_PROCESS","COMPLETED","CANCEL_REQUESTED","CANCELLED","BLOCKED","QUEUED","TRIGGERED","RESET","ACKNOWLEDGED","DISABLED","EVALUATION_FAILURE","CLIENT_CREATED","CLIENT_UPDATED","CLIENT_DELETED","CREDENTIAL_CREATED","CREDENTIAL_UPDATED","CREDENTIAL_DELETED","LOCATION_CREATED","LOCATION_UPDATED","LOCATION_DELETED","POLICY_CREATED","POLICY_UPDATED","POLICY_DELETED","NODE_CREATED","NODE_UPDATED","NODE_DELETED","NODE_RE_ENROLLED","NODE_ACCESS_GRANTED","NODE_ACCESS_DENIED","NODE_REGISTRATION_REJECTED","NODE_IDENTIFICATION_UPDATED","NODE_CLONING_DETECTED","NODE_CLONE_ADVISED_TO_REGISTER","NODE_MANUALLY_APPROVED","NODE_AUTOMATICALLY_APPROVED","NODE_MANUALLY_REJECTED","NODE_AUTOMATICALLY_REJECTED","REJECTED_NODE_CLEARED","REJECTED_NODE_DELETED","MOBILE_DEVICE_UNREGISTERED","APP_USER_CREATED","APP_USER_UPDATED","APP_USER_DELETED","APP_USER_LOGGED_IN","APP_USER_LOGGED_OUT","APP_USER_MFA_SETUP","APP_USER_MFA_DELETED","APP_USER_CRITICAL_ACTION","APP_USER_AUDIT_FAILED_LOGIN","APP_USER_AUTO_ASSIGN_CHANGED","END_USER_CREATED","END_USER_CREATED_API","END_USER_UPDATED","END_USER_UPDATED_API","END_USER_DELETED","END_USER_DELETED_API","END_USER_LOGGED_IN","END_USER_LOGGED_OUT","END_USER_MFA_SETUP","END_USER_MFA_DELETED","END_USER_AUDIT_FAILED_LOGIN","END_USER_CRITICAL_ACTION","CONTACT_CREATED","CONTACT_CREATED_API","CONTACT_UPDATED","CONTACT_UPDATED_API","CONTACT_DELETED","CONTACT_DELETED_API","DEVICE_GROUP_CREATED","DEVICE_GROUP_UPDATED","DEVICE_GROUP_DELETED","TICKET_TEMPLATE_CREATED","TICKET_TEMPLATE_UPDATED","TICKET_TEMPLATE_DELETED","CUSTOM_HEALTH_STATUS_CHANGED","CUSTOM_HEALTH_STATUS_RESET","PSA_TICKET_CREATION_FAILED","PSA_TICKET_CREATION_SUCCEEDED","RESET_BY_PSA_TICKET_CALLBACK","PSA_TICKET_CREATION_TEST","PSA_ENABLED","PSA_DISABLED","PSA_CREDENTIALS_FAILED","CONNECTWISE_AGREEMENTS_SYNC_COMPLETED","CONNECTWISE_AGREEMENTS_SYNC_STARTED","CONNECTWISE_NODE_SYNC_COMPLETED","CONNECTWISE_NODE_SYNC_STARTED","CONNECTWISE_NODE_SYNC_NODE_CREATED","CONNECTWISE_NODE_SYNC_NODE_UPDATED","CONNECTWISE_NODE_SYNC_NODE_DELETED","CONNECTWISE_UPDATED","CONNECTWISECONTROL_ATTEMPT","AUTOTASK_NODE_SYNC_STARTED","AUTOTASK_NODE_SYNC_COMPLETED","AUTOTASK_NODE_SYNC_NODE_CREATED","AUTOTASK_NODE_SYNC_NODE_UPDATED","AUTOTASK_NODE_SYNC_NODE_DELETED","AUTOTASK_UPDATED","AUTOTASK_ATTACHMENT_FAILURE","PSA_TICKET_UPDATED_FAILED","PSA_TICKET_UPDATED_SUCCEEDED","REPORT_CREATED","REPORT_UPDATED","REPORT_DELETED","TIME_ZONE_UPDATED","LANGUAGE_TAG_UPDATED","NODE_ROLE_CREATED","NODE_ROLE_UPDATED","NODE_ROLE_DELETED","COMMENT","VIPREAV_INSTALLED","VIPREAV_INSTALL_FAILED","VIPREAV_UNINSTALLED","VIPREAV_UNINSTALL_FAILED","VIPREAV_SCAN_THREAT_QUARANTINED","VIPREAV_ACTIVEPROTECTION_THREAT_QUARANTINED","VIPREAV_USERINITIATED_THREAT_QUARANTINED","VIPREAV_QUARANTINED_THREAT_REMOVED","VIPREAV_REBOOT_REQUIRED","VIPREAV_SCAN_STARTED","VIPREAV_SCAN_COMPLETED","VIPREAV_SCAN_ABORTED","VIPREAV_SCAN_FAILED","VIPREAV_SCAN_PAUSED","VIPREAV_DISABLED","WEBROOT_COMMAND_SUBMITTED","WEBROOT_THREAT_DETECTED","WEBROOT_INSTALL_FAILED","BITDEFENDER_SCAN_STARTED","BITDEFENDER_SCAN_COMPLETED","BITDEFENDER_THREAT_DELETE_FROM_QUARANTINE","BITDEFENDER_THREAT_RESTORE_FROM_QUARANTINE","BITDEFENDER_SCAN_FAILED","BITDEFENDER_THREAT_DELETE_FROM_QUARANTINE_FAILED","BITDEFENDER_THREAT_RESTORE_FROM_QUARANTINE_FAILED","BITDEFENDER_DOWNLOAD_STARTED","BITDEFENDER_DOWNLOAD_SUCCEEDED","BITDEFENDER_DOWNLOAD_FAILED","BITDEFENDER_INSTALLATION_STARTED","BITDEFENDER_INSTALLATION_SUCCEEDED","BITDEFENDER_INSTALLATION_FAILED","BITDEFENDER_UNINSTALLATION_STARTED","BITDEFENDER_UNINSTALLATION_SUCCEEDED","BITDEFENDER_UNINSTALLATION_FAILED","BITDEFENDER_UNPACKING_FAILED","BDAS_BITDEFENDER_THREAT_IGNORED","BDAS_BITDEFENDER_THREAT_PRESENT","BDAS_BITDEFENDER_THREAT_DELETED","BDAS_BITDEFENDER_THREAT_BLOCKED","BDAS_BITDEFENDER_THREAT_QUARANTINED","BDAS_BITDEFENDER_THREAT_CLEANED","BDAS_BITDEFENDER_PURGE_QUARANTINE_FAILED","BDAS_BITDEFENDER_PURGE_QUARANTINE_SUCCESS","BDAS_BITDEFENDER_THREAT_QUARANTINE_RESTORED","BDAS_BITDEFENDER_THREAT_QUARANTINE_RESTORED_CUSTOMPATH","BDAS_BITDEFENDER_THREAT_QUARANTINE_DELETED","BITDEFENDER_RETRY_INSTALL_COMPLETED","BITDEFENDER_DISABLED","BITDEFENDER_EXISTING_PRODUCT_UNINSTALL","COMPETITOR_EXISTING_PRODUCT_UNINSTALL","SCHEDULE_INSTALL_OPTION_CHANGED","SECURITY_CREDENTIAL_ACCESS_GRANTED","SECURITY_CREDENTIAL_ACCESS_DENIED","PATCH_MANAGEMENT_SCAN_STARTED","PATCH_MANAGEMENT_SCAN_COMPLETED","PATCH_MANAGEMENT_APPLY_PATCH_STARTED","PATCH_MANAGEMENT_APPLY_PATCH_COMPLETED","PATCH_MANAGEMENT_INSTALLED","PATCH_MANAGEMENT_INSTALL_FAILED","PATCH_MANAGEMENT_MESSAGE","PATCH_MANAGEMENT_FAILURE","PATCH_MANAGEMENT_ROLLBACK_PATCH_REQUESTED","PATCH_MANAGEMENT_ROLLBACK_PATCH_STARTED","PATCH_MANAGEMENT_ROLLBACK_PATCH_COMPLETED","PATCH_MANAGEMENT_PATCH_APPROVED","PATCH_MANAGEMENT_PATCH_REJECTED","SOFTWARE_PATCH_MANAGEMENT_SCAN_STARTED","SOFTWARE_PATCH_MANAGEMENT_SCAN_COMPLETED","SOFTWARE_PATCH_MANAGEMENT_APPLY_PATCH_STARTED","SOFTWARE_PATCH_MANAGEMENT_APPLY_PATCH_COMPLETED","SOFTWARE_PATCH_MANAGEMENT_INSTALLED","SOFTWARE_PATCH_MANAGEMENT_INSTALL_FAILED","SOFTWARE_PATCH_MANAGEMENT_MESSAGE","SOFTWARE_PATCH_MANAGEMENT_PATCH_APPROVED","SOFTWARE_PATCH_MANAGEMENT_PATCH_REJECTED","SPLASHTOP_CONNECTION_INITIATED","SPLASHTOP_CONNECTION_ESTABLISHED","SPLASHTOP_CONNECTION_TERMINATED","REMOTE_TOOLS_UPLOAD_FILE_INITIATED","REMOTE_TOOLS_DOWNLOAD_FILE_INITIATED","REMOTE_TOOLS_COMPRESS_FILE_INITIATED","REMOTE_TOOLS_COMPRESS_FILE_SUCCESS","REMOTE_TOOLS_COMPRESS_FILE_FAILED","REMOTE_TOOLS_CREATE_DIRECTORY_INITIATED","REMOTE_TOOLS_RENAME_FILE_INITIATED","REMOTE_TOOLS_DELETE_FILE_INITIATED","REMOTE_TOOLS_MODIFY_OBJECT_SUCCESS","REMOTE_TOOLS_MODIFY_OBJECT_FAILED","REMOTE_TOOLS_COPY_OBJECT_SUCCESS","REMOTE_TOOLS_COPY_OBJECT_FAILED","REMOTE_TOOLS_MOVE_OBJECT_SUCCESS","REMOTE_TOOLS_MOVE_OBJECT_FAILED","REMOTE_TOOLS_DELETE_OBJECT_SUCCESS","REMOTE_TOOLS_DELETE_OBJECT_FAILED","REMOTE_TOOLS_CREATE_DIRECTORY_SUCCESS","REMOTE_TOOLS_CREATE_DIRECTORY_FAILED","REMOTE_TOOLS_FILE_TRANSFER_SUCCESS","REMOTE_TOOLS_FILE_TRANSFER_FAILED","REMOTE_TOOLS_SERVICE_CONTROL_INITIATED","REMOTE_TOOLS_START_SERVICE_SUCCESS","REMOTE_TOOLS_START_SERVICE_FAILED","REMOTE_TOOLS_STOP_SERVICE_SUCCESS","REMOTE_TOOLS_STOP_SERVICE_FAILED","REMOTE_TOOLS_RESTART_SERVICE_SUCCESS","REMOTE_TOOLS_RESTART_SERVICE_FAILED","REMOTE_TOOLS_START_TYPE_CHANGE_SUCCESS","REMOTE_TOOLS_START_TYPE_CHANGE_FAILED","REMOTE_TOOLS_PROCESS_CONTROL_INITIATED","REMOTE_TOOLS_SET_PROCESS_PRIORITY_SUCESS","REMOTE_TOOLS_SET_PROCESS_PRIORITY_FAILED","REMOTE_TOOLS_TERMINATE_PROCESS_SUCCESS","REMOTE_TOOLS_TERMINATE_PROCESS_FAILED","REMOTE_TOOLS_TERMINATE_PROCESS_TREE_SUCCESS","REMOTE_TOOLS_TERMINATE_PROCESS_TREE_FAILED","REMOTE_TOOLS_REGISTRY_CONTROL_INITIATED","REMOTE_TOOLS_CREATE_KEY_SUCCESS","REMOTE_TOOLS_CREATE_KEY_FAILED","REMOTE_TOOLS_RENAME_KEY_SUCCESS","REMOTE_TOOLS_RENAME_KEY_FAILED","REMOTE_TOOLS_DELETE_KEY_SUCCESS","REMOTE_TOOLS_DELETE_KEY_FAILED","REMOTE_TOOLS_CREATE_PARAMETER_SUCCESS","REMOTE_TOOLS_CREATE_PARAMETER_FAILED","REMOTE_TOOLS_RENAME_PARAMETER_SUCCESS","REMOTE_TOOLS_RENAME_PARAMETER_FAILED","REMOTE_TOOLS_DELETE_PARAMETER_SUCCESS","REMOTE_TOOLS_DELETE_PARAMETER_FAILED","REMOTE_TOOLS_MODIFY_PARAMETER_SUCCESS","REMOTE_TOOLS_MODIFY_PARAMETER_FAILED","REMOTE_TOOLS_ACTIVE_DIRECTORY_INITIATED","ADAPTER_ADDED","ADAPTER_REMOVED","ADAPTER_CONFIG_CHANGED","ADAPTER_STATUS_CHANGED","CPU_ADDED","CPU_REMOVED","MEMORY_ADDED","MEMORY_REMOVED","DISK_DRIVE_ADDED","DISK_DRIVE_REMOVED","USER_LOGGED_IN","USER_LOGGED_OUT","PORT_OPENED","PORT_CLOSED","WINDOWS_SERVICE_STARTED","WINDOWS_SERVICE_STOPPED","MAC_DAEMON_STARTED","MAC_DAEMON_STOPPED","USER_ACCOUNT_ADDED","USER_ACCOUNT_REMOVED","PROCESS_STARTED","PROCESS_STOPPED","SYSTEM_REBOOTED","SOFTWARE_ADDED","SOFTWARE_REMOVED","SOFTWARE_UPDATED","SOFTWARE_OS_UPDATED","DISK_PARTITION_ADDED","DISK_PARTITION_REMOVED","DISK_VOLUME_ADDED","DISK_VOLUME_REMOVED","CREDENTIALS_CHANGED","RAID_CONTROLLER_ADDED","RAID_CONTROLLER_REMOVED","RAID_PHYSICAL_DRIVE_ADDED","RAID_PHYSICAL_DRIVE_REMOVED","RAID_LOGICAL_DISK_ADDED","RAID_LOGICAL_DISK_REMOVED","BITLOCKER_ENABLED","BITLOCKER_DISABLED","FILEVAULT_ENABLED","FILEVAULT_DISABLED","TRUSTED_PLATFORM_MODULE_ENABLED","TRUSTED_PLATFORM_MODULE_DISABLED","TRUSTED_PLATFORM_MODULE_INSTALLED","TRUSTED_PLATFORM_MODULE_UNINSTALLED","SHADOWPROTECT_INSTALLED","SHADOWPROTECT_INSTALL_FAILED","SHADOWPROTECT_UNINSTALLED","SHADOWPROTECT_UNINSTALL_FAILED","SHADOWPROTECT_BACKUPJOB_FAILED","SHADOWPROTECT_BACKUPJOB_ABORTED","SHADOWPROTECT_LICENSE_PROVISIONED","SHADOWPROTECT_LICENSE_PROVISION_FAILED","SHADOWPROTECT_LICENSE_ACTIVATED","SHADOWPROTECT_LICENSE_ACTIVATION_FAILED","SHADOWPROTECT_LICENSE_DEACTIVATED","SHADOWPROTECT_LICENSE_DEACTIVATION_FAILED","IMAGEMANAGER_INSTALLED","IMAGEMANAGER_INSTALL_FAILED","IMAGEMANAGER_UNINSTALLED","IMAGEMANAGER_UNINSTALL_FAILED","IMAGEMANAGER_LICENSE_PROVISIONED","IMAGEMANAGER_LICENSE_PROVISION_FAILED","IMAGEMANAGER_LICENSE_ACTIVATED","IMAGEMANAGER_LICENSE_ACTIVATION_FAILED","IMAGEMANAGER_LICENSE_DEACTIVATED","IMAGEMANAGER_LICENSE_DEACTIVATION_FAILED","IMAGEMANAGER_CONSOLIDATION_FAILED","IMAGEMANAGER_VERIFICATION_FAILED","HELP_REQUEST_SUBMITTED","CLOUDBERRY_INSTALLED","CLOUDBERRY_INSTALL_FAILED","CLOUDBERRY_UNINSTALLED","CLOUDBERRY_UNINSTALL_FAILED","CLOUDBERRY_BACKUPPLAN_CREATED","CLOUDBERRY_BACKUPPLAN_EDITED","CLOUDBERRY_BACKUPPLAN_DELETED","CLOUDBERRY_BACKUPPLAN_CREATION_FAILED","CLOUDBERRY_BACKUPJOB_STARTED","CLOUDBERRY_BACKUPJOB_SUCCEEDED","CLOUDBERRY_BACKUPJOB_FAILED","CLOUDBERRY_BACKUPJOB_COMPLETED_WITH_WARNING","CLOUDBERRY_USER_CREATED","CLOUDBERRY_NETWORK_CREDENTIAL_CREATED","CLOUDBERRY_NETWORK_CREDENTIAL_CREATION_FAILED","RDP_CONNECTION_INITIATED","RDP_AUTO_PROVISION","SCHEDULED_TASK_CREATED","SCHEDULED_TASK_UPDATED","SCHEDULED_TASK_DELETED","SCRIPT_CREATED","SCRIPT_UPDATED","SCRIPT_DELETED","NINJA_BACKUP_BACKUPJOB_START_REQUESTED","NINJA_BACKUP_BACKUPJOB_STARTED","NINJA_BACKUP_BACKUPJOB_IN_PROCESS","NINJA_BACKUP_BACKUPJOB_COMPLETED","NINJA_BACKUP_BACKUPJOB_FAILED","NINJA_BACKUP_RESTOREJOB_START_REQUESTED","NINJA_BACKUP_RESTOREJOB_STARTED","NINJA_BACKUP_RESTOREJOB_IN_PROCESS","NINJA_BACKUP_RESTOREJOB_COMPLETED","NINJA_BACKUP_RESTOREJOB_FAILED","NINJA_BACKUP_BACKUPJOB_COMPLETED_WITH_WARNING","NINJA_BACKUP_BACKUP_DOWNLOADED","NINJA_BACKUP_BACKUPPLAN_ADDED","NINJA_BACKUP_BACKUPPLAN_EDITED","NINJA_BACKUP_BACKUPPLAN_DELETED","NINJA_BACKUP_BACKUPJOB_CANCELLED","NINJA_BACKUP_BACKUPJOB_PROCESSING","NINJA_BACKUP_INSTALL_FAILED","NINJA_BACKUP_UNINSTALL_FAILED","NINJA_BACKUP_INSTALLED","NINJA_BACKUP_UNINSTALLED","NINJA_BACKUP_RESTOREJOB_CANCELLED","NINJA_BACKUP_BACKUPPLAN_CREATION_FAILED","NINJA_BACKUP_BACKUP_CONFIGURE_FAILED","NINJA_BACKUP_FILE_DOWNLOAD","NINJA_BACKUP_FOLDER_DOWNLOAD","NINJA_BACKUP_UPSYNCJOB_START_REQUESTED","NINJA_BACKUP_UPSYNCJOB_PROCESSING","NINJA_BACKUP_UPSYNCJOB_IN_PROCESS","NINJA_BACKUP_UPSYNCJOB_STARTED","NINJA_BACKUP_UPSYNCJOB_COMPLETED","NINJA_BACKUP_UPSYNCJOB_CANCELLED","NINJA_BACKUP_UPSYNCJOB_FAILED","NINJA_BACKUP_BACKUP_NAS_ACCESS_FAILED","NINJA_BACKUP_IMAGE_RESTORE_STARTED","NINJA_BACKUP_IMAGE_RESTORE_COMPLETED","NINJA_BACKUP_IMAGE_RESTORE_FAILED","NINJA_BACKUP_IMAGE_DOWNLOAD_STARTED","NINJA_BACKUP_IMAGE_DOWNLOAD_COMPLETED","NINJA_BACKUP_IMAGE_DOWNLOAD_FAILED","NINJA_BACKUP_IMAGE_DOWNLOAD_FILE_STARTED","NINJA_BACKUP_IMAGE_DOWNLOAD_FILE_COMPLETED","NINJA_BACKUP_IMAGE_DOWNLOAD_FILE_FAILED","NINJA_BACKUP_IMAGE_MOUNT_COMPLETED","NINJA_BACKUP_IMAGE_MOUNT_FAILED","NINJA_BACKUP_INTEGRITY_CHECK_START_REQUESTED","NINJA_BACKUP_INTEGRITY_CHECK_STARTED","NINJA_BACKUP_INTEGRITY_CHECK_IN_PROCESS","NINJA_BACKUP_INTEGRITY_CHECK_COMPLETED","NINJA_BACKUP_INTEGRITY_CHECK_FAILED","NINJA_BACKUP_INTEGRITY_CHECK_CANCELLED","NINJA_BACKUP_IMAGE_DOWNLOAD_FOLDER_STARTED","NINJA_BACKUP_IMAGE_DOWNLOAD_FOLDER_COMPLETED","NINJA_BACKUP_IMAGE_DOWNLOAD_FOLDER_FAILED","BACKUP_IMAGE_RESTORE_CANCELED","BACKUP_IMAGE_DOWNLOAD_CANCELED","QC_INVITATION_CREATED","QC_INVITATION_DISABLED","QC_EXPIRED_INVITATION_BLOCKED","QC_INVITATION_UPDATED","QC_DEVICE_DELETED","QC_DEVICE_AGENT_INSTALL_REQUESTED","QC_SESSION_STARTED","QC_SESSION_TERMINATED","QC_SESSION_REPORT_SUBMITTED","REMOTE_SUPPORT_CREATED","REMOTE_SUPPORT_UPDATED","REMOTE_SUPPORT_DELETED","MDM_LOCK_DEVICE_STATUS_CREATED","MDM_REBOOT_DEVICE_STATUS_CREATED","MDM_RESET_PASSCODE_DEVICE_STATUS_CREATED","MDM_RELINQUISH_OWNERSHIP_DEVICE_STATUS_CREATED","MDM_LOCK_DEVICE_STATUS_UPDATED","MDM_REBOOT_DEVICE_STATUS_UPDATED","MDM_RESET_PASSCODE_DEVICE_STATUS_UPDATED","MDM_RELINQUISH_OWNERSHIP_DEVICE_STATUS_UPDATED","MDM_CLEAR_PASSCODE_STATUS_CREATED","MDM_CLEAR_PASSCODE_STATUS_UPDATED","MDM_ERASE_STATUS_CREATED","MDM_ERASE_STATUS_UPDATED","MDM_UPDATE_POLICY_STATUS_CREATED","MDM_UPDATE_POLICY_STATUS_UPDATED","MDM_ASSIGN_POLICY_STATUS_CREATED","MDM_ASSIGN_POLICY_STATUS_UPDATED","MDM_DIVISION_CONFIG_ENABLED","MDM_DIVISION_CONFIG_DISABLED","MDM_DIVISION_CONFIG_UPDATED","MDM_APN_CERTIFICATE_UPLOADED","MDM_ACTION_DEVICE_STATUS_FAILED","MDM_DISOWN_STATUS_FORBIDDEN","MDM_DISOWN_STATUS_COMPLETED","MDM_ADE_TOKEN_UPLOADED","MDM_ADE_TOKEN_RENEWED","MDM_RENEW_ENROLLMENT_PROFILE_STATUS_CREATED","MDM_RENEW_ENROLLMENT_PROFILE_STATUS_UPDATED","MDM_INSTALL_APP_STATUS_CREATED","MDM_APN_CERTIFICATE_RENEWED","MDM_CONNECTION_ANDROID_ENTERPRISE_RENAME_SUCCESS","MDM_CLEAR_APP_DATA_STATUS_CREATED","MDM_CLEAR_APP_DATA_STATUS_UPDATED","AOSP_ERASE_DEVICE_STATUS_CREATED","AOSP_ERASE_DEVICE_STATUS_COMPLETED","AOSP_LOCK_DEVICE_STATUS_CREATED","AOSP_LOCK_DEVICE_STATUS_UPDATED","AOSP_REBOOT_DEVICE_STATUS_CREATED","AOSP_REBOOT_DEVICE_STATUS_COMPLETED","AOSP_RESET_PASSCODE_DEVICE_STATUS_CREATED","AOSP_RESET_PASSCODE_DEVICE_STATUS_COMPLETED","AOSP_UPDATE_POLICY_STATUS_UPDATED","AOSP_NC_SESSION_REQUESTED","AOSP_NC_SESSION_STARTED","AOSP_NC_SESSION_TERMINATED","REPORT_TEMPLATE_CREATED","REPORT_TEMPLATE_UPDATED","REPORT_TEMPLATE_DELETED","REPORT_SCHEDULE_CREATED","REPORT_SCHEDULE_UPDATED","REPORT_SCHEDULE_DELETED","REPORT_TEMPLATE_DUPLICATED","REPORT_SCHEDULE_DUPLICATED","GRAVITYZONE_ENABLED","GRAVITYZONE_DISABLED","GRAVITYZONE_SCAN_STARTED","GRAVITYZONE_SCAN_COMPLETED","GRAVITYZONE_SCAN_FAILED","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE_FAILED","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE_FAILED","GRAVITYZONE_INSTALLATION_SUCCEEDED","GRAVITYZONE_INSTALLATION_SUCCEEDED_WITH_WARNINGS","GRAVITYZONE_INSTALLATION_FAILED","GRAVITYZONE_THREAT_IGNORED","GRAVITYZONE_THREAT_PRESENT","GRAVITYZONE_THREAT_DELETED","GRAVITYZONE_THREAT_BLOCKED","GRAVITYZONE_THREAT_REPORTED","GRAVITYZONE_THREAT_QUARANTINED","GRAVITYZONE_THREAT_CLEANED","GRAVITYZONE_PURGE_QUARANTINE_FAILED","GRAVITYZONE_PURGE_QUARANTINE_SUCCESS","GRAVITYZONE_THREAT_RESTORE_AND_EXCLUDED_FROM_QUARANTINE","GRAVITYZONE_THREAT_RESTORE_AND_EXCLUDED_FROM_QUARANTINE_FAILED","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE_COMPLETED","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE_COMPLETED","GRAVITYZONE_PROVISION_COMPLETED","GRAVITYZONE_PROVISION_FAILED","GRAVITYZONE_RETRY_INSTALL_COMPLETED","GRAVITYZONE_PARTNER_ASSIST_DISABLED","GRAVITYZONE_SCAN_ATTEMPT_COMPLETED","GRAVITYZONE_RESET_INACCESSIBLE_LICENSE_COMPLETED","GRAVITYZONE_THREAT_DELETE_FROM_QUARANTINE_REQUESTED","GRAVITYZONE_THREAT_RESTORE_FROM_QUARANTINE_REQUESTED","GRAVITYZONE_THREAT_RESTORE_AND_EXCLUDED_FROM_QUARANTINE_REQUESTED","GRAVITYZONE_INSTALLATION_STARTED","GRAVITYZONE_DOWNLOAD_FAILED","GRAVITYZONE_INSTALLATION_RETRY_STARTED","GRAVITYZONE_SCAN_CANCELLED","GRAVITYZONE_DISABLING_FAILED","GRAVITYZONE_INSTALLATION_EXISTS_DETECTED","GRAVITYZONE_THREAT_BLOCKED_FROM_ACTIVE_REQUESTED","GRAVITYZONE_THREAT_BLOCKED_FROM_ACTIVE_COMPLETED","GRAVITYZONE_THREAT_BLOCKED_FROM_ACTIVE_FAILED","GRAVITYZONE_DEVICE_MANAGED","GRAVITYZONE_DEVICE_UNMANAGED","GRAVITYZONE_COMPANY_CANNOT_BE_ACCESSED","GRAVITYZONE_QUARANTINED_THREAT_DELETED_OR_RESTORED","GRAVITYZONE_SUCCEEDED_TO_REQUEST_RECONFIGURE_TASK","GRAVITYZONE_FAILED_TO_REQUEST_RECONFIGURE_TASK","GRAVITYZONE_ADVANCED_THREAT_DISINFECTED","GRAVITYZONE_ADVANCED_THREAT_BLOCKED","GRAVITYZONE_INCIDENT_REPORTED","GRAVITYZONE_INCIDENT_VISIBILITY_FLAG_UPDATED","GRAVITYZONE_EXTENDED_INCIDENT_REPORTED","GRAVITYZONE_THREAT_STILL_PRESENT_AFTER_SCAN","ATTACHMENT_FILE_SUSPICIOUS","SMTP_SEND_ERROR","TECHNICIAN_ROLE_CREATED","TECHNICIAN_ROLE_UPDATED","TECHNICIAN_ROLE_DELETED","TECHNICIAN_ROLE_ASSIGNMENT_CHANGED","TECHNICIAN_PERMISSIONS_CHANGED","END_USER_ROLE_CREATED","END_USER_ROLE_UPDATED","END_USER_ROLE_DELETED","END_USER_ROLE_ASSIGNMENT_CHANGED","END_USER_PERMISSIONS_CHANGED","SENTINEL_ONE_AGENT_ENABLED","SENTINEL_ONE_AGENT_DISABLED","SENTINEL_ONE_AGENT_STARTED","SENTINEL_ONE_AGENT_UPGRADED","SENTINEL_ONE_AGENT_SHUT_DOWN","SENTINEL_ONE_AGENT_INSTALLATION_SUCCEEDED","SENTINEL_ONE_INSTALLATION_ANOTHER_AV_DETECTED","SENTINEL_ONE_AGENT_INSTALLATION_FAILED","SENTINEL_ONE_POLICY_CHANGED","SENTINEL_ONE_LOCAL_CONFIG_CHANGE_FAILED","SENTINEL_ONE_REGISTRATION_SUCCEEDED","SENTINEL_ONE_REGISTRATION_FAILED","SENTINEL_ONE_REMEDIATION_SUCCEEDED","SENTINEL_ONE_REMEDIATION_FAILED","SENTINEL_ONE_MITIGATION_SUCCEEDED","SENTINEL_ONE_MITIGATION_FAILED","SENTINEL_ONE_MITIGATION_REQUIRE_REBOOT","SENTINEL_ONE_MITIGATION_CANNOT_KILL","SENTINEL_ONE_MITIGATION_FAILED_TO_KILL","SENTINEL_ONE_QUARANTINE_SUCCEEDED","SENTINEL_ONE_QUARANTINE_FAILED","SENTINEL_ONE_UNQUARANTINE_SUCCEEDED","SENTINEL_ONE_UNQUARANTINE_FAILED","SENTINEL_ONE_THREAT_DETECTED","SENTINEL_ONE_SCAN_STARTED","SENTINEL_ONE_SCAN_COMPLETED","SENTINEL_ONE_SCAN_FAILED","SENTINEL_ONE_SCAN_ABORTED","SENTINEL_ONE_COMMAND_RECEIVED","SENTINEL_ONE_COMMAND_FAILED","SENTINEL_ONE_AGENT_UPGRADE_SUCCEEDED","SENTINEL_ONE_SITE_TOKEN_REGENERATED","SENTINEL_ONE_ON_DEMAND_SCAN_STARTED","SENTINEL_ONE_ON_DEMAND_SCAN_COMPLETED","SENTINEL_ONE_ON_DEMAND_SCAN_ABORTED","SENTINEL_ONE_RETRY_INSTALL_COMPLETED","SENTINEL_ONE_REFRESH_API_TOKEN_SUCCEEDED","SENTINEL_ONE_REFRESH_API_TOKEN_FAILED","SENTINEL_ONE_INTEGRATION_ENABLED","SENTINEL_ONE_INTEGRATION_DISABLED","SENTINEL_ONE_INTEGRATION_CREDENTIALS_UPDATED","SENTINEL_ONE_INTEGRATION_RESYNC_INITIATED","SENTINEL_ONE_INTEGRATION_RESYNC_REQUIRED","SENTINEL_ONE_EXISTING_INSTALLATION_DETECTED","SENTINEL_ONE_AGENT_SYNC_SUCCESS","SENTINEL_ONE_AGENT_SYNC_FAILED_RETRY","SENTINEL_ONE_AGENT_SYNC_FAILED","SENTINEL_ONE_AGENT_SYNC_CANCELLED","SENTINEL_ONE_AGENT_SYNC_MAPPING_FAILED","OAUTH2_CREATED","OAUTH2_UPDATED","OAUTH2_DELETED","CROWDSTRIKE_SENSOR_ENABLED","CROWDSTRIKE_SENSOR_DISABLED","CROWDSTRIKE_SENSOR_STARTED","CROWDSTRIKE_SENSOR_UPGRADED","CROWDSTRIKE_SENSOR_SHUT_DOWN","CROWDSTRIKE_SENSOR_INSTALLATION_SUCCEEDED","CROWDSTRIKE_SENSOR_INSTALLATION_FAILED","CROWDSTRIKE_REGISTRATION_SUCCEEDED","CROWDSTRIKE_REGISTRATION_FAILED","CROWDSTRIKE_REMEDIATION_SUCCEEDED","CROWDSTRIKE_REMEDIATION_FAILED","CROWDSTRIKE_MITIGATION_SUCCEEDED","CROWDSTRIKE_MITIGATION_FAILED","CROWDSTRIKE_QUARANTINE_SUCCEEDED","CROWDSTRIKE_QUARANTINE_FAILED","CROWDSTRIKE_THREAT_DETECTED","CROWDSTRIKE_MISSING_PERMISSIONS","CROWDSTRIKE_CREDENTIAL_INVALID","CROWDSTRIKE_INSTALLATION_ANOTHER_AV_DETECTED","CROWDSTRIKE_ENABLED","CROWDSTRIKE_DISABLED","CROWDSTRIKE_CREDENTIALS_UPDATED","CROWDSTRIKE_EXISTING_INSTALLATION_DETECTED","CROWDSTRIKE_RETRY_INSTALL_COMPLETED","CROWDSTRIKE_MISSING_API_CLIENT_SCOPE","CROWDSTRIKE_PARTNER_PROVISION_IN_PROGRESS","CROWDSTRIKE_PARTNER_PROVISION_COMPLETED","CROWDSTRIKE_PARTNER_PROVISION_FAILED","CROWDSTRIKE_CUSTOMER_PROVISION_IN_PROGRESS","CROWDSTRIKE_CUSTOMER_PROVISION_COMPLETED","CROWDSTRIKE_CUSTOMER_PROVISION_FAILED","CROWDSTRIKE_FALCON_COMPLETE_CREDENTIAL_INVALID","CROWDSTRIKE_MISSING_FALCON_COMPLETE_API_CLIENT_SCOPE","CROWDSTRIKE_UNMANAGED_INSTALLATION_DETECTED","CROWDSTRIKE_SENSOR_PROVISIONING","CROWDSTRIKE_SENSOR_MIGRATED","CROWDSTRIKE_CUSTOMER_BUNDLE_UPDATED","CROWDSTRIKE_CREDENTIAL_UNHEALTHY","CROWDSTRIKE_CREDENTIAL_VALIDATED","CROWDSTRIKE_FALCON_COMPLETE_CREDENTIAL_UNHEALTHY","CROWDSTRIKE_FALCON_COMPLETE_CREDENTIAL_VALIDATED","SERVICE_NOW_UPDATED","SERVICE_NOW_CONFIGURATION_ITEM_CLASS_MAPPING_CREATED","SERVICE_NOW_CONFIGURATION_ITEM_CLASS_MAPPING_UPDATED","SERVICE_NOW_CONFIGURATION_ITEM_CLASS_MAPPING_DELETED","SERVICE_NOW_RESET_AUTHENTICATION","SERVICE_NOW_NODE_SYNC_NODE_CREATED","SERVICE_NOW_NODE_SYNC_NODE_UPDATED","SERVICE_NOW_NODE_SYNC_NODE_ERROR","SERVICE_NOW_NODE_SYNC_BY_CLIENT_STARTED","SERVICE_NOW_NODE_SYNC_BY_CLIENT_COMPLETED","SERVICE_NOW_CLIENT_MAPPING_CREATED","SERVICE_NOW_CLIENT_MAPPING_UPDATED","SERVICE_NOW_CLIENT_MAPPING_DELETED","SERVICE_NOW_SYNC_CLIENT_ON_DEMAND","SERVICE_NOW_CLIENT_MAPPING_STATUS_UPDATED","ZENDESK_UPDATED","FRESHSERVICE_UPDATED","NINJA_TICKETING_CREATION_FAILED","NINJA_TICKETING_FORM_CREATED","NINJA_TICKETING_FORM_UPDATED","NINJA_TICKETING_FORM_ACTIVED","NINJA_TICKETING_FORM_DEACTIVED","NINJA_TICKETING_ATTRIBUTE_CREATED","NINJA_TICKETING_ATTRIBUTE_UPDATED","NINJA_TICKETING_ATTRIBUTE_ACTIVED","NINJA_TICKETING_ATTRIBUTE_DEACTIVATED","NINJA_TICKETING_RULESET_CREATED","NINJA_TICKETING_RULESET_UPDATED","NINJA_TICKETING_RULESET_DELETED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_CREATED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_UPDATED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_DELETED","NINJA_TICKETING_EMAIL_ADDRESS_CONFIG_MAKE_DEFAULT","NINJA_TICKETING_TRIGGER_CREATED","NINJA_TICKETING_TRIGGER_UPDATED","NINJA_TICKETING_TRIGGER_DELETED","NINJA_TICKETING_TICKET_CREATED","NINJA_TICKETING_TICKET_DELETED","NINJA_TICKETING_PENDING_EMAIL_CREATION_APPROVED","NINJA_TICKETING_PENDING_EMAIL_UPDATE_APPROVED","NINJA_TICKETING_PENDING_EMAIL_REJECTED","NINJA_TICKETING_ENABLED","NINJA_TICKETING_DISABLED","NINJA_TICKETING_UPDATED","NINJA_TICKETING_FORM_MAKE_DEFAULT","NINJA_TICKETING_CONDITION_RULE_MAKE_DEFAULT","NINJA_TICKETING_SCRIPT_RULE_MAKE_DEFAULT","NINJA_TICKETING_PENDING_EMAIL_RECEIVED","NINJA_TICKETING_EMAIL_ALLOWLIST_ITEM_CREATED","NINJA_TICKETING_EMAIL_ALLOWLIST_ITEM_UPDATED","NINJA_TICKETING_EMAIL_ALLOWLIST_ITEM_DELETED","NINJA_TICKETING_EMAIL_BLOCKLIST_ITEM_CREATED","NINJA_TICKETING_EMAIL_BLOCKLIST_ITEM_UPDATED","NINJA_TICKETING_EMAIL_BLOCKLIST_ITEM_DELETED","NINJA_TICKETING_TICKET_REINSTATED","NINJA_TICKETING_STATUS_CREATED","NINJA_TICKETING_STATUS_UPDATED","NINJA_TICKETING_STATUS_DELETED","NINJA_TICKETING_AGREEMENT_BULK_UPDATED","KNOWLEDGE_BASE_DOCUMENT_CREATED","KNOWLEDGE_BASE_DOCUMENT_UPDATED","KNOWLEDGE_BASE_DOCUMENT_ARCHIVED","KNOWLEDGE_BASE_DOCUMENT_RESTORED","KNOWLEDGE_BASE_DOCUMENT_DELETED","KNOWLEDGE_BASE_FOLDER_CREATED","KNOWLEDGE_BASE_FOLDER_UPDATED","KNOWLEDGE_BASE_FOLDER_ARCHIVED","KNOWLEDGE_BASE_FOLDER_RESTORED","KNOWLEDGE_BASE_FOLDER_DELETED","KNOWLEDGE_BASE_PUBLIC_TEMPORARY_TOKEN_CREATED","KNOWLEDGE_BASE_PUBLIC_LINK_CREATED","KNOWLEDGE_BASE_PUBLIC_LINK_UPDATED","KNOWLEDGE_BASE_PUBLIC_LINK_DELETED","KNOWLEDGE_BASE_FOLDER_MOVED","KNOWLEDGE_BASE_DOCUMENT_MOVED","KNOWLEDGE_BASE_FOLDER_SHARED","KNOWLEDGE_BASE_FOLDER_ACCESS_RESTRICTED","DOCUMENT_TEMPLATE_CREATED","DOCUMENT_TEMPLATE_UPDATED","DOCUMENT_TEMPLATE_ARCHIVED","DOCUMENT_TEMPLATE_RESTORED","DOCUMENT_TEMPLATE_DELETED","CLIENT_DOCUMENT_CREATED","CLIENT_DOCUMENT_UPDATED","CLIENT_DOCUMENT_ARCHIVED","CLIENT_DOCUMENT_RESTORED","CLIENT_DOCUMENT_DELETED","CLIENT_DOCUMENT_ATTRIBUTE_VALUE_DECRYPTED","CLIENT_DOCUMENT_REVISION_DELETED","CLIENT_DOCUMENTATION_DELEGATE_NODE_RESPONSIBILITY_ADDED","CLIENT_DOCUMENTATION_DELEGATE_NODE_RESPONSIBILITY_REMOVED","CLIENT_DOCUMENT_ATTRIBUTE_TEMPORARY_PUBLIC_TOKEN_CREATED","CLIENT_CHECKLIST_CREATED","CLIENT_CHECKLIST_UPDATED","CLIENT_CHECKLIST_DELETED","CLIENT_CHECKLIST_PROMOTED","CLIENT_CHECKLIST_TEMPORARY_PUBLIC_TOKEN_CREATED","CLIENT_CHECKLIST_ARCHIVED","CLIENT_CHECKLIST_RESTORED","CHECKLIST_TEMPLATE_CREATED","CHECKLIST_TEMPLATE_UPDATED","CHECKLIST_TEMPLATE_DELETED","CHECKLIST_TEMPLATE_ARCHIVED","CHECKLIST_TEMPLATE_RESTORED","RELATED_ITEM_CREATED","RELATED_ITEM_UPDATED","RELATED_ITEM_DELETED","RELATED_ITEM_SECURE_VALUE_DECRYPTED","RELATED_ITEM_TEMPORARY_PUBLIC_TOKEN_CREATED","ANTIVIRUS_THREAT_MUTED","ANTIVIRUS_THREAT_UNMUTED","SUPPLIER_CREATED","SUPPLIER_UPDATED","SUPPLIER_DELETED","MAINTENANCE_MODE_CONFIGURED","MAINTENANCE_MODE_DELETED","MAINTENANCE_MODE_MODIFIED","MAINTENANCE_MODE_FAILED","MAINTENANCE_MODE_ACTIVE","MAINTENANCE_MODE_UPDATED","MAINTENANCE_MODE_COMPLETED","SIEM_EXPORTER_WEBHOOK_CREATED","SIEM_EXPORTER_WEBHOOK_DELETED","SIEM_EXPORTER_WEBHOOK_ENABLED","SIEM_EXPORTER_WEBHOOK_DISABLED","SIEM_EXPORTER_WEBHOOK_UPDATED","SIEM_EXPORTER_WEBHOOK_DISPATCH_FAILURE","SIEM_EXPORTER_ENABLED","SIEM_EXPORTER_DISABLED"]},"status":{"type":"string","description":"Status description"},"activityResult":{"type":"string","description":"Activity result","enum":["SUCCESS","FAILURE","UNSUPPORTED","UNCOMPLETED","MISSED"]},"sourceConfigUid":{"type":"string","description":"Source configuration/policy element reference","format":"uuid"},"sourceName":{"type":"string","description":"Source configuration/policy element name"},"subject":{"type":"string","description":"Activity subject"},"userId":{"type":"integer","description":"User identifier","format":"int32"},"message":{"type":"string","description":"Activity message"},"type":{"type":"string","description":"Activity type description"},"data":{"type":"object","additionalProperties":true,"description":"Activity data"}}}}}},"AutomationScript":{"type":"object","properties":{"id":{"type":"integer","description":"Script ID","format":"int32"},"name":{"type":"string","description":"Script Name"},"description":{"type":"string","description":"Script Description"},"active":{"type":"boolean","description":"Script is Active"},"language":{"type":"string","description":"Script Language"},"architecture":{"uniqueItems":true,"type":"array","description":"Applicable Architectures","items":{"type":"string","description":"Applicable Architectures"}},"operatingSystems":{"uniqueItems":true,"type":"array","description":"Applicable Operating Systems","items":{"type":"string","description":"Applicable Operating Systems"}},"scriptParameters":{"type":"array","description":"Script Parameters","items":{"type":"string","description":"Script Parameters"}},"scriptVariables":{"type":"array","description":"Script Variables","items":{"type":"object","properties":{"id":{"type":"string","description":"Script Variable ID"},"name":{"type":"string","description":"Script Variable Name"},"description":{"type":"string","description":"Script Variable Description"},"type":{"type":"string","description":"Script Variable Type","enum":["CHECKBOX","DATE","DATETIME","DECIMAL","INTEGER","IPADDRESS","DROPDOWN","TEXT","OTHER"]},"source":{"type":"string","description":"Script Variable Source","enum":["LITERAL","OTHER"]},"defaultValue":{"type":"string","description":"Script Variable Default Value"},"required":{"type":"boolean","description":"Script Variable is Required"},"valueList":{"type":"array","description":"Script Variable List of Possible Values","items":{"type":"string","description":"Script Variable List of Possible Values"}}},"description":"Script Variables"}},"createdBy":{"type":"string","description":"Script Created By"},"lastUpdatedBy":{"type":"string","description":"Script Last Updated By"},"createdOn":{"type":"number","description":"Script date of creation","format":"double"},"updatedOn":{"type":"number","description":"Script last updated date","format":"double"}}},"ScriptVariable":{"type":"object","properties":{"id":{"type":"string","description":"Script Variable ID"},"name":{"type":"string","description":"Script Variable Name"},"description":{"type":"string","description":"Script Variable Description"},"type":{"type":"string","description":"Script Variable Type","enum":["CHECKBOX","DATE","DATETIME","DECIMAL","INTEGER","IPADDRESS","DROPDOWN","TEXT","OTHER"]},"source":{"type":"string","description":"Script Variable Source","enum":["LITERAL","OTHER"]},"defaultValue":{"type":"string","description":"Script Variable Default Value"},"required":{"type":"boolean","description":"Script Variable is Required"},"valueList":{"type":"array","description":"Script Variable List of Possible Values","items":{"type":"string","description":"Script Variable List of Possible Values"}}},"description":"Script Variables"},"NotificationChannel":{"type":"object","properties":{"id":{"type":"integer","description":"Notification Channel ID","format":"int32"},"name":{"type":"string","description":"Notification Channel Name"},"description":{"type":"string","description":"Notification Channel Description"},"enabled":{"type":"boolean","description":"Notification Channel Enabled"},"type":{"type":"string","description":"Notification Channel Type","enum":["EMAIL","META_CHANNEL","PAGER_DUTY","SLACK","SMS","MICROSOFT_TEAMS","WEBHOOK","OTHER"]}}},"Group":{"type":"object","properties":{"id":{"type":"integer","description":"Group identifier","format":"int32"},"name":{"type":"string","description":"Group Name"},"description":{"type":"string","description":"Group description"},"shared":{"type":"boolean","description":"Group is shared with all users?"},"created":{"type":"number","description":"Timestamp of group creation","format":"double"},"updated":{"type":"number","description":"Timestamp last update","format":"double"},"deviceCount":{"type":"integer","description":"Estimated/Last known device count.  Can be `null` if group membership has not been evaluated recently","format":"int32"},"lastEvaluated":{"type":"number","description":"Last evaluation time of group membership for nodes (search)","format":"double"}}},"LocationWithOrganizationRef":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"}}},"ScheduledTask":{"type":"object","properties":{"id":{"type":"integer","description":"Scheduled Task identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"enabled":{"type":"boolean","description":"Is Enabled ?"},"created":{"type":"number","description":"Timestamp of Scheduled Task creation","format":"double"},"lastRun":{"type":"number","description":"Timestamp of last Scheduled Task run","format":"double"},"runCount":{"type":"integer","description":"Number of times scheduled task ran","format":"int32"}}},"SoftwareProduct":{"type":"object","properties":{"id":{"type":"string","description":"Product identifier","format":"uuid"},"vendorName":{"type":"string","description":"Vendor Name"},"productName":{"type":"string","description":"Product Name"},"installable":{"type":"boolean","description":"Installable"},"active":{"type":"boolean","description":"Active"}}},"DeviceSearchMatch":{"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"score":{"type":"integer","description":"Match score","format":"int32"},"matchAttr":{"type":"string","description":"Name of the attribute that matched the query"},"matchAttrValue":{"type":"string","description":"Value of that attribute that matched"}},"description":"Devices matching search query"},"DeviceSearchResults":{"type":"object","properties":{"query":{"type":"string","description":"Search query"},"devices":{"type":"array","description":"Devices matching search query","items":{"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"},"score":{"type":"integer","description":"Match score","format":"int32"},"matchAttr":{"type":"string","description":"Name of the attribute that matched the query"},"matchAttrValue":{"type":"string","description":"Value of that attribute that matched"}},"description":"Devices matching search query"}}}},"BackupApiUpsyncJobDto":{"type":"object","properties":{"startTime":{"type":"number","description":"Upsync job start time","format":"double"},"endTime":{"type":"number","description":"Upsync job end time","format":"double"},"status":{"type":"string","description":"Upsync job status"},"filesUploaded":{"type":"integer","description":"Upsync job files uploaded","format":"int64"},"bytesUploaded":{"type":"integer","description":"Upsync job bytes uploaded","format":"int64"}},"description":"Upsync job details"},"BackupJob":{"type":"object","properties":{"jobId":{"type":"string","description":"Job id","format":"uuid"},"jobStartTime":{"type":"number","description":"Job start time","format":"double"},"jobEndTime":{"type":"number","description":"Job end time","format":"double"},"jobStatus":{"type":"string","description":"Job status"},"destination":{"type":"string","description":"Job destination"},"sourceJobId":{"type":"string","description":"Job source id","format":"uuid"},"planGuid":{"type":"string","description":"Plan id","format":"uuid"},"planName":{"type":"string","description":"Plan name"},"planType":{"type":"string","description":"Plan type"},"totalActualStorageBytes":{"type":"integer","description":"Total bytes","format":"int64"},"totalStoredBytes":{"type":"integer","description":"Total stored bytes","format":"int64"},"filesUploaded":{"type":"integer","description":"Files uploaded","format":"int64"},"organizationId":{"type":"integer","description":"Organization id","format":"int32"},"locationId":{"type":"integer","description":"Location id","format":"int32"},"deviceId":{"type":"integer","description":"Device id","format":"int32"},"upsyncJob":{"type":"object","properties":{"startTime":{"type":"number","description":"Upsync job start time","format":"double"},"endTime":{"type":"number","description":"Upsync job end time","format":"double"},"status":{"type":"string","description":"Upsync job status"},"filesUploaded":{"type":"integer","description":"Upsync job files uploaded","format":"int64"},"bytesUploaded":{"type":"integer","description":"Upsync job bytes uploaded","format":"int64"}},"description":"Upsync job details"}}},"BackupJobReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","items":{"type":"object","properties":{"jobId":{"type":"string","description":"Job id","format":"uuid"},"jobStartTime":{"type":"number","description":"Job start time","format":"double"},"jobEndTime":{"type":"number","description":"Job end time","format":"double"},"jobStatus":{"type":"string","description":"Job status"},"destination":{"type":"string","description":"Job destination"},"sourceJobId":{"type":"string","description":"Job source id","format":"uuid"},"planGuid":{"type":"string","description":"Plan id","format":"uuid"},"planName":{"type":"string","description":"Plan name"},"planType":{"type":"string","description":"Plan type"},"totalActualStorageBytes":{"type":"integer","description":"Total bytes","format":"int64"},"totalStoredBytes":{"type":"integer","description":"Total stored bytes","format":"int64"},"filesUploaded":{"type":"integer","description":"Files uploaded","format":"int64"},"organizationId":{"type":"integer","description":"Organization id","format":"int32"},"locationId":{"type":"integer","description":"Location id","format":"int32"},"deviceId":{"type":"integer","description":"Device id","format":"int32"},"upsyncJob":{"type":"object","properties":{"startTime":{"type":"number","description":"Upsync job start time","format":"double"},"endTime":{"type":"number","description":"Upsync job end time","format":"double"},"status":{"type":"string","description":"Upsync job status"},"filesUploaded":{"type":"integer","description":"Upsync job files uploaded","format":"int64"},"bytesUploaded":{"type":"integer","description":"Upsync job bytes uploaded","format":"int64"}},"description":"Upsync job details"}}}}}},"LockhartIntegrityCheckJob":{"type":"object","properties":{"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"device":{"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"}},"description":"Device information."},"jobId":{"type":"string","description":"Job id.","format":"uuid"},"jobStartTime":{"type":"number","description":"Job start time.","format":"double"},"jobEndTime":{"type":"number","description":"Job end time.","format":"double"},"jobStatus":{"type":"string","description":"Job status."},"planGuid":{"type":"string","description":"Plan id.","format":"uuid"},"planName":{"type":"string","description":"Plan name."},"planType":{"type":"string","description":"Plan type."},"totalActualStorageBytes":{"type":"integer","description":"Total bytes","format":"int64"},"totalActualStorageFiles":{"type":"integer","description":"Total files.","format":"int64"},"actualBytesChecked":{"type":"integer","description":"Bytes checked.","format":"int64"},"actualFilesChecked":{"type":"integer","description":"Files checked.","format":"int64"}},"description":"The integrity check job information."},"LockhartIntegrityCheckJobReport":{"type":"object","properties":{"cursor":{"type":"object","properties":{"name":{"type":"string"},"offset":{"type":"integer","format":"int32"},"count":{"type":"integer","format":"int32"},"expires":{"type":"number","format":"double"}}},"results":{"type":"array","description":"List of integrity check jobs.","items":{"type":"object","properties":{"deviceId":{"type":"integer","description":"Device identifier","format":"int32"},"device":{"type":"object","properties":{"id":{"type":"integer","description":"Node (Device) identifier","format":"int32"},"uid":{"type":"string","description":"Node (Device) UUID","format":"uuid"},"assignedOwnerUid":{"type":"string","description":"Node (Device) Owner UUID","format":"uuid"},"parentDeviceId":{"type":"integer","description":"Parent Node identifier","format":"int32"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"locationId":{"type":"integer","description":"Location identifier","format":"int32"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"nodeRoleId":{"type":"integer","description":"Node Role identifier","format":"int32"},"rolePolicyId":{"type":"integer","description":"Node Role policy ID based on organization and location Policy Mapping","format":"int32"},"policyId":{"type":"integer","description":"Assigned policy ID (overrides organization and location policy mapping)","format":"int32"},"approvalStatus":{"type":"string","description":"Approval Status","enum":["PENDING","STAGED","APPROVED","DECOMMISSIONED"]},"offline":{"type":"boolean","description":"Is Offline?"},"displayName":{"type":"string","description":"Display Name"},"systemName":{"type":"string","description":"System Name"},"dnsName":{"type":"string","description":"DNS Name"},"netbiosName":{"type":"string","description":"NETBIOS Name"},"created":{"type":"number","description":"Created","format":"double"},"lastContact":{"type":"number","description":"Last Contact","format":"double"},"lastUpdate":{"type":"number","description":"Last data submission timestamp","format":"double"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"tags":{"type":"array","description":"Tags","items":{"type":"string","description":"Tags"}},"maintenance":{"type":"object","properties":{"status":{"type":"string","description":"Maintenance mode status","enum":["PENDING","IN_MAINTENANCE","FAILED"]},"start":{"type":"number","description":"Maintenance mode start time","format":"double"},"end":{"type":"number","description":"Maintenance mode end time","format":"double"},"reasonMessage":{"type":"string","description":"Maintenance reason message"}},"description":"Maintenance mode status"},"references":{"type":"object","properties":{"organization":{"type":"object","properties":{"name":{"type":"string","description":"Organization full name"},"description":{"type":"string","description":"Organization Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"nodeApprovalMode":{"type":"string","description":"Device Approval Mode","enum":["AUTOMATIC","MANUAL","REJECT"]},"id":{"type":"integer","description":"Organization identifier","format":"int32"}},"description":"Organization"},"location":{"type":"object","properties":{"name":{"type":"string","description":"Location name"},"address":{"type":"string","description":"Address"},"description":{"type":"string","description":"Description"},"userData":{"type":"object","additionalProperties":true,"description":"Custom attributes"},"id":{"type":"integer","description":"Location identifier","format":"int32"}},"description":"Location"},"rolePolicy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"policy":{"type":"object","properties":{"id":{"type":"integer","description":"Policy identifier","format":"int32"},"parentPolicyId":{"type":"integer","description":"Parent Policy identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"updated":{"type":"number","description":"Last update timestamp","format":"double"},"nodeClassDefault":{"type":"boolean","description":"Is Default Policy for Node Class"}},"description":"Assigned policy (overrides organization and location policy mapping)"},"role":{"type":"object","properties":{"id":{"type":"integer","description":"Device Role identifier","format":"int32"},"name":{"type":"string","description":"Name"},"description":{"type":"string","description":"Description"},"nodeClass":{"type":"string","description":"Node Class","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]},"custom":{"type":"boolean","description":"Is custom node role?"},"chassisType":{"type":"string","description":"Chassis Type","enum":["UNKNOWN","DESKTOP","LAPTOP","MOBILE"]},"created":{"type":"number","description":"Date created","format":"double"},"nodeRoleParentId":{"type":"integer","description":"Node Role Parent Id","format":"int32"},"icon":{"type":"string","description":"Icon"}},"description":"Device Role"},"backupUsage":{"type":"object","properties":{"revisionsCurrentSize":{"type":"integer","description":"Revisions current size","format":"int64"},"revisionsPreviousSize":{"type":"integer","description":"Revisions previous size","format":"int64"},"revisionsDeletedSize":{"type":"integer","description":"Revisions deleted size","format":"int64"},"localFileFolderSize":{"type":"integer","description":"Revisions local file folder size","format":"int64"},"localImageSize":{"type":"integer","description":"Revisions local image size","format":"int64"},"localImageV2Size":{"type":"integer","description":"Revisions local image v2 size","format":"int64"},"cloudFileFolderSize":{"type":"integer","description":"Revisions cloud file folder size","format":"int64"},"cloudImageSize":{"type":"integer","description":"Revisions cloud image size","format":"int64"},"cloudImageV2Size":{"type":"integer","description":"Revisions cloud image v2 size","format":"int64"},"cloudNetworkShareSize":{"type":"integer","description":"Revisions cloud network share size","format":"int64"},"lastSuccessfulBackupJob":{"type":"number","description":"Last successful job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"lastFailedBackupJob":{"type":"number","description":"Last failed job. This is provided when the 'includeLastBackupJobTimes' query parameter is set to 'true'","format":"double"},"cloudTotalSize":{"type":"integer","description":"Revisions cloud total size","format":"int64","readOnly":true},"localTotalSize":{"type":"integer","description":"Revisions local total size","format":"int64","readOnly":true},"revisionsTotalSize":{"type":"integer","description":"Revisions total size","format":"int64","readOnly":true}},"description":"Device Backup Usage"},"warranty":{"type":"object","properties":{"startDate":{"type":"number","description":"Warranty Start Date (Seconds)","format":"double"},"endDate":{"type":"number","description":"Warranty End Date (Seconds)","format":"double"},"manufacturerFulfillmentDate":{"type":"number","description":"Manufacturer Fulfillment Date","format":"double"}},"description":"Warranty Info"},"assignedOwner":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"enabled":{"type":"boolean"},"administrator":{"type":"boolean"},"permitAllClients":{"type":"boolean"},"notifyAllClients":{"type":"boolean"},"mustChangePw":{"type":"boolean"},"mfaConfigured":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","enum":["REGISTERED","PENDING","EXPIRED"]},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"deviceIds":{"type":"array","description":"Device IDs which end-user is authorized to access","items":{"type":"integer","description":"Device IDs which end-user is authorized to access","format":"int32"}},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}}},"description":"Assigned device owner"},"backupBandwidthThrottle":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether bandwidth throttle is enabled/true or disabled/false"},"workHoursKbps":{"type":"integer","description":"Bandwidth work hours limit","format":"int32"},"nonWorkHoursKbps":{"type":"integer","description":"Bandwidth nonwork hours limit","format":"int32"},"workHoursUserUnit":{"type":"string","description":"Bandwidth work hours unit"},"nonWorkHoursUserUnit":{"type":"string","description":"Bandwidth nonwork hours unit"},"workSchedule":{"type":"object","properties":{"endHour":{"type":"integer","description":"Work schedule end hour (0 to 23)","format":"int32"},"endMinute":{"type":"integer","description":"Work schedule end minute (0 to 59)","format":"int32"},"startHour":{"type":"integer","description":"Work schedule start hour (0 to 23)","format":"int32"},"startMinute":{"type":"integer","description":"Work schedule start minute (0 to 59)","format":"int32"},"weekDays":{"type":"array","description":"Work schedule week days list","items":{"type":"string","description":"Work schedule week days list"}}},"description":"Bandwidth work schedule"}},"description":"Device Backup Bandwidth Throttle"}},"description":"Expanded entity references"}},"description":"Device information."},"jobId":{"type":"string","description":"Job id.","format":"uuid"},"jobStartTime":{"type":"number","description":"Job start time.","format":"double"},"jobEndTime":{"type":"number","description":"Job end time.","format":"double"},"jobStatus":{"type":"string","description":"Job status."},"planGuid":{"type":"string","description":"Plan id.","format":"uuid"},"planName":{"type":"string","description":"Plan name."},"planType":{"type":"string","description":"Plan type."},"totalActualStorageBytes":{"type":"integer","description":"Total bytes","format":"int64"},"totalActualStorageFiles":{"type":"integer","description":"Total files.","format":"int64"},"actualBytesChecked":{"type":"integer","description":"Bytes checked.","format":"int64"},"actualFilesChecked":{"type":"integer","description":"Files checked.","format":"int64"}},"description":"The integrity check job information."}}},"description":"The integrity check job report."},"TicketingAttributePublicApiDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"attributeType":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"customizeForEndUser":{"type":"boolean"},"nameForEndUser":{"type":"string"},"descriptionForEndUser":{"type":"string"},"endUserOption":{"type":"string"},"technicianOption":{"type":"string"},"content":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean"},"footerText":{"type":"string"},"tooltipText":{"type":"string"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}}},"system":{"type":"boolean"},"active":{"type":"boolean"},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"}}},"ContactResponseDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"clientId":{"type":"integer","format":"int32"},"clientName":{"type":"string"},"uid":{"type":"string","format":"uuid"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"jobTitle":{"type":"string"},"displayName":{"type":"string"},"manager":{"type":"object","properties":{"uid":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"deleted":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER","CONTACT"]},"displayName":{"type":"string"}}},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"}}},"ManagerDTO":{"type":"object","properties":{"uid":{"type":"string","format":"uuid"},"id":{"type":"integer","format":"int32"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"deleted":{"type":"boolean"},"userType":{"type":"string","enum":["TECHNICIAN","END_USER","CONTACT"]},"displayName":{"type":"string"}}},"FormScopeConfig":{"type":"object","properties":{"mode":{"type":"string","enum":["ALL","ALL_EXCEPT","ONLY"]},"ids":{"type":"array","items":{"type":"integer","format":"int32"}}}},"TicketFormContent":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"integer","format":"int32"}},"timerSettings":{"type":"object","properties":{"enabled":{"type":"boolean"},"mode":{"type":"string","enum":["MANUAL","AUTO_START"]}}},"scopeTicketTypes":{"type":"array","items":{"type":"string","enum":["PROBLEM","QUESTION","INCIDENT","TASK","CHANGE_REQUEST","SERVICE_REQUEST","PROJECT","APPOINTMENT","MISCELLANEOUS"]}},"scopeOrgs":{"type":"object","properties":{"mode":{"type":"string","enum":["ALL","ALL_EXCEPT","ONLY"]},"ids":{"type":"array","items":{"type":"integer","format":"int32"}}}},"scopeTechRoles":{"type":"object","properties":{"mode":{"type":"string","enum":["ALL","ALL_EXCEPT","ONLY"]},"ids":{"type":"array","items":{"type":"integer","format":"int32"}}}},"scopeEndUserRoles":{"type":"object","properties":{"mode":{"type":"string","enum":["ALL","ALL_EXCEPT","ONLY"]},"ids":{"type":"array","items":{"type":"integer","format":"int32"}}}}}},"TicketFormPublicApiDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"description":{"type":"string"},"endUserTitle":{"type":"string"},"content":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"integer","format":"int32"}},"timerSettings":{"type":"object","properties":{"enabled":{"type":"boolean"},"mode":{"type":"string","enum":["MANUAL","AUTO_START"]}}},"scopeTicketTypes":{"type":"array","items":{"type":"string","enum":["PROBLEM","QUESTION","INCIDENT","TASK","CHANGE_REQUEST","SERVICE_REQUEST","PROJECT","APPOINTMENT","MISCELLANEOUS"]}},"scopeOrgs":{"type":"object","properties":{"mode":{"type":"string","enum":["ALL","ALL_EXCEPT","ONLY"]},"ids":{"type":"array","items":{"type":"integer","format":"int32"}}}},"scopeTechRoles":{"type":"object","properties":{"mode":{"type":"string","enum":["ALL","ALL_EXCEPT","ONLY"]},"ids":{"type":"array","items":{"type":"integer","format":"int32"}}}},"scopeEndUserRoles":{"type":"object","properties":{"mode":{"type":"string","enum":["ALL","ALL_EXCEPT","ONLY"]},"ids":{"type":"array","items":{"type":"integer","format":"int32"}}}}}},"active":{"type":"boolean"},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"},"fields":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"attributeType":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"customizeForEndUser":{"type":"boolean"},"nameForEndUser":{"type":"string"},"descriptionForEndUser":{"type":"string"},"endUserOption":{"type":"string"},"technicianOption":{"type":"string"},"content":{"type":"object","properties":{"customizeForEndUser":{"type":"boolean"},"endUserCustomization":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"label":{"type":"string"}}},"values":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"active":{"type":"boolean"},"system":{"type":"boolean"}}}},"required":{"type":"boolean"},"footerText":{"type":"string"},"tooltipText":{"type":"string"},"advancedSettings":{"type":"object","properties":{"fileMaxSize":{"type":"integer","format":"int32"},"fileExtensions":{"type":"array","items":{"type":"string"}},"dateFilters":{"type":"object","properties":{"type":{"type":"string","description":"Date filtering options for date/time custom fields","enum":["NONE","INCLUDE","EXCLUDE","PAST_DATES_ONLY","FUTURE_DATES_ONLY","RANGE"]},"selected":{"type":"array","items":{"type":"string"}}}},"maxCharacters":{"type":"integer","format":"int32"},"maxWysiwygHtmlCharacters":{"type":"integer","format":"int32"},"complexityRules":{"type":"object","properties":{"mustContainOneInteger":{"type":"boolean"},"mustContainOneLowercaseLetter":{"type":"boolean"},"mustContainOneUppercaseLetter":{"type":"boolean"},"greaterOrEqualThanSixCharacters":{"type":"boolean"}}},"numericRange":{"type":"object","properties":{"min":{"type":"number"},"max":{"type":"number"}}},"org":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeClass":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["WINDOWS_SERVER","WINDOWS_WORKSTATION","LINUX_WORKSTATION","MAC","ANDROID","APPLE_IOS","APPLE_IPADOS","AOSP","CHROMEOS","VMWARE_VM_HOST","VMWARE_VM_GUEST","HYPERV_VMM_HOST","HYPERV_VMM_GUEST","LINUX_SERVER","MAC_SERVER","CLOUD_MONITOR_TARGET","NMS_SWITCH","NMS_ROUTER","NMS_FIREWALL","NMS_PRIVATE_NETWORK_GATEWAY","NMS_PRINTER","NMS_SCANNER","NMS_DIAL_MANAGER","NMS_WAP","NMS_IPSLA","NMS_COMPUTER","NMS_VM_HOST","NMS_APPLIANCE","NMS_OTHER","NMS_SERVER","NMS_PHONE","NMS_VIRTUAL_MACHINE","NMS_NETWORK_MANAGEMENT_AGENT","UNMANAGED_DEVICE","MANAGED_DEVICE"]}},"ipAddressType":{"type":"string","description":"IP address validation type for IP address custom fields","enum":["ALL","IPV4","IPV6"]},"expandLargeValueOnRender":{"type":"boolean"},"identifier":{"type":"object","properties":{"automaticGenerationEnabled":{"type":"boolean"},"scope":{"type":"string","enum":["NONE","GLOBAL","ORGANIZATION"]},"assignTo":{"type":"string","enum":["NEW_ASSETS_ONLY","NEW_AND_EXISTING_ASSETS"]},"type":{"type":"string","enum":["CUSTOM","SEQUENCE"]},"nextSequenceNumber":{"type":"integer","format":"int64"},"prefix":{"type":"string"},"suffix":{"type":"string"}}},"monetary":{"type":"object","properties":{"currency":{"type":"string","enum":["USD","EUR","CAD","GBP","AUD","JPY","SEK","NOK","DKK","CHF","AED","AFN","ALL","AMD","AOA","ARS","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CDF","CHE","CHW","CLF","CLP","CNY","COP","CRC","CVE","CZK","DJF","DOP","DZD","EGP","ERN","ETB","FJD","FKP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IRR","ISK","JMD","JOD","KES","KGS","KHR","KMF","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYI","UYU","UZS","VES","VND","VUV","WST","XAD","XAF","XCD","XPF","YER","ZAR","ZMW","ZWG"]}}},"templates":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"nodeRole":{"uniqueItems":true,"type":"array","items":{"type":"integer","format":"int32"}},"healthStatus":{"type":"object","properties":{"allowedStatuses":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["UNHEALTHY","NEEDS_ATTENTION","HEALTHY","UNKNOWN"]}}}}}}}},"system":{"type":"boolean"},"active":{"type":"boolean"},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"}}}},"default":{"type":"boolean"}}},"TimerSettings":{"type":"object","properties":{"enabled":{"type":"boolean"},"mode":{"type":"string","enum":["MANUAL","AUTO_START"]}}},"Condition":{"type":"object","properties":{"any":{"uniqueItems":true,"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"},"params":{"type":"object","properties":{"repeat":{"type":"boolean"},"value":{"type":"string"}}}}}},"all":{"uniqueItems":true,"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"},"params":{"type":"object","properties":{"repeat":{"type":"boolean"},"value":{"type":"string"}}}}}}}},"Rule":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"},"params":{"type":"object","properties":{"repeat":{"type":"boolean"},"value":{"type":"string"}}}}},"TicketingBoardPublicApiDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"uid":{"type":"string","format":"uuid"},"name":{"type":"string"},"description":{"type":"string"},"conditions":{"type":"object","properties":{"any":{"uniqueItems":true,"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"},"params":{"type":"object","properties":{"repeat":{"type":"boolean"},"value":{"type":"string"}}}}}},"all":{"uniqueItems":true,"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"},"params":{"type":"object","properties":{"repeat":{"type":"boolean"},"value":{"type":"string"}}}}}}}},"createTime":{"type":"number","format":"double"},"updateTime":{"type":"number","format":"double"},"system":{"type":"boolean"},"columns":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"sortBy":{"uniqueItems":true,"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}},"ticketCount":{"type":"integer","format":"int32"}}},"TicketingTriggerRepeatParameters":{"type":"object","properties":{"repeat":{"type":"boolean"},"value":{"type":"string"}}},"AttributeData":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]}}},"SortBy":{"type":"object","properties":{"field":{"type":"string"},"direction":{"type":"string","enum":["ASC","DESC"]}}},"TicketDashboardPublicApiDTO":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}},"metadata":{"type":"object","properties":{"columns":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"sortBy":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"direction":{"type":"string","enum":["ASC","DESC"]}}}},"attributes":{"type":"object","additionalProperties":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]}}}},"filters":{"uniqueItems":true,"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"},"params":{"type":"object","properties":{"repeat":{"type":"boolean"},"value":{"type":"string"}}}}}},"lastCursorId":{"type":"integer","format":"int32"},"allRequiredColumns":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"allColumns":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"columnNamesForExporting":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}}}},"TicketMetadata":{"type":"object","properties":{"columns":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"sortBy":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"direction":{"type":"string","enum":["ASC","DESC"]}}}},"attributes":{"type":"object","additionalProperties":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","description":"The type of custom field that determines how data is stored and displayed","enum":["DROPDOWN","MULTI_SELECT","CHECKBOX","TEXT","TEXT_MULTILINE","TEXT_ENCRYPTED","NUMERIC","DECIMAL","DATE","DATE_TIME","TIME","ATTACHMENT","NODE_DROPDOWN","NODE_MULTI_SELECT","CLIENT_DROPDOWN","CLIENT_MULTI_SELECT","CLIENT_LOCATION_DROPDOWN","CLIENT_LOCATION_MULTI_SELECT","CLIENT_DOCUMENT_DROPDOWN","CLIENT_DOCUMENT_MULTI_SELECT","EMAIL","PHONE","IP_ADDRESS","WYSIWYG","URL","MONETARY","IDENTIFIER","TOTP","HEALTH_STATUS"]}}}},"filters":{"uniqueItems":true,"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"},"params":{"type":"object","properties":{"repeat":{"type":"boolean"},"value":{"type":"string"}}}}}},"lastCursorId":{"type":"integer","format":"int32"},"allRequiredColumns":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"allColumns":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"columnNamesForExporting":{"uniqueItems":true,"type":"array","items":{"type":"string"}}}},"TicketBoardScrollingRequestDTO":{"type":"object","properties":{"sortBy":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"direction":{"type":"string","enum":["ASC","DESC"]}}}},"filters":{"uniqueItems":true,"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"operator":{"type":"string"},"value":{"type":"string"},"params":{"type":"object","properties":{"repeat":{"type":"boolean"},"value":{"type":"string"}}}}}},"pageSize":{"maximum":1000,"minimum":1,"type":"integer","format":"int32"},"searchCriteria":{"maxLength":512,"minLength":0,"type":"string"},"includeColumns":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"lastCursorId":{"maximum":10000000,"minimum":0,"type":"integer","format":"int32"}}},"AppUserAndContactPublicApiDTO":{"type":"object","properties":{"uid":{"type":"string","description":"Global identifier for the user","format":"uuid"},"id":{"type":"integer","description":"User identifier","format":"int32"},"clientId":{"type":"integer","description":"Client identifier","format":"int32"},"firstName":{"type":"string","description":"The user's first name"},"lastName":{"type":"string","description":"The user's last name"},"email":{"type":"string","description":"The user's email address"},"userType":{"type":"string","description":"System User Type","enum":["TECHNICIAN","END_USER","CONTACT"]},"naturalId":{"type":"string","description":"Last User Identifier"}}},"EndUser":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"enabled":{"type":"boolean","description":"User access status"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"email":{"type":"string","description":"Email address"},"phone":{"type":"string","description":"Phone number"},"organizationId":{"type":"integer","description":"Identifier of organization for end-users","format":"int32"},"fullPortalAccess":{"type":"boolean","description":"Has full portal access"},"mustChangePw":{"type":"boolean","description":"Must change password during next login"},"mfaConfigured":{"type":"boolean","description":"At least one MFA method is configured"},"scimUser":{"type":"boolean","description":"User created by SCIM"},"authType":{"type":"string","description":"Authentication type, NATIVE or SSO"},"invitationStatus":{"type":"string","description":"User invitation status","enum":["REGISTERED","PENDING","EXPIRED"]},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"accessibleDeviceIds":{"type":"array","description":"Device IDs which user has access to","items":{"type":"integer","description":"Device IDs which user has access to","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'"}},"managerUid":{"type":"string","description":"Manager identifier","format":"uuid"}}},"CreateEndUserRequest":{"required":["email","firstName","lastName"],"type":"object","properties":{"firstName":{"maxLength":150,"minLength":1,"type":"string","description":"First name should be between 1 and 150 characters"},"lastName":{"maxLength":150,"minLength":1,"type":"string","description":"Last name should be between 1 and 150 characters"},"email":{"type":"string","description":"Email address"},"phone":{"type":"string","description":"Phone number"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"fullPortalAccess":{"type":"boolean","description":"Gives end user full portal access"},"managerUid":{"type":"string","description":"Manager identifier","format":"uuid"}},"description":"Create end user request payload"},"EndUserPatchRequest":{"type":"object","properties":{"firstName":{"maxLength":150,"minLength":1,"type":"string","description":"First name should be between 1 and 150 characters"},"lastName":{"maxLength":150,"minLength":1,"type":"string","description":"Last name should be between 1 and 150 characters"},"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"fullPortalAccess":{"type":"boolean","description":"Gives end user full portal access"},"managerUid":{"type":"string","description":"Manager identifier","format":"uuid"}},"description":"Patch end user request payload"},"EndUserAccessibleDevicesPatchRequest":{"type":"object","properties":{"addDeviceIds":{"type":"array","description":"List of device IDs to add access for the end user","items":{"type":"integer","description":"List of device IDs to add access for the end user","format":"int32"}},"removeDeviceIds":{"type":"array","description":"List of device IDs to remove access for the end user","items":{"type":"integer","description":"List of device IDs to remove access for the end user","format":"int32"}}},"description":"Patch end user accessible devices request payload"},"Technician":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"uid":{"type":"string","description":"User universally unique identifier","format":"uuid"},"enabled":{"type":"boolean","description":"User access status"},"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"email":{"type":"string","description":"Email address"},"phone":{"type":"string","description":"Phone number"},"mustChangePw":{"type":"boolean","description":"Must change password during next login"},"mfaConfigured":{"type":"boolean","description":"At least one MFA method is configured"},"scimUser":{"type":"boolean","description":"User is created by SCIM?"},"authType":{"type":"string","description":"Native or SSO authentication"},"userType":{"type":"string","description":"User type","enum":["TECHNICIAN","END_USER"]},"invitationStatus":{"type":"string","description":"User invitation status","enum":["REGISTERED","PENDING","EXPIRED"]},"notifyAllClients":{"type":"boolean","description":"Notifications for all clients"},"administrator":{"type":"boolean","description":"Technician is a System Administrator"},"assignedDeviceIds":{"type":"array","description":"Device IDs which user is assigned","items":{"type":"integer","description":"Device IDs which user is assigned","format":"int32"}},"roles":{"type":"array","description":"A list of role names assigned to the technician. This is provided when the 'includeRoles' query parameter is set to 'true'","items":{"type":"string","description":"A list of role names assigned to the technician. This is provided when the 'includeRoles' query parameter is set to 'true'"}},"managerUid":{"type":"string","description":"Manager identifier","format":"uuid"}}},"CreateTechnicianRequest":{"required":["email","firstName","lastName"],"type":"object","properties":{"firstName":{"maxLength":150,"minLength":1,"type":"string","description":"First name should be between 1 and 150 characters"},"lastName":{"maxLength":150,"minLength":1,"type":"string","description":"Last name should be between 1 and 150 characters"},"email":{"type":"string","description":"Email address"},"phone":{"type":"string","description":"Phone number"},"managerUid":{"type":"string","description":"Manager identifier","format":"uuid"}},"description":"Create technician request payload"},"UpdateTechnicianRequest":{"type":"object","properties":{"firstName":{"type":"string","description":"First name"},"lastName":{"type":"string","description":"Last name"},"managerUid":{"type":"string","description":"Manager identifier","format":"uuid"}},"description":"Update technician request payload"},"RoleMember":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"email":{"type":"string","description":"User email"},"name":{"type":"string","description":"User full name"},"source":{"type":"string","description":"Source of role assignment"}},"description":"Role members"},"UserRole":{"type":"object","properties":{"id":{"type":"integer","description":"Role identifier","format":"int32"},"name":{"type":"string","description":"Role name"},"type":{"type":"string","description":"Role type"},"description":{"type":"string","description":"Role description"},"members":{"type":"array","description":"Role members","items":{"type":"object","properties":{"id":{"type":"integer","description":"User identifier","format":"int32"},"email":{"type":"string","description":"User email"},"name":{"type":"string","description":"User full name"},"source":{"type":"string","description":"Source of role assignment"}},"description":"Role members"}}}},"OrganizationPermissionEntry":{"type":"object","properties":{"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"organizationName":{"type":"string","description":"Organization name"},"permission":{"type":"string","description":"Permissions for the organization.","enum":["default","noAccess","view","viewUpdate","viewUpdateDelete"]}},"description":"Organization permissions updated for the provided role"},"RoleOrganizationPermission":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","description":"Role name"},"description":{"type":"string","description":"Role description"},"organizationPermissions":{"type":"array","description":"Organization permissions updated for the provided role","items":{"type":"object","properties":{"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"organizationName":{"type":"string","description":"Organization name"},"permission":{"type":"string","description":"Permissions for the organization.","enum":["default","noAccess","view","viewUpdate","viewUpdateDelete"]}},"description":"Organization permissions updated for the provided role"}}}},"OrganizationPermissionPatchRequest":{"required":["organizationId","permission"],"type":"object","properties":{"organizationId":{"type":"integer","description":"Organization identifier","format":"int32"},"permission":{"type":"string","description":"Permissions for the organization.","enum":["default","noAccess","view","viewUpdate","viewUpdateDelete"]}},"description":"Organization permission entry for a role"}},"securitySchemes":{"oauth2":{"type":"http","scheme":"bearer","bearerFormat":"bearer"},"sessionKey":{"type":"apiKey","name":"sessionKey","in":"cookie"}}}}