> For the complete documentation index, see [llms.txt](https://documentation.ocsinventory-ng.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.ocsinventory-ng.org/open-api-reference/models.md). # Models ## The AccountinfoConfig object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"AccountinfoConfig":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":100},"description":{"type":"string","maxLength":512},"datatype":{"$ref":"#/components/schemas/DatatypeEnum"},"datatarget":{"allOf":[{"$ref":"#/components/schemas/DatatargetEnum"}],"default":"ASSET"},"accountinfo_values":{"type":"array","items":{"type":"integer"},"readOnly":true}},"required":["accountinfo_values","description","id","name"]},"DatatypeEnum":{"enum":["TEXT","TEXTAREA","SELECT","CHECKBOX"],"type":"string","description":"* `TEXT` - Text\n* `TEXTAREA` - Textarea\n* `SELECT` - Select\n* `CHECKBOX` - Checkbox"},"DatatargetEnum":{"enum":["ASSET","IPDISCOVER"],"type":"string","description":"* `ASSET` - Assets\n* `IPDISCOVER` - IPDiscover"}}}} ``` ## The AccountinfoData object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"AccountinfoData":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"accountdata":{"nullable":true},"object_slug":{"type":"string","nullable":true,"maxLength":100},"content_type":{"type":"integer","readOnly":true},"object_id":{"type":"integer","maximum":9223372036854776000,"minimum":0,"format":"int64"}},"required":["content_type","id","object_id"]}}}} ``` ## The AccountinfoValue object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"AccountinfoValue":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"accountinfo_config":{"type":"integer"},"value":{"type":"string","maxLength":100}},"required":["accountinfo_config","id","value"]}}}} ``` ## The Action object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Action":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"rule":{"type":"integer","nullable":true},"priority":{"type":"integer"},"action":{"$ref":"#/components/schemas/ActionEnum"},"content_type":{"type":"integer","nullable":true},"object_id":{"type":"integer","maximum":9223372036854776000,"minimum":0,"format":"int64","nullable":true},"object_slug":{"type":"string","nullable":true,"maxLength":100},"field":{"type":"string","maxLength":255},"value":{}},"required":["action","field","id","value"]},"ActionEnum":{"enum":["set"],"type":"string","description":"* `set` - Set"}}}} ``` ## The ActionEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"ActionEnum":{"enum":["set"],"type":"string","description":"* `set` - Set"}}}} ``` ## The ApiCheckResponse object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"ApiCheckResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}} ``` ## The AssetEOLStatus object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"AssetEOLStatus":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"asset":{"type":"integer","readOnly":true},"asset_name":{"type":"string","readOnly":true},"product":{"type":"string","readOnly":true,"nullable":true},"cycle":{"type":"string","readOnly":true,"nullable":true},"eol":{"type":"string","readOnly":true,"nullable":true},"is_eol":{"type":"boolean","readOnly":true},"support":{"type":"boolean","readOnly":true},"support_date":{"type":"string","readOnly":true,"nullable":true},"latest":{"type":"string","readOnly":true,"nullable":true},"fetched_at":{"type":"string","format":"date-time","readOnly":true}},"required":["asset","asset_name","cycle","eol","fetched_at","id","is_eol","latest","product","support","support_date"]}}}} ``` ## The AssetGroup object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"AssetGroup":{"type":"object","description":"Serializer class for AssetGroup","properties":{"id":{"type":"integer","readOnly":true},"visibility":{"$ref":"#/components/schemas/VisibilityEnum"},"allow_group_modification":{"type":"boolean"},"name":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true,"maxLength":255},"is_dynamic":{"type":"boolean"},"search":{"nullable":true},"last_updated":{"type":"string","format":"date-time","readOnly":true},"user":{"type":"integer"},"groups":{"type":"array","items":{"type":"integer"}},"assets":{"type":"array","items":{"type":"integer"}}},"required":["id","last_updated","name","user"]},"VisibilityEnum":{"enum":["public","private_personal","private_group"],"type":"string","description":"* `public` - Public\n* `private_personal` - Private (Personal)\n* `private_group` - Private (Group)"}}}} ``` ## The AuthConfig object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"AuthConfig":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"auth_method":{"type":"integer","nullable":true},"enabled":{"type":"boolean"},"priority":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"config":{},"mappings":{"type":"array","items":{"type":"integer"}}},"required":["config","id","mappings"]}}}} ``` ## The AuthLevelEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"AuthLevelEnum":{"enum":["noAuthNoPriv","authNoPriv","authPriv"],"type":"string","description":"* `noAuthNoPriv` - noAuthNoPriv\n* `authNoPriv` - authNoPriv\n* `authPriv` - authPriv"}}}} ``` ## The AuthMapping object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"AuthMapping":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"auth_config":{"type":"integer","nullable":true},"internal_field":{"type":"string","maxLength":255},"external_field":{"type":"string","maxLength":255}},"required":["external_field","id","internal_field"]}}}} ``` ## The AuthMethod object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"AuthMethod":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"auth_type":{"$ref":"#/components/schemas/AuthTypeEnum"},"enabled":{"type":"boolean"},"priority":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"configs":{"type":"array","items":{"type":"integer"}}},"required":["auth_type","configs","id","name"]},"AuthTypeEnum":{"enum":["SSO","OTHER"],"type":"string","description":"* `SSO` - SSO\n* `OTHER` - OTHER"}}}} ``` ## The AuthProtocolEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"AuthProtocolEnum":{"enum":["MD5","SHA","None"],"type":"string","description":"* `MD5` - MD5\n* `SHA` - SHA\n* `None` - None"}}}} ``` ## The AuthToken object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"AuthToken":{"type":"object","properties":{"username":{"type":"string","writeOnly":true},"password":{"type":"string","writeOnly":true},"token":{"type":"string","readOnly":true}},"required":["password","token","username"]}}}} ``` ## The AuthTypeEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"AuthTypeEnum":{"enum":["SSO","OTHER"],"type":"string","description":"* `SSO` - SSO\n* `OTHER` - OTHER"}}}} ``` ## The BlankEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"BlankEnum":{"enum":[""]}}}} ``` ## The Category object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Category":{"type":"object","description":"This serialize class provide the API representation\n\nArgs:\n serializers ([ModelSerializer])","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"description":{"type":"string","maxLength":255},"inventory_sections":{"type":"array","items":{"type":"integer"}},"is_protected":{"type":"boolean"}},"required":["description","id","name"]}}}} ``` ## The CollectionError object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"CollectionError":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}} ``` ## The CollectionResponse object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"CollectionResponse":{"type":"object","description":"Response shape on successful asset creation/update","properties":{"message":{"type":"string"},"id":{"type":"integer"}},"required":["id","message"]}}}} ``` ## The ComplianceResult object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"ComplianceResult":{"type":"object","description":"Mixin to dynamically expand nested fields based on the \"expand\" query parameter.\n\nTo use, add an `expandable_fields` dictionary in your serializer's Meta:\n\n expandable_fields = {\n \"some_relation\": SomeNestedSerializer,\n \"other_relation\": OtherNestedSerializer,\n }\n\nThe mixin will:\n - Expand all fields and childs if expand=\"*\"\n - Expand fields provided in a comma separated list (expand=field1,field2)\n - or return the pks for the relation","properties":{"id":{"type":"integer","readOnly":true},"asset":{"type":"integer"},"asset_name":{"type":"string","readOnly":true},"rule":{"type":"integer"},"status":{"$ref":"#/components/schemas/ComplianceResultStatusEnum"},"detail":{"nullable":true},"evaluated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["asset","asset_name","evaluated_at","id","rule"]},"ComplianceResultStatusEnum":{"enum":["compliant","non_compliant","unknown"],"type":"string","description":"* `compliant` - Compliant\n* `non_compliant` - Non-compliant\n* `unknown` - Unknown"}}}} ``` ## The ComplianceResultStatusEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"ComplianceResultStatusEnum":{"enum":["compliant","non_compliant","unknown"],"type":"string","description":"* `compliant` - Compliant\n* `non_compliant` - Non-compliant\n* `unknown` - Unknown"}}}} ``` ## The ComplianceRule object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"ComplianceRule":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true,"maxLength":255},"type":{"type":"string","maxLength":50},"severity":{"$ref":"#/components/schemas/SeverityEnum"},"logic":{},"enabled":{"type":"boolean"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["created_at","id","logic","name","type","updated_at"]},"SeverityEnum":{"enum":["critical","high","medium","low"],"type":"string","description":"* `critical` - Critical\n* `high` - High\n* `medium` - Medium\n* `low` - Low"}}}} ``` ## The ComplianceType object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"ComplianceType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50}},"required":["id","name"]}}}} ``` ## The Config object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Config":{"type":"object","description":"This serialize class provide the API representation","properties":{"name":{"type":"string","maxLength":100},"value":{}},"required":["name","value"]}}}} ``` ## The CustomEOLExtendedSupport object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"CustomEOLExtendedSupport":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"product":{"type":"string","description":"endoflife.date product slug (e.g. ubuntu)","maxLength":100},"cycle":{"type":"string","description":"Version cycle (e.g. 22.04)","maxLength":50},"is_extended":{"type":"boolean","description":"Whether purchased extended support is active for this product/cycle"}},"required":["cycle","id","product"]}}}} ``` ## The DashboardChartCounter object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"DashboardChartCounter":{"type":"object","description":"Response shape for the *Counter* charts (total_ALL, total_WIN, ...)","properties":{"total":{"type":"integer"},"contacted":{"type":"integer"}},"required":["contacted","total"]}}}} ``` ## The DashboardChartDescriptor object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"DashboardChartDescriptor":{"type":"object","description":"Describes one chart available on the dashboard (returned by the list action)","properties":{"category":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"charttype":{"type":"string"}},"required":["category","charttype","description","name"]}}}} ``` ## The DashboardChartSeries object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"DashboardChartSeries":{"type":"object","description":"Response shape shared by the series-based charts\n(oscount, lastcontacted, networks)","properties":{"options":{},"series":{}},"required":["options","series"]}}}} ``` ## The DashboardChartTotal object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"DashboardChartTotal":{"type":"object","description":"Response shape for the simple totals (nb_netdevices, nb_networks)","properties":{"total":{"type":"integer"}},"required":["total"]}}}} ``` ## The DashboardLayout object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"DashboardLayout":{"type":"object","description":"This serialize class provide the API representation.","properties":{"id":{"type":"integer","readOnly":true},"visibility":{"$ref":"#/components/schemas/VisibilityEnum"},"user":{"type":"integer"},"groups":{"type":"array","items":{"type":"integer"}},"allow_group_modification":{"type":"boolean"},"name":{"type":"string","maxLength":100},"layout":{}},"required":["id","layout","name","user"]},"VisibilityEnum":{"enum":["public","private_personal","private_group"],"type":"string","description":"* `public` - Public\n* `private_personal` - Private (Personal)\n* `private_group` - Private (Group)"}}}} ``` ## The DatatargetEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"DatatargetEnum":{"enum":["ASSET","IPDISCOVER"],"type":"string","description":"* `ASSET` - Assets\n* `IPDISCOVER` - IPDiscover"}}}} ``` ## The DatatypeEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"DatatypeEnum":{"enum":["TEXT","TEXTAREA","SELECT","CHECKBOX"],"type":"string","description":"* `TEXT` - Text\n* `TEXTAREA` - Textarea\n* `SELECT` - Select\n* `CHECKBOX` - Checkbox"}}}} ``` ## The Extension object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Extension":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true,"maxLength":255},"version":{"type":"string","maxLength":255},"author":{"type":"string","nullable":true,"maxLength":255},"enabled":{"type":"boolean"},"django_app":{"type":"string","maxLength":255}},"required":["django_app","id","name"]}}}} ``` ## The Field object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Field":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"order":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"retrieval_value":{"type":"string","nullable":true,"maxLength":255},"override_target":{"type":"boolean","nullable":true},"new_target":{"type":"string","nullable":true},"retrieval_method":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/FieldRetrievalMethodEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"retrieval_output":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/RetrievalOutputEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"section":{"type":"integer"},"options":{"nullable":true}},"required":["id","name"]},"FieldRetrievalMethodEnum":{"enum":["FILE","BASH","PW","CMD"],"type":"string","description":"* `FILE` - Read file\n* `BASH` - Bash command\n* `PW` - Powershell command\n* `CMD` - Cmd command"},"NullEnum":{"enum":[null]},"RetrievalOutputEnum":{"enum":["PTXT","JSON","TBLE","REGX","GREP"],"type":"string","description":"* `PTXT` - Plain text\n* `JSON` - JSON format\n* `TBLE` - Table format\n* `REGX` - Regex processing\n* `GREP` - Grep command output"}}}} ``` ## The FieldRetrievalMethodEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"FieldRetrievalMethodEnum":{"enum":["FILE","BASH","PW","CMD"],"type":"string","description":"* `FILE` - Read file\n* `BASH` - Bash command\n* `PW` - Powershell command\n* `CMD` - Cmd command"}}}} ``` ## The FileManager object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"FileManager":{"type":"object","description":"Serializer for the FileManager model.","properties":{"id":{"type":"integer","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"modified_at":{"type":"string","format":"date-time","readOnly":true},"name":{"type":"string","maxLength":255},"file":{"type":"string","format":"uri"},"filesize":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"mimetype":{"type":"string","maxLength":100},"linked_model":{"type":"string","maxLength":100},"uuid":{"type":"string","format":"uuid","readOnly":true}},"required":["created_at","file","filesize","id","linked_model","mimetype","modified_at","name","uuid"]}}}} ``` ## The Group object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Group":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":150},"permissions":{"type":"array","items":{"type":"integer"}},"is_protected":{"type":"boolean","writeOnly":true}},"required":["id","name"]}}}} ``` ## The History object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"History":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"scheduler":{"type":"integer"},"date":{"type":"string","format":"date-time","readOnly":true},"status":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"comment":{"type":"string","maxLength":255}},"required":["comment","date","id","scheduler","status"]}}}} ``` ## The InventoryBase object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"InventoryBase":{"type":"object","description":"Serializer class for Base","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true,"maxLength":255},"serial":{"type":"string","maxLength":255},"osname":{"type":"string","maxLength":255},"osversion":{"type":"string","maxLength":255},"uuid":{"type":"string","maxLength":255},"srcip":{"type":"string","maxLength":255},"srcmac":{"type":"string","maxLength":255},"domain":{"type":"string","maxLength":255},"agent":{"type":"string","maxLength":255},"template":{"type":"integer","nullable":true},"last_update":{"type":"string","format":"date-time","readOnly":true},"is_template_forced":{"type":"boolean"},"matched":{"type":"string","readOnly":true}},"required":["id","last_update","matched","name","osname","serial","uuid"]}}}} ``` ## The InventoryField object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"InventoryField":{"type":"object","description":"Serializer class for InventoryField","properties":{"id":{"type":"integer","readOnly":true},"inventory_section":{"type":"integer"},"template_field":{"type":"integer"},"value":{"type":"string","nullable":true}},"required":["id","inventory_section","template_field"]}}}} ``` ## The InventorySection object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"InventorySection":{"type":"object","description":"Serializer class for InventorySection","properties":{"id":{"type":"integer","readOnly":true},"base":{"type":"integer"},"template_section":{"type":"integer"},"fields":{"type":"array","items":{"type":"integer"}}},"required":["base","fields","id","template_section"]}}}} ``` ## The LegacyError object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"LegacyError":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}} ``` ## The LegacyResponse object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"LegacyResponse":{"type":"object","description":"Response shape on successful legacy asset creation/update","properties":{"message":{"type":"string"},"id":{"type":"integer"}},"required":["id","message"]}}}} ``` ## The LinkEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"LinkEnum":{"enum":["AND","OR"],"type":"string","description":"* `AND` - AND\n* `OR` - OR"}}}} ``` ## The Log object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Log":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"asset":{"type":"integer","nullable":true},"timestamp":{"type":"string","format":"date-time","readOnly":true},"scope":{"$ref":"#/components/schemas/ScopeEnum"},"comment":{"type":"string","maxLength":255}},"required":["comment","id","timestamp"]},"ScopeEnum":{"enum":["INVENTORY_BASE_INSERT","INVENTORY_BASE_UPDATE","INVENTORY_EXT_INSERT","INVENTORY_EXT_UPDATE","INVENTORY_BASE_ERR","INVENTORY_EXT_ERR","DEPLOYMENT_ACK","DEPLOYMENT_ERR","CONFIG_UPDATE","CONFIG_ERR","TEMPLATE_UPDATE","TEMPLATE_ERR","UNKNOWN"],"type":"string","description":"* `INVENTORY_BASE_INSERT` - Inserting new items into the base inventory\n* `INVENTORY_BASE_UPDATE` - Updating existing items in the base inventory\n* `INVENTORY_EXT_INSERT` - Inserting new items into the extended inventory\n* `INVENTORY_EXT_UPDATE` - Updating existing items in the extended inventory\n* `INVENTORY_BASE_ERR` - Error related to the base inventory operations\n* `INVENTORY_EXT_ERR` - Error related to the extended inventory operations\n* `DEPLOYMENT_ACK` - Acknowledgment of a successful deployment\n* `DEPLOYMENT_ERR` - Error during the deployment process\n* `CONFIG_UPDATE` - Updating configuration settings\n* `CONFIG_ERR` - Error related to configuration operations\n* `TEMPLATE_UPDATE` - Updating templates for a process\n* `TEMPLATE_ERR` - Error related to template operations\n* `UNKNOWN` - Unknown error happend (default)"}}}} ``` ## The MyAccount object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"MyAccount":{"type":"object","description":"This serialize class provide the API representation\n\nArgs:\n serializers ([ModelSerializer])","properties":{"id":{"type":"integer","readOnly":true},"username":{"type":"string","description":"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.","pattern":"^[\\w.@+-]+$","maxLength":150},"email":{"title":"Email address","oneOf":[{"type":"string","format":"email","maxLength":254},{"type":"string","maxLength":0}]},"first_name":{"type":"string","maxLength":150},"last_name":{"type":"string","maxLength":150},"password":{"type":"string","writeOnly":true,"maxLength":128},"is_superuser":{"type":"boolean","readOnly":true,"title":"Superuser status","description":"Designates that this user has all permissions without explicitly assigning them."},"groups":{"type":"array","items":{"type":"integer"},"readOnly":true,"description":"The groups this user belongs to. A user will get all permissions granted to each of their groups."},"group_assignments":{"type":"string","readOnly":true},"user_permissions":{"type":"array","items":{"type":"integer"},"readOnly":true,"description":"Specific permissions for this user."}},"required":["group_assignments","groups","id","is_superuser","password","user_permissions","username"]}}}} ``` ## The Netdevice object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Netdevice":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"ip":{"type":"string"},"netname":{"type":"string","maxLength":128},"mac":{"type":"string","maxLength":20},"network":{"type":"integer"},"last_seen":{"type":"string","format":"date-time","readOnly":true}},"required":["id","ip","last_seen","mac","netname"]}}}} ``` ## The Netgroup object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Netgroup":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":128},"description":{"type":"string","maxLength":1024}},"required":["description","id","name"]}}}} ``` ## The Network object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Network":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"nettag":{"type":"string","maxLength":128},"name":{"type":"string","maxLength":128},"description":{"type":"string","maxLength":1024},"netid":{"type":"string"},"mask":{"type":"string"},"netdevices":{"type":"array","items":{"$ref":"#/components/schemas/Netdevice"}},"group":{"type":"integer","nullable":true},"last_update":{"type":"string","format":"date-time","readOnly":true}},"required":["id","last_update","mask","netid"]},"Netdevice":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"ip":{"type":"string"},"netname":{"type":"string","maxLength":128},"mac":{"type":"string","maxLength":20},"network":{"type":"integer"},"last_seen":{"type":"string","format":"date-time","readOnly":true}},"required":["id","ip","last_seen","mac","netname"]}}}} ``` ## The Note object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Note":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"text":{"type":"string"},"creator":{"type":"integer"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true},"object_slug":{"type":"string","nullable":true,"maxLength":100},"content_type":{"type":"integer","readOnly":true,"nullable":true},"object_id":{"type":"integer","maximum":9223372036854776000,"minimum":0,"format":"int64","nullable":true}},"required":["content_type","created_at","creator","id","text","updated_at"]}}}} ``` ## The NullEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"NullEnum":{"enum":[null]}}}} ``` ## The OsEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"OsEnum":{"enum":["LEG","DEB","RHEL","MAC","WIN","SNMP","VIRT"],"type":"string","description":"* `LEG` - Legacy\n* `DEB` - Linux (Debian based)\n* `RHEL` - Linux (RHEL based)\n* `MAC` - Mac\n* `WIN` - Windows\n* `SNMP` - SNMP\n* `VIRT` - Virtualization"}}}} ``` ## The Package object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Package":{"type":"object","description":"This serializer class provides the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":128},"description":{"type":"string"},"date_created":{"type":"string","format":"date-time","readOnly":true},"target_os":{"$ref":"#/components/schemas/TargetOsEnum"},"actions_list":{"type":"array","items":{"$ref":"#/components/schemas/Action"}},"result":{"type":"array","items":{"$ref":"#/components/schemas/Result"}}},"required":["actions_list","date_created","description","id","name","result"]},"TargetOsEnum":{"enum":["WIN","LIN","MAC"],"type":"string","description":"* `WIN` - Windows\n* `LIN` - Linux\n* `MAC` - Mac"},"Action":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"rule":{"type":"integer","nullable":true},"priority":{"type":"integer"},"action":{"$ref":"#/components/schemas/ActionEnum"},"content_type":{"type":"integer","nullable":true},"object_id":{"type":"integer","maximum":9223372036854776000,"minimum":0,"format":"int64","nullable":true},"object_slug":{"type":"string","nullable":true,"maxLength":100},"field":{"type":"string","maxLength":255},"value":{}},"required":["action","field","id","value"]},"ActionEnum":{"enum":["set"],"type":"string","description":"* `set` - Set"},"Result":{"type":"object","description":"This serializer class provides the API representation","properties":{"id":{"type":"integer","readOnly":true},"package":{"type":"integer","nullable":true},"asset":{"type":"integer","nullable":true},"group":{"type":"integer","nullable":true},"name":{"type":"string","maxLength":128},"status":{"allOf":[{"$ref":"#/components/schemas/ResultStatusEnum"}],"minimum":-9223372036854776000,"maximum":9223372036854776000},"comment":{"type":"string","nullable":true},"date_created":{"type":"string","format":"date-time","readOnly":true}},"required":["asset","date_created","group","id","name"]},"ResultStatusEnum":{"enum":[0,1,2,3],"type":"integer","description":"* `0` - Sucess\n* `1` - Waiting notification\n* `2` - Notified\n* `3` - Error"}}}} ``` ## The PaginatedAccountinfoConfigList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedAccountinfoConfigList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AccountinfoConfig"}}}},"AccountinfoConfig":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":100},"description":{"type":"string","maxLength":512},"datatype":{"$ref":"#/components/schemas/DatatypeEnum"},"datatarget":{"allOf":[{"$ref":"#/components/schemas/DatatargetEnum"}],"default":"ASSET"},"accountinfo_values":{"type":"array","items":{"type":"integer"},"readOnly":true}},"required":["accountinfo_values","description","id","name"]},"DatatypeEnum":{"enum":["TEXT","TEXTAREA","SELECT","CHECKBOX"],"type":"string","description":"* `TEXT` - Text\n* `TEXTAREA` - Textarea\n* `SELECT` - Select\n* `CHECKBOX` - Checkbox"},"DatatargetEnum":{"enum":["ASSET","IPDISCOVER"],"type":"string","description":"* `ASSET` - Assets\n* `IPDISCOVER` - IPDiscover"}}}} ``` ## The PaginatedAccountinfoDataList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedAccountinfoDataList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AccountinfoData"}}}},"AccountinfoData":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"accountdata":{"nullable":true},"object_slug":{"type":"string","nullable":true,"maxLength":100},"content_type":{"type":"integer","readOnly":true},"object_id":{"type":"integer","maximum":9223372036854776000,"minimum":0,"format":"int64"}},"required":["content_type","id","object_id"]}}}} ``` ## The PaginatedAccountinfoValueList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedAccountinfoValueList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AccountinfoValue"}}}},"AccountinfoValue":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"accountinfo_config":{"type":"integer"},"value":{"type":"string","maxLength":100}},"required":["accountinfo_config","id","value"]}}}} ``` ## The PaginatedActionList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedActionList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Action"}}}},"Action":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"rule":{"type":"integer","nullable":true},"priority":{"type":"integer"},"action":{"$ref":"#/components/schemas/ActionEnum"},"content_type":{"type":"integer","nullable":true},"object_id":{"type":"integer","maximum":9223372036854776000,"minimum":0,"format":"int64","nullable":true},"object_slug":{"type":"string","nullable":true,"maxLength":100},"field":{"type":"string","maxLength":255},"value":{}},"required":["action","field","id","value"]},"ActionEnum":{"enum":["set"],"type":"string","description":"* `set` - Set"}}}} ``` ## The PaginatedAssetEOLStatusList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedAssetEOLStatusList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AssetEOLStatus"}}}},"AssetEOLStatus":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"asset":{"type":"integer","readOnly":true},"asset_name":{"type":"string","readOnly":true},"product":{"type":"string","readOnly":true,"nullable":true},"cycle":{"type":"string","readOnly":true,"nullable":true},"eol":{"type":"string","readOnly":true,"nullable":true},"is_eol":{"type":"boolean","readOnly":true},"support":{"type":"boolean","readOnly":true},"support_date":{"type":"string","readOnly":true,"nullable":true},"latest":{"type":"string","readOnly":true,"nullable":true},"fetched_at":{"type":"string","format":"date-time","readOnly":true}},"required":["asset","asset_name","cycle","eol","fetched_at","id","is_eol","latest","product","support","support_date"]}}}} ``` ## The PaginatedAssetGroupList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedAssetGroupList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AssetGroup"}}}},"AssetGroup":{"type":"object","description":"Serializer class for AssetGroup","properties":{"id":{"type":"integer","readOnly":true},"visibility":{"$ref":"#/components/schemas/VisibilityEnum"},"allow_group_modification":{"type":"boolean"},"name":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true,"maxLength":255},"is_dynamic":{"type":"boolean"},"search":{"nullable":true},"last_updated":{"type":"string","format":"date-time","readOnly":true},"user":{"type":"integer"},"groups":{"type":"array","items":{"type":"integer"}},"assets":{"type":"array","items":{"type":"integer"}}},"required":["id","last_updated","name","user"]},"VisibilityEnum":{"enum":["public","private_personal","private_group"],"type":"string","description":"* `public` - Public\n* `private_personal` - Private (Personal)\n* `private_group` - Private (Group)"}}}} ``` ## The PaginatedAuthConfigList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedAuthConfigList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AuthConfig"}}}},"AuthConfig":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"auth_method":{"type":"integer","nullable":true},"enabled":{"type":"boolean"},"priority":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"config":{},"mappings":{"type":"array","items":{"type":"integer"}}},"required":["config","id","mappings"]}}}} ``` ## The PaginatedAuthMappingList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedAuthMappingList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AuthMapping"}}}},"AuthMapping":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"auth_config":{"type":"integer","nullable":true},"internal_field":{"type":"string","maxLength":255},"external_field":{"type":"string","maxLength":255}},"required":["external_field","id","internal_field"]}}}} ``` ## The PaginatedAuthMethodList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedAuthMethodList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AuthMethod"}}}},"AuthMethod":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"auth_type":{"$ref":"#/components/schemas/AuthTypeEnum"},"enabled":{"type":"boolean"},"priority":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"configs":{"type":"array","items":{"type":"integer"}}},"required":["auth_type","configs","id","name"]},"AuthTypeEnum":{"enum":["SSO","OTHER"],"type":"string","description":"* `SSO` - SSO\n* `OTHER` - OTHER"}}}} ``` ## The PaginatedCategoryList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedCategoryList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Category"}}}},"Category":{"type":"object","description":"This serialize class provide the API representation\n\nArgs:\n serializers ([ModelSerializer])","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"description":{"type":"string","maxLength":255},"inventory_sections":{"type":"array","items":{"type":"integer"}},"is_protected":{"type":"boolean"}},"required":["description","id","name"]}}}} ``` ## The PaginatedComplianceResultList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedComplianceResultList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ComplianceResult"}}}},"ComplianceResult":{"type":"object","description":"Mixin to dynamically expand nested fields based on the \"expand\" query parameter.\n\nTo use, add an `expandable_fields` dictionary in your serializer's Meta:\n\n expandable_fields = {\n \"some_relation\": SomeNestedSerializer,\n \"other_relation\": OtherNestedSerializer,\n }\n\nThe mixin will:\n - Expand all fields and childs if expand=\"*\"\n - Expand fields provided in a comma separated list (expand=field1,field2)\n - or return the pks for the relation","properties":{"id":{"type":"integer","readOnly":true},"asset":{"type":"integer"},"asset_name":{"type":"string","readOnly":true},"rule":{"type":"integer"},"status":{"$ref":"#/components/schemas/ComplianceResultStatusEnum"},"detail":{"nullable":true},"evaluated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["asset","asset_name","evaluated_at","id","rule"]},"ComplianceResultStatusEnum":{"enum":["compliant","non_compliant","unknown"],"type":"string","description":"* `compliant` - Compliant\n* `non_compliant` - Non-compliant\n* `unknown` - Unknown"}}}} ``` ## The PaginatedComplianceRuleList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedComplianceRuleList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ComplianceRule"}}}},"ComplianceRule":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true,"maxLength":255},"type":{"type":"string","maxLength":50},"severity":{"$ref":"#/components/schemas/SeverityEnum"},"logic":{},"enabled":{"type":"boolean"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["created_at","id","logic","name","type","updated_at"]},"SeverityEnum":{"enum":["critical","high","medium","low"],"type":"string","description":"* `critical` - Critical\n* `high` - High\n* `medium` - Medium\n* `low` - Low"}}}} ``` ## The PaginatedComplianceTypeList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedComplianceTypeList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ComplianceType"}}}},"ComplianceType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50}},"required":["id","name"]}}}} ``` ## The PaginatedConfigList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedConfigList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Config"}}}},"Config":{"type":"object","description":"This serialize class provide the API representation","properties":{"name":{"type":"string","maxLength":100},"value":{}},"required":["name","value"]}}}} ``` ## The PaginatedCustomEOLExtendedSupportList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedCustomEOLExtendedSupportList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/CustomEOLExtendedSupport"}}}},"CustomEOLExtendedSupport":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"product":{"type":"string","description":"endoflife.date product slug (e.g. ubuntu)","maxLength":100},"cycle":{"type":"string","description":"Version cycle (e.g. 22.04)","maxLength":50},"is_extended":{"type":"boolean","description":"Whether purchased extended support is active for this product/cycle"}},"required":["cycle","id","product"]}}}} ``` ## The PaginatedDashboardChartDescriptorList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedDashboardChartDescriptorList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DashboardChartDescriptor"}}}},"DashboardChartDescriptor":{"type":"object","description":"Describes one chart available on the dashboard (returned by the list action)","properties":{"category":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"charttype":{"type":"string"}},"required":["category","charttype","description","name"]}}}} ``` ## The PaginatedDashboardLayoutList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedDashboardLayoutList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/DashboardLayout"}}}},"DashboardLayout":{"type":"object","description":"This serialize class provide the API representation.","properties":{"id":{"type":"integer","readOnly":true},"visibility":{"$ref":"#/components/schemas/VisibilityEnum"},"user":{"type":"integer"},"groups":{"type":"array","items":{"type":"integer"}},"allow_group_modification":{"type":"boolean"},"name":{"type":"string","maxLength":100},"layout":{}},"required":["id","layout","name","user"]},"VisibilityEnum":{"enum":["public","private_personal","private_group"],"type":"string","description":"* `public` - Public\n* `private_personal` - Private (Personal)\n* `private_group` - Private (Group)"}}}} ``` ## The PaginatedExtensionList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedExtensionList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Extension"}}}},"Extension":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true,"maxLength":255},"version":{"type":"string","maxLength":255},"author":{"type":"string","nullable":true,"maxLength":255},"enabled":{"type":"boolean"},"django_app":{"type":"string","maxLength":255}},"required":["django_app","id","name"]}}}} ``` ## The PaginatedFieldList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedFieldList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Field"}}}},"Field":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"order":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"retrieval_value":{"type":"string","nullable":true,"maxLength":255},"override_target":{"type":"boolean","nullable":true},"new_target":{"type":"string","nullable":true},"retrieval_method":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/FieldRetrievalMethodEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"retrieval_output":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/RetrievalOutputEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"section":{"type":"integer"},"options":{"nullable":true}},"required":["id","name"]},"FieldRetrievalMethodEnum":{"enum":["FILE","BASH","PW","CMD"],"type":"string","description":"* `FILE` - Read file\n* `BASH` - Bash command\n* `PW` - Powershell command\n* `CMD` - Cmd command"},"NullEnum":{"enum":[null]},"RetrievalOutputEnum":{"enum":["PTXT","JSON","TBLE","REGX","GREP"],"type":"string","description":"* `PTXT` - Plain text\n* `JSON` - JSON format\n* `TBLE` - Table format\n* `REGX` - Regex processing\n* `GREP` - Grep command output"}}}} ``` ## The PaginatedFileManagerList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedFileManagerList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/FileManager"}}}},"FileManager":{"type":"object","description":"Serializer for the FileManager model.","properties":{"id":{"type":"integer","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"modified_at":{"type":"string","format":"date-time","readOnly":true},"name":{"type":"string","maxLength":255},"file":{"type":"string","format":"uri"},"filesize":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"mimetype":{"type":"string","maxLength":100},"linked_model":{"type":"string","maxLength":100},"uuid":{"type":"string","format":"uuid","readOnly":true}},"required":["created_at","file","filesize","id","linked_model","mimetype","modified_at","name","uuid"]}}}} ``` ## The PaginatedGroupList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedGroupList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Group"}}}},"Group":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":150},"permissions":{"type":"array","items":{"type":"integer"}},"is_protected":{"type":"boolean","writeOnly":true}},"required":["id","name"]}}}} ``` ## The PaginatedHistoryList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedHistoryList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/History"}}}},"History":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"scheduler":{"type":"integer"},"date":{"type":"string","format":"date-time","readOnly":true},"status":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"comment":{"type":"string","maxLength":255}},"required":["comment","date","id","scheduler","status"]}}}} ``` ## The PaginatedInventoryBaseList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedInventoryBaseList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/InventoryBase"}}}},"InventoryBase":{"type":"object","description":"Serializer class for Base","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true,"maxLength":255},"serial":{"type":"string","maxLength":255},"osname":{"type":"string","maxLength":255},"osversion":{"type":"string","maxLength":255},"uuid":{"type":"string","maxLength":255},"srcip":{"type":"string","maxLength":255},"srcmac":{"type":"string","maxLength":255},"domain":{"type":"string","maxLength":255},"agent":{"type":"string","maxLength":255},"template":{"type":"integer","nullable":true},"last_update":{"type":"string","format":"date-time","readOnly":true},"is_template_forced":{"type":"boolean"},"matched":{"type":"string","readOnly":true}},"required":["id","last_update","matched","name","osname","serial","uuid"]}}}} ``` ## The PaginatedInventoryFieldList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedInventoryFieldList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/InventoryField"}}}},"InventoryField":{"type":"object","description":"Serializer class for InventoryField","properties":{"id":{"type":"integer","readOnly":true},"inventory_section":{"type":"integer"},"template_field":{"type":"integer"},"value":{"type":"string","nullable":true}},"required":["id","inventory_section","template_field"]}}}} ``` ## The PaginatedInventorySectionList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedInventorySectionList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/InventorySection"}}}},"InventorySection":{"type":"object","description":"Serializer class for InventorySection","properties":{"id":{"type":"integer","readOnly":true},"base":{"type":"integer"},"template_section":{"type":"integer"},"fields":{"type":"array","items":{"type":"integer"}}},"required":["base","fields","id","template_section"]}}}} ``` ## The PaginatedLogList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedLogList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Log"}}}},"Log":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"asset":{"type":"integer","nullable":true},"timestamp":{"type":"string","format":"date-time","readOnly":true},"scope":{"$ref":"#/components/schemas/ScopeEnum"},"comment":{"type":"string","maxLength":255}},"required":["comment","id","timestamp"]},"ScopeEnum":{"enum":["INVENTORY_BASE_INSERT","INVENTORY_BASE_UPDATE","INVENTORY_EXT_INSERT","INVENTORY_EXT_UPDATE","INVENTORY_BASE_ERR","INVENTORY_EXT_ERR","DEPLOYMENT_ACK","DEPLOYMENT_ERR","CONFIG_UPDATE","CONFIG_ERR","TEMPLATE_UPDATE","TEMPLATE_ERR","UNKNOWN"],"type":"string","description":"* `INVENTORY_BASE_INSERT` - Inserting new items into the base inventory\n* `INVENTORY_BASE_UPDATE` - Updating existing items in the base inventory\n* `INVENTORY_EXT_INSERT` - Inserting new items into the extended inventory\n* `INVENTORY_EXT_UPDATE` - Updating existing items in the extended inventory\n* `INVENTORY_BASE_ERR` - Error related to the base inventory operations\n* `INVENTORY_EXT_ERR` - Error related to the extended inventory operations\n* `DEPLOYMENT_ACK` - Acknowledgment of a successful deployment\n* `DEPLOYMENT_ERR` - Error during the deployment process\n* `CONFIG_UPDATE` - Updating configuration settings\n* `CONFIG_ERR` - Error related to configuration operations\n* `TEMPLATE_UPDATE` - Updating templates for a process\n* `TEMPLATE_ERR` - Error related to template operations\n* `UNKNOWN` - Unknown error happend (default)"}}}} ``` ## The PaginatedMyAccountList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedMyAccountList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/MyAccount"}}}},"MyAccount":{"type":"object","description":"This serialize class provide the API representation\n\nArgs:\n serializers ([ModelSerializer])","properties":{"id":{"type":"integer","readOnly":true},"username":{"type":"string","description":"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.","pattern":"^[\\w.@+-]+$","maxLength":150},"email":{"title":"Email address","oneOf":[{"type":"string","format":"email","maxLength":254},{"type":"string","maxLength":0}]},"first_name":{"type":"string","maxLength":150},"last_name":{"type":"string","maxLength":150},"password":{"type":"string","writeOnly":true,"maxLength":128},"is_superuser":{"type":"boolean","readOnly":true,"title":"Superuser status","description":"Designates that this user has all permissions without explicitly assigning them."},"groups":{"type":"array","items":{"type":"integer"},"readOnly":true,"description":"The groups this user belongs to. A user will get all permissions granted to each of their groups."},"group_assignments":{"type":"string","readOnly":true},"user_permissions":{"type":"array","items":{"type":"integer"},"readOnly":true,"description":"Specific permissions for this user."}},"required":["group_assignments","groups","id","is_superuser","password","user_permissions","username"]}}}} ``` ## The PaginatedNetdeviceList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedNetdeviceList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Netdevice"}}}},"Netdevice":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"ip":{"type":"string"},"netname":{"type":"string","maxLength":128},"mac":{"type":"string","maxLength":20},"network":{"type":"integer"},"last_seen":{"type":"string","format":"date-time","readOnly":true}},"required":["id","ip","last_seen","mac","netname"]}}}} ``` ## The PaginatedNetgroupList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedNetgroupList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Netgroup"}}}},"Netgroup":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":128},"description":{"type":"string","maxLength":1024}},"required":["description","id","name"]}}}} ``` ## The PaginatedNetworkList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedNetworkList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Network"}}}},"Network":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"nettag":{"type":"string","maxLength":128},"name":{"type":"string","maxLength":128},"description":{"type":"string","maxLength":1024},"netid":{"type":"string"},"mask":{"type":"string"},"netdevices":{"type":"array","items":{"$ref":"#/components/schemas/Netdevice"}},"group":{"type":"integer","nullable":true},"last_update":{"type":"string","format":"date-time","readOnly":true}},"required":["id","last_update","mask","netid"]},"Netdevice":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"ip":{"type":"string"},"netname":{"type":"string","maxLength":128},"mac":{"type":"string","maxLength":20},"network":{"type":"integer"},"last_seen":{"type":"string","format":"date-time","readOnly":true}},"required":["id","ip","last_seen","mac","netname"]}}}} ``` ## The PaginatedNoteList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedNoteList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Note"}}}},"Note":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"text":{"type":"string"},"creator":{"type":"integer"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true},"object_slug":{"type":"string","nullable":true,"maxLength":100},"content_type":{"type":"integer","readOnly":true,"nullable":true},"object_id":{"type":"integer","maximum":9223372036854776000,"minimum":0,"format":"int64","nullable":true}},"required":["content_type","created_at","creator","id","text","updated_at"]}}}} ``` ## The PaginatedPackageList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedPackageList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Package"}}}},"Package":{"type":"object","description":"This serializer class provides the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":128},"description":{"type":"string"},"date_created":{"type":"string","format":"date-time","readOnly":true},"target_os":{"$ref":"#/components/schemas/TargetOsEnum"},"actions_list":{"type":"array","items":{"$ref":"#/components/schemas/Action"}},"result":{"type":"array","items":{"$ref":"#/components/schemas/Result"}}},"required":["actions_list","date_created","description","id","name","result"]},"TargetOsEnum":{"enum":["WIN","LIN","MAC"],"type":"string","description":"* `WIN` - Windows\n* `LIN` - Linux\n* `MAC` - Mac"},"Action":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"rule":{"type":"integer","nullable":true},"priority":{"type":"integer"},"action":{"$ref":"#/components/schemas/ActionEnum"},"content_type":{"type":"integer","nullable":true},"object_id":{"type":"integer","maximum":9223372036854776000,"minimum":0,"format":"int64","nullable":true},"object_slug":{"type":"string","nullable":true,"maxLength":100},"field":{"type":"string","maxLength":255},"value":{}},"required":["action","field","id","value"]},"ActionEnum":{"enum":["set"],"type":"string","description":"* `set` - Set"},"Result":{"type":"object","description":"This serializer class provides the API representation","properties":{"id":{"type":"integer","readOnly":true},"package":{"type":"integer","nullable":true},"asset":{"type":"integer","nullable":true},"group":{"type":"integer","nullable":true},"name":{"type":"string","maxLength":128},"status":{"allOf":[{"$ref":"#/components/schemas/ResultStatusEnum"}],"minimum":-9223372036854776000,"maximum":9223372036854776000},"comment":{"type":"string","nullable":true},"date_created":{"type":"string","format":"date-time","readOnly":true}},"required":["asset","date_created","group","id","name"]},"ResultStatusEnum":{"enum":[0,1,2,3],"type":"integer","description":"* `0` - Sucess\n* `1` - Waiting notification\n* `2` - Notified\n* `3` - Error"}}}} ``` ## The PaginatedPermissionList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedPermissionList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Permission"}}}},"Permission":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"content_type":{"type":"integer"},"codename":{"type":"string","maxLength":100}},"required":["codename","content_type","id","name"]}}}} ``` ## The PaginatedResultList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedResultList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Result"}}}},"Result":{"type":"object","description":"This serializer class provides the API representation","properties":{"id":{"type":"integer","readOnly":true},"package":{"type":"integer","nullable":true},"asset":{"type":"integer","nullable":true},"group":{"type":"integer","nullable":true},"name":{"type":"string","maxLength":128},"status":{"allOf":[{"$ref":"#/components/schemas/ResultStatusEnum"}],"minimum":-9223372036854776000,"maximum":9223372036854776000},"comment":{"type":"string","nullable":true},"date_created":{"type":"string","format":"date-time","readOnly":true}},"required":["asset","date_created","group","id","name"]},"ResultStatusEnum":{"enum":[0,1,2,3],"type":"integer","description":"* `0` - Sucess\n* `1` - Waiting notification\n* `2` - Notified\n* `3` - Error"}}}} ``` ## The PaginatedRuleList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedRuleList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Rule"}}}},"Rule":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"priority":{"type":"integer"},"description":{"type":"string","nullable":true,"maxLength":255},"trigger":{"$ref":"#/components/schemas/TriggerEnum"},"enabled":{"type":"boolean"},"logic":{},"break_on_match":{"type":"boolean"},"actions":{"type":"array","items":{"type":"integer"}}},"required":["actions","id","logic","trigger"]},"TriggerEnum":{"enum":["inventory_received","user_login","netdevice_received"],"type":"string","description":"* `inventory_received` - Inventory Received\n* `user_login` - User Login\n* `netdevice_received` - Netdevice Received"}}}} ``` ## The PaginatedSchedulerList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedSchedulerList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Scheduler"}}}},"Scheduler":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":100},"description":{"type":"string","maxLength":1024},"active":{"type":"boolean"},"recurrence":{"$ref":"#/components/schemas/RecurrenceEnum"},"last_execution":{"type":"string","format":"date-time","nullable":true},"hour":{"type":"string","format":"time","nullable":true},"day_of_week":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"day_of_month":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"is_protected":{"type":"boolean"}},"required":["active","description","id","name"]},"RecurrenceEnum":{"enum":["hourly","daily","weekly","monthly"],"type":"string","description":"* `hourly` - hourly\n* `daily` - daily\n* `weekly` - weekly\n* `monthly` - monthly"}}}} ``` ## The PaginatedSearchList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedSearchList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Search"}}}},"Search":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"visibility":{"$ref":"#/components/schemas/VisibilityEnum"},"allow_group_modification":{"type":"boolean"},"search":{},"last_updated":{"type":"string","format":"date-time","readOnly":true},"name":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true},"user":{"type":"integer"},"groups":{"type":"array","items":{"type":"integer"}}},"required":["id","last_updated","name","search","user"]},"VisibilityEnum":{"enum":["public","private_personal","private_group"],"type":"string","description":"* `public` - Public\n* `private_personal` - Private (Personal)\n* `private_group` - Private (Group)"}}}} ``` ## The PaginatedSectionList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedSectionList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Section"}}}},"Section":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"retrieval_method":{"$ref":"#/components/schemas/SectionRetrievalMethodEnum"},"retrieval_output":{"$ref":"#/components/schemas/RetrievalOutputEnum"},"target":{"type":"string"},"template":{"type":"integer"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/Field"}},"options":{"nullable":true},"is_active":{"type":"boolean"}},"required":["fields","id","name","target"]},"SectionRetrievalMethodEnum":{"enum":["FILE","BASH","PW","CMD","SNMP_WALK","SNMP_GET"],"type":"string","description":"* `FILE` - Read file\n* `BASH` - Bash command\n* `PW` - Powershell command\n* `CMD` - Cmd command\n* `SNMP_WALK` - Walk the SNMP tree starting from a specific OID\n* `SNMP_GET` - Get a specific OID"},"RetrievalOutputEnum":{"enum":["PTXT","JSON","TBLE","REGX","GREP"],"type":"string","description":"* `PTXT` - Plain text\n* `JSON` - JSON format\n* `TBLE` - Table format\n* `REGX` - Regex processing\n* `GREP` - Grep command output"},"Field":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"order":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"retrieval_value":{"type":"string","nullable":true,"maxLength":255},"override_target":{"type":"boolean","nullable":true},"new_target":{"type":"string","nullable":true},"retrieval_method":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/FieldRetrievalMethodEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"retrieval_output":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/RetrievalOutputEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"section":{"type":"integer"},"options":{"nullable":true}},"required":["id","name"]},"FieldRetrievalMethodEnum":{"enum":["FILE","BASH","PW","CMD"],"type":"string","description":"* `FILE` - Read file\n* `BASH` - Bash command\n* `PW` - Powershell command\n* `CMD` - Cmd command"},"NullEnum":{"enum":[null]}}}} ``` ## The PaginatedServerInfoList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedServerInfoList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/ServerInfo"}}}},"ServerInfo":{"type":"object","properties":{"backend_version":{"type":"string","nullable":true},"authentication_type":{"type":"array","items":{"type":"string"}},"infrastructure_type":{"type":"string","nullable":true},"operating_system":{"type":"string","nullable":true},"operating_system_version":{"type":"string","nullable":true},"db_engine":{"type":"string","nullable":true},"ocs_configuration":{},"python_version":{"type":"string","nullable":true},"python_libs_version":{"type":"object","additionalProperties":{"type":"string","nullable":true}}},"required":["authentication_type","backend_version","db_engine","infrastructure_type","ocs_configuration","operating_system","operating_system_version","python_libs_version","python_version"]}}}} ``` ## The PaginatedSnmpConfigList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedSnmpConfigList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SnmpConfig"}}}},"SnmpConfig":{"type":"object","description":"This serializer class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":128},"version":{"$ref":"#/components/schemas/VersionEnum"},"user":{"type":"string","nullable":true,"maxLength":128},"auth_level":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/AuthLevelEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"password":{"type":"string","nullable":true,"maxLength":128},"auth_protocol":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/AuthProtocolEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"priv_protocol":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/PrivProtocolEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"priv_password":{"type":"string","nullable":true,"maxLength":128},"retries":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"timeout":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"subnets":{}},"required":["id","name","subnets","version"]},"VersionEnum":{"enum":["1","2c","3"],"type":"string","description":"* `1` - SNMPv1\n* `2c` - SNMPv2c\n* `3` - SNMPv3"},"AuthLevelEnum":{"enum":["noAuthNoPriv","authNoPriv","authPriv"],"type":"string","description":"* `noAuthNoPriv` - noAuthNoPriv\n* `authNoPriv` - authNoPriv\n* `authPriv` - authPriv"},"BlankEnum":{"enum":[""]},"NullEnum":{"enum":[null]},"AuthProtocolEnum":{"enum":["MD5","SHA","None"],"type":"string","description":"* `MD5` - MD5\n* `SHA` - SHA\n* `None` - None"},"PrivProtocolEnum":{"enum":["DES","AES","None"],"type":"string","description":"* `DES` - DES\n* `AES` - AES\n* `None` - None"}}}} ``` ## The PaginatedSnmpScannerList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedSnmpScannerList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SnmpScanner"}}}},"SnmpScanner":{"type":"object","description":"This serializer class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":100},"ip":{"type":"string"},"subnets":{},"notes":{"type":"string","nullable":true},"last_updated":{"type":"string","format":"date-time","readOnly":true},"total_scanned":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"total_found":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"last_scan_date":{"type":"string","format":"date-time","nullable":true},"configs":{"type":"array","items":{"type":"integer"}},"assets":{"type":"array","items":{"type":"integer"}}},"required":["id","ip","last_updated","name"]}}}} ``` ## The PaginatedSoftwareDictionaryList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedSoftwareDictionaryList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SoftwareDictionary"}}}},"SoftwareDictionary":{"type":"object","description":"Serialize aggregated asset/software relationships","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"version":{"type":"string","nullable":true,"maxLength":128},"major_version":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"minor_version":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"patch_version":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"assets":{"type":"array","items":{"type":"integer"},"readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true},"installation_number":{"type":"integer","readOnly":true}},"required":["assets","id","installation_number","updated_at"]}}}} ``` ## The PaginatedSoftwareMappingList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedSoftwareMappingList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/SoftwareMapping"}}}},"SoftwareMapping":{"type":"object","description":"Mixin to dynamically expand nested fields based on the \"expand\" query parameter.\n\nTo use, add an `expandable_fields` dictionary in your serializer's Meta:\n\n expandable_fields = {\n \"some_relation\": SomeNestedSerializer,\n \"other_relation\": OtherNestedSerializer,\n }\n\nThe mixin will:\n - Expand all fields and childs if expand=\"*\"\n - Expand fields provided in a comma separated list (expand=field1,field2)\n - or return the pks for the relation","properties":{"id":{"type":"integer","readOnly":true},"template":{"type":"integer"},"section":{"type":"integer"},"name":{"type":"integer","nullable":true},"publisher":{"type":"integer","nullable":true},"version":{"type":"integer","nullable":true},"major_version":{"type":"integer","nullable":true},"minor_version":{"type":"integer","nullable":true},"patch_version":{"type":"integer","nullable":true}},"required":["id","section","template"]}}}} ``` ## The PaginatedTemplateList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedTemplateList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Template"}}}},"Template":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"os":{"$ref":"#/components/schemas/OsEnum"},"is_protected":{"type":"boolean"},"last_update":{"type":"string","format":"date-time","readOnly":true},"sections":{"type":"array","items":{"$ref":"#/components/schemas/Section"}}},"required":["id","last_update","name","sections"]},"OsEnum":{"enum":["LEG","DEB","RHEL","MAC","WIN","SNMP","VIRT"],"type":"string","description":"* `LEG` - Legacy\n* `DEB` - Linux (Debian based)\n* `RHEL` - Linux (RHEL based)\n* `MAC` - Mac\n* `WIN` - Windows\n* `SNMP` - SNMP\n* `VIRT` - Virtualization"},"Section":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"retrieval_method":{"$ref":"#/components/schemas/SectionRetrievalMethodEnum"},"retrieval_output":{"$ref":"#/components/schemas/RetrievalOutputEnum"},"target":{"type":"string"},"template":{"type":"integer"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/Field"}},"options":{"nullable":true},"is_active":{"type":"boolean"}},"required":["fields","id","name","target"]},"SectionRetrievalMethodEnum":{"enum":["FILE","BASH","PW","CMD","SNMP_WALK","SNMP_GET"],"type":"string","description":"* `FILE` - Read file\n* `BASH` - Bash command\n* `PW` - Powershell command\n* `CMD` - Cmd command\n* `SNMP_WALK` - Walk the SNMP tree starting from a specific OID\n* `SNMP_GET` - Get a specific OID"},"RetrievalOutputEnum":{"enum":["PTXT","JSON","TBLE","REGX","GREP"],"type":"string","description":"* `PTXT` - Plain text\n* `JSON` - JSON format\n* `TBLE` - Table format\n* `REGX` - Regex processing\n* `GREP` - Grep command output"},"Field":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"order":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"retrieval_value":{"type":"string","nullable":true,"maxLength":255},"override_target":{"type":"boolean","nullable":true},"new_target":{"type":"string","nullable":true},"retrieval_method":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/FieldRetrievalMethodEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"retrieval_output":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/RetrievalOutputEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"section":{"type":"integer"},"options":{"nullable":true}},"required":["id","name"]},"FieldRetrievalMethodEnum":{"enum":["FILE","BASH","PW","CMD"],"type":"string","description":"* `FILE` - Read file\n* `BASH` - Bash command\n* `PW` - Powershell command\n* `CMD` - Cmd command"},"NullEnum":{"enum":[null]}}}} ``` ## The PaginatedTriggerList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedTriggerList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Trigger"}}}},"Trigger":{"type":"object","properties":{"trigger":{"type":"string"},"model_name":{"type":"string"},"action_targets":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"context_fields":{"type":"string","readOnly":true}},"required":["action_targets","context_fields","model_name","trigger"]}}}} ``` ## The PaginatedUserList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedUserList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}},"User":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"username":{"type":"string","description":"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.","pattern":"^[\\w.@+-]+$","maxLength":150},"email":{"title":"Email address","oneOf":[{"type":"string","format":"email","maxLength":254},{"type":"string","maxLength":0}]},"first_name":{"type":"string","maxLength":150},"last_name":{"type":"string","maxLength":150},"password":{"type":"string","writeOnly":true,"maxLength":128},"is_superuser":{"type":"boolean","title":"Superuser status","description":"Designates that this user has all permissions without explicitly assigning them."},"groups":{"type":"array","items":{"type":"integer"},"description":"The groups this user belongs to. A user will get all permissions granted to each of their groups."},"group_assignments":{"type":"string","readOnly":true},"user_permissions":{"type":"array","items":{"type":"integer"},"description":"Specific permissions for this user."}},"required":["group_assignments","id","password","username"]}}}} ``` ## The PaginatedVirtualColList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedVirtualColList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/VirtualCol"}}}},"VirtualCol":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"visibility":{"$ref":"#/components/schemas/VisibilityEnum"},"allow_group_modification":{"type":"boolean"},"name":{"type":"string","maxLength":100},"target":{"$ref":"#/components/schemas/TargetEnum"},"mapping":{},"last_updated":{"type":"string","format":"date-time","readOnly":true},"user":{"type":"integer","readOnly":true},"groups":{"type":"array","items":{"type":"integer"}}},"required":["id","last_updated","name","user"]},"VisibilityEnum":{"enum":["public","private_personal","private_group"],"type":"string","description":"* `public` - Public\n* `private_personal` - Private (Personal)\n* `private_group` - Private (Group)"},"TargetEnum":{"enum":["asset"],"type":"string","description":"* `asset` - Assets"}}}} ``` ## The PaginatedWindowsBuildMappingList object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PaginatedWindowsBuildMappingList":{"type":"object","required":["count","results"],"properties":{"count":{"type":"integer"},"next":{"type":"string","nullable":true,"format":"uri"},"previous":{"type":"string","nullable":true,"format":"uri"},"results":{"type":"array","items":{"$ref":"#/components/schemas/WindowsBuildMapping"}}}},"WindowsBuildMapping":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"build":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","description":"Windows build number (e.g. 22621)"},"channel":{"type":"string","description":"endoflife.date channel slug (e.g. 22h2)","maxLength":20}},"required":["build","channel","id"]}}}} ``` ## The PatchedAccountinfoConfig object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedAccountinfoConfig":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":100},"description":{"type":"string","maxLength":512},"datatype":{"$ref":"#/components/schemas/DatatypeEnum"},"datatarget":{"allOf":[{"$ref":"#/components/schemas/DatatargetEnum"}],"default":"ASSET"},"accountinfo_values":{"type":"array","items":{"type":"integer"},"readOnly":true}}},"DatatypeEnum":{"enum":["TEXT","TEXTAREA","SELECT","CHECKBOX"],"type":"string","description":"* `TEXT` - Text\n* `TEXTAREA` - Textarea\n* `SELECT` - Select\n* `CHECKBOX` - Checkbox"},"DatatargetEnum":{"enum":["ASSET","IPDISCOVER"],"type":"string","description":"* `ASSET` - Assets\n* `IPDISCOVER` - IPDiscover"}}}} ``` ## The PatchedAccountinfoData object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedAccountinfoData":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"accountdata":{"nullable":true},"object_slug":{"type":"string","nullable":true,"maxLength":100},"content_type":{"type":"integer","readOnly":true},"object_id":{"type":"integer","maximum":9223372036854776000,"minimum":0,"format":"int64"}}}}}} ``` ## The PatchedAccountinfoValue object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedAccountinfoValue":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"accountinfo_config":{"type":"integer"},"value":{"type":"string","maxLength":100}}}}}} ``` ## The PatchedAction object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedAction":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"rule":{"type":"integer","nullable":true},"priority":{"type":"integer"},"action":{"$ref":"#/components/schemas/ActionEnum"},"content_type":{"type":"integer","nullable":true},"object_id":{"type":"integer","maximum":9223372036854776000,"minimum":0,"format":"int64","nullable":true},"object_slug":{"type":"string","nullable":true,"maxLength":100},"field":{"type":"string","maxLength":255},"value":{}}},"ActionEnum":{"enum":["set"],"type":"string","description":"* `set` - Set"}}}} ``` ## The PatchedAssetGroup object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedAssetGroup":{"type":"object","description":"Serializer class for AssetGroup","properties":{"id":{"type":"integer","readOnly":true},"visibility":{"$ref":"#/components/schemas/VisibilityEnum"},"allow_group_modification":{"type":"boolean"},"name":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true,"maxLength":255},"is_dynamic":{"type":"boolean"},"search":{"nullable":true},"last_updated":{"type":"string","format":"date-time","readOnly":true},"user":{"type":"integer"},"groups":{"type":"array","items":{"type":"integer"}},"assets":{"type":"array","items":{"type":"integer"}}}},"VisibilityEnum":{"enum":["public","private_personal","private_group"],"type":"string","description":"* `public` - Public\n* `private_personal` - Private (Personal)\n* `private_group` - Private (Group)"}}}} ``` ## The PatchedAuthConfig object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedAuthConfig":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true},"auth_method":{"type":"integer","nullable":true},"enabled":{"type":"boolean"},"priority":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"config":{},"mappings":{"type":"array","items":{"type":"integer"}}}}}}} ``` ## The PatchedAuthMapping object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedAuthMapping":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"auth_config":{"type":"integer","nullable":true},"internal_field":{"type":"string","maxLength":255},"external_field":{"type":"string","maxLength":255}}}}}} ``` ## The PatchedAuthMethod object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedAuthMethod":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"auth_type":{"$ref":"#/components/schemas/AuthTypeEnum"},"enabled":{"type":"boolean"},"priority":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"configs":{"type":"array","items":{"type":"integer"}}}},"AuthTypeEnum":{"enum":["SSO","OTHER"],"type":"string","description":"* `SSO` - SSO\n* `OTHER` - OTHER"}}}} ``` ## The PatchedCategory object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedCategory":{"type":"object","description":"This serialize class provide the API representation\n\nArgs:\n serializers ([ModelSerializer])","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"description":{"type":"string","maxLength":255},"inventory_sections":{"type":"array","items":{"type":"integer"}},"is_protected":{"type":"boolean"}}}}}} ``` ## The PatchedComplianceResult object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedComplianceResult":{"type":"object","description":"Mixin to dynamically expand nested fields based on the \"expand\" query parameter.\n\nTo use, add an `expandable_fields` dictionary in your serializer's Meta:\n\n expandable_fields = {\n \"some_relation\": SomeNestedSerializer,\n \"other_relation\": OtherNestedSerializer,\n }\n\nThe mixin will:\n - Expand all fields and childs if expand=\"*\"\n - Expand fields provided in a comma separated list (expand=field1,field2)\n - or return the pks for the relation","properties":{"id":{"type":"integer","readOnly":true},"asset":{"type":"integer"},"asset_name":{"type":"string","readOnly":true},"rule":{"type":"integer"},"status":{"$ref":"#/components/schemas/ComplianceResultStatusEnum"},"detail":{"nullable":true},"evaluated_at":{"type":"string","format":"date-time","readOnly":true}}},"ComplianceResultStatusEnum":{"enum":["compliant","non_compliant","unknown"],"type":"string","description":"* `compliant` - Compliant\n* `non_compliant` - Non-compliant\n* `unknown` - Unknown"}}}} ``` ## The PatchedComplianceRule object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedComplianceRule":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true,"maxLength":255},"type":{"type":"string","maxLength":50},"severity":{"$ref":"#/components/schemas/SeverityEnum"},"logic":{},"enabled":{"type":"boolean"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}}},"SeverityEnum":{"enum":["critical","high","medium","low"],"type":"string","description":"* `critical` - Critical\n* `high` - High\n* `medium` - Medium\n* `low` - Low"}}}} ``` ## The PatchedComplianceType object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedComplianceType":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50}}}}}} ``` ## The PatchedConfig object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedConfig":{"type":"object","description":"This serialize class provide the API representation","properties":{"name":{"type":"string","maxLength":100},"value":{}}}}}} ``` ## The PatchedCustomEOLExtendedSupport object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedCustomEOLExtendedSupport":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"product":{"type":"string","description":"endoflife.date product slug (e.g. ubuntu)","maxLength":100},"cycle":{"type":"string","description":"Version cycle (e.g. 22.04)","maxLength":50},"is_extended":{"type":"boolean","description":"Whether purchased extended support is active for this product/cycle"}}}}}} ``` ## The PatchedDashboardChartDescriptor object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedDashboardChartDescriptor":{"type":"object","description":"Describes one chart available on the dashboard (returned by the list action)","properties":{"category":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"charttype":{"type":"string"}}}}}} ``` ## The PatchedDashboardLayout object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedDashboardLayout":{"type":"object","description":"This serialize class provide the API representation.","properties":{"id":{"type":"integer","readOnly":true},"visibility":{"$ref":"#/components/schemas/VisibilityEnum"},"user":{"type":"integer"},"groups":{"type":"array","items":{"type":"integer"}},"allow_group_modification":{"type":"boolean"},"name":{"type":"string","maxLength":100},"layout":{}}},"VisibilityEnum":{"enum":["public","private_personal","private_group"],"type":"string","description":"* `public` - Public\n* `private_personal` - Private (Personal)\n* `private_group` - Private (Group)"}}}} ``` ## The PatchedExtension object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedExtension":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"description":{"type":"string","nullable":true,"maxLength":255},"version":{"type":"string","maxLength":255},"author":{"type":"string","nullable":true,"maxLength":255},"enabled":{"type":"boolean"},"django_app":{"type":"string","maxLength":255}}}}}} ``` ## The PatchedField object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedField":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"order":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"retrieval_value":{"type":"string","nullable":true,"maxLength":255},"override_target":{"type":"boolean","nullable":true},"new_target":{"type":"string","nullable":true},"retrieval_method":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/FieldRetrievalMethodEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"retrieval_output":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/RetrievalOutputEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"section":{"type":"integer"},"options":{"nullable":true}}},"FieldRetrievalMethodEnum":{"enum":["FILE","BASH","PW","CMD"],"type":"string","description":"* `FILE` - Read file\n* `BASH` - Bash command\n* `PW` - Powershell command\n* `CMD` - Cmd command"},"NullEnum":{"enum":[null]},"RetrievalOutputEnum":{"enum":["PTXT","JSON","TBLE","REGX","GREP"],"type":"string","description":"* `PTXT` - Plain text\n* `JSON` - JSON format\n* `TBLE` - Table format\n* `REGX` - Regex processing\n* `GREP` - Grep command output"}}}} ``` ## The PatchedFileManager object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedFileManager":{"type":"object","description":"Serializer for the FileManager model.","properties":{"id":{"type":"integer","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"modified_at":{"type":"string","format":"date-time","readOnly":true},"name":{"type":"string","maxLength":255},"file":{"type":"string","format":"uri"},"filesize":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"mimetype":{"type":"string","maxLength":100},"linked_model":{"type":"string","maxLength":100},"uuid":{"type":"string","format":"uuid","readOnly":true}}}}}} ``` ## The PatchedGroup object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedGroup":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":150},"permissions":{"type":"array","items":{"type":"integer"}},"is_protected":{"type":"boolean","writeOnly":true}}}}}} ``` ## The PatchedHistory object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedHistory":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"scheduler":{"type":"integer"},"date":{"type":"string","format":"date-time","readOnly":true},"status":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"comment":{"type":"string","maxLength":255}}}}}} ``` ## The PatchedInventoryBase object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedInventoryBase":{"type":"object","description":"Serializer class for Base","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true,"maxLength":255},"serial":{"type":"string","maxLength":255},"osname":{"type":"string","maxLength":255},"osversion":{"type":"string","maxLength":255},"uuid":{"type":"string","maxLength":255},"srcip":{"type":"string","maxLength":255},"srcmac":{"type":"string","maxLength":255},"domain":{"type":"string","maxLength":255},"agent":{"type":"string","maxLength":255},"template":{"type":"integer","nullable":true},"last_update":{"type":"string","format":"date-time","readOnly":true},"is_template_forced":{"type":"boolean"},"matched":{"type":"string","readOnly":true}}}}}} ``` ## The PatchedInventoryField object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedInventoryField":{"type":"object","description":"Serializer class for InventoryField","properties":{"id":{"type":"integer","readOnly":true},"inventory_section":{"type":"integer"},"template_field":{"type":"integer"},"value":{"type":"string","nullable":true}}}}}} ``` ## The PatchedInventorySection object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedInventorySection":{"type":"object","description":"Serializer class for InventorySection","properties":{"id":{"type":"integer","readOnly":true},"base":{"type":"integer"},"template_section":{"type":"integer"},"fields":{"type":"array","items":{"type":"integer"}}}}}}} ``` ## The PatchedLog object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedLog":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"asset":{"type":"integer","nullable":true},"timestamp":{"type":"string","format":"date-time","readOnly":true},"scope":{"$ref":"#/components/schemas/ScopeEnum"},"comment":{"type":"string","maxLength":255}}},"ScopeEnum":{"enum":["INVENTORY_BASE_INSERT","INVENTORY_BASE_UPDATE","INVENTORY_EXT_INSERT","INVENTORY_EXT_UPDATE","INVENTORY_BASE_ERR","INVENTORY_EXT_ERR","DEPLOYMENT_ACK","DEPLOYMENT_ERR","CONFIG_UPDATE","CONFIG_ERR","TEMPLATE_UPDATE","TEMPLATE_ERR","UNKNOWN"],"type":"string","description":"* `INVENTORY_BASE_INSERT` - Inserting new items into the base inventory\n* `INVENTORY_BASE_UPDATE` - Updating existing items in the base inventory\n* `INVENTORY_EXT_INSERT` - Inserting new items into the extended inventory\n* `INVENTORY_EXT_UPDATE` - Updating existing items in the extended inventory\n* `INVENTORY_BASE_ERR` - Error related to the base inventory operations\n* `INVENTORY_EXT_ERR` - Error related to the extended inventory operations\n* `DEPLOYMENT_ACK` - Acknowledgment of a successful deployment\n* `DEPLOYMENT_ERR` - Error during the deployment process\n* `CONFIG_UPDATE` - Updating configuration settings\n* `CONFIG_ERR` - Error related to configuration operations\n* `TEMPLATE_UPDATE` - Updating templates for a process\n* `TEMPLATE_ERR` - Error related to template operations\n* `UNKNOWN` - Unknown error happend (default)"}}}} ``` ## The PatchedMyAccount object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedMyAccount":{"type":"object","description":"This serialize class provide the API representation\n\nArgs:\n serializers ([ModelSerializer])","properties":{"id":{"type":"integer","readOnly":true},"username":{"type":"string","description":"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.","pattern":"^[\\w.@+-]+$","maxLength":150},"email":{"title":"Email address","oneOf":[{"type":"string","format":"email","maxLength":254},{"type":"string","maxLength":0}]},"first_name":{"type":"string","maxLength":150},"last_name":{"type":"string","maxLength":150},"password":{"type":"string","writeOnly":true,"maxLength":128},"is_superuser":{"type":"boolean","readOnly":true,"title":"Superuser status","description":"Designates that this user has all permissions without explicitly assigning them."},"groups":{"type":"array","items":{"type":"integer"},"readOnly":true,"description":"The groups this user belongs to. A user will get all permissions granted to each of their groups."},"group_assignments":{"type":"string","readOnly":true},"user_permissions":{"type":"array","items":{"type":"integer"},"readOnly":true,"description":"Specific permissions for this user."}}}}}} ``` ## The PatchedNetdevice object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedNetdevice":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"ip":{"type":"string"},"netname":{"type":"string","maxLength":128},"mac":{"type":"string","maxLength":20},"network":{"type":"integer"},"last_seen":{"type":"string","format":"date-time","readOnly":true}}}}}} ``` ## The PatchedNetgroup object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedNetgroup":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":128},"description":{"type":"string","maxLength":1024}}}}}} ``` ## The PatchedNetwork object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedNetwork":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"nettag":{"type":"string","maxLength":128},"name":{"type":"string","maxLength":128},"description":{"type":"string","maxLength":1024},"netid":{"type":"string"},"mask":{"type":"string"},"netdevices":{"type":"array","items":{"$ref":"#/components/schemas/Netdevice"}},"group":{"type":"integer","nullable":true},"last_update":{"type":"string","format":"date-time","readOnly":true}}},"Netdevice":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"ip":{"type":"string"},"netname":{"type":"string","maxLength":128},"mac":{"type":"string","maxLength":20},"network":{"type":"integer"},"last_seen":{"type":"string","format":"date-time","readOnly":true}},"required":["id","ip","last_seen","mac","netname"]}}}} ``` ## The PatchedNote object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedNote":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"text":{"type":"string"},"creator":{"type":"integer"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true},"object_slug":{"type":"string","nullable":true,"maxLength":100},"content_type":{"type":"integer","readOnly":true,"nullable":true},"object_id":{"type":"integer","maximum":9223372036854776000,"minimum":0,"format":"int64","nullable":true}}}}}} ``` ## The PatchedPackage object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedPackage":{"type":"object","description":"This serializer class provides the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":128},"description":{"type":"string"},"date_created":{"type":"string","format":"date-time","readOnly":true},"target_os":{"$ref":"#/components/schemas/TargetOsEnum"},"actions_list":{"type":"array","items":{"$ref":"#/components/schemas/Action"}},"result":{"type":"array","items":{"$ref":"#/components/schemas/Result"}}}},"TargetOsEnum":{"enum":["WIN","LIN","MAC"],"type":"string","description":"* `WIN` - Windows\n* `LIN` - Linux\n* `MAC` - Mac"},"Action":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"rule":{"type":"integer","nullable":true},"priority":{"type":"integer"},"action":{"$ref":"#/components/schemas/ActionEnum"},"content_type":{"type":"integer","nullable":true},"object_id":{"type":"integer","maximum":9223372036854776000,"minimum":0,"format":"int64","nullable":true},"object_slug":{"type":"string","nullable":true,"maxLength":100},"field":{"type":"string","maxLength":255},"value":{}},"required":["action","field","id","value"]},"ActionEnum":{"enum":["set"],"type":"string","description":"* `set` - Set"},"Result":{"type":"object","description":"This serializer class provides the API representation","properties":{"id":{"type":"integer","readOnly":true},"package":{"type":"integer","nullable":true},"asset":{"type":"integer","nullable":true},"group":{"type":"integer","nullable":true},"name":{"type":"string","maxLength":128},"status":{"allOf":[{"$ref":"#/components/schemas/ResultStatusEnum"}],"minimum":-9223372036854776000,"maximum":9223372036854776000},"comment":{"type":"string","nullable":true},"date_created":{"type":"string","format":"date-time","readOnly":true}},"required":["asset","date_created","group","id","name"]},"ResultStatusEnum":{"enum":[0,1,2,3],"type":"integer","description":"* `0` - Sucess\n* `1` - Waiting notification\n* `2` - Notified\n* `3` - Error"}}}} ``` ## The PatchedResult object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedResult":{"type":"object","description":"This serializer class provides the API representation","properties":{"id":{"type":"integer","readOnly":true},"package":{"type":"integer","nullable":true},"asset":{"type":"integer","nullable":true},"group":{"type":"integer","nullable":true},"name":{"type":"string","maxLength":128},"status":{"allOf":[{"$ref":"#/components/schemas/ResultStatusEnum"}],"minimum":-9223372036854776000,"maximum":9223372036854776000},"comment":{"type":"string","nullable":true},"date_created":{"type":"string","format":"date-time","readOnly":true}}},"ResultStatusEnum":{"enum":[0,1,2,3],"type":"integer","description":"* `0` - Sucess\n* `1` - Waiting notification\n* `2` - Notified\n* `3` - Error"}}}} ``` ## The PatchedRule object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedRule":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"priority":{"type":"integer"},"description":{"type":"string","nullable":true,"maxLength":255},"trigger":{"$ref":"#/components/schemas/TriggerEnum"},"enabled":{"type":"boolean"},"logic":{},"break_on_match":{"type":"boolean"},"actions":{"type":"array","items":{"type":"integer"}}}},"TriggerEnum":{"enum":["inventory_received","user_login","netdevice_received"],"type":"string","description":"* `inventory_received` - Inventory Received\n* `user_login` - User Login\n* `netdevice_received` - Netdevice Received"}}}} ``` ## The PatchedScheduler object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedScheduler":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":100},"description":{"type":"string","maxLength":1024},"active":{"type":"boolean"},"recurrence":{"$ref":"#/components/schemas/RecurrenceEnum"},"last_execution":{"type":"string","format":"date-time","nullable":true},"hour":{"type":"string","format":"time","nullable":true},"day_of_week":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"day_of_month":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"is_protected":{"type":"boolean"}}},"RecurrenceEnum":{"enum":["hourly","daily","weekly","monthly"],"type":"string","description":"* `hourly` - hourly\n* `daily` - daily\n* `weekly` - weekly\n* `monthly` - monthly"}}}} ``` ## The PatchedSearch object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedSearch":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"visibility":{"$ref":"#/components/schemas/VisibilityEnum"},"allow_group_modification":{"type":"boolean"},"search":{},"last_updated":{"type":"string","format":"date-time","readOnly":true},"name":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true},"user":{"type":"integer"},"groups":{"type":"array","items":{"type":"integer"}}}},"VisibilityEnum":{"enum":["public","private_personal","private_group"],"type":"string","description":"* `public` - Public\n* `private_personal` - Private (Personal)\n* `private_group` - Private (Group)"}}}} ``` ## The PatchedSection object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedSection":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"retrieval_method":{"$ref":"#/components/schemas/SectionRetrievalMethodEnum"},"retrieval_output":{"$ref":"#/components/schemas/RetrievalOutputEnum"},"target":{"type":"string"},"template":{"type":"integer"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/Field"}},"options":{"nullable":true},"is_active":{"type":"boolean"}}},"SectionRetrievalMethodEnum":{"enum":["FILE","BASH","PW","CMD","SNMP_WALK","SNMP_GET"],"type":"string","description":"* `FILE` - Read file\n* `BASH` - Bash command\n* `PW` - Powershell command\n* `CMD` - Cmd command\n* `SNMP_WALK` - Walk the SNMP tree starting from a specific OID\n* `SNMP_GET` - Get a specific OID"},"RetrievalOutputEnum":{"enum":["PTXT","JSON","TBLE","REGX","GREP"],"type":"string","description":"* `PTXT` - Plain text\n* `JSON` - JSON format\n* `TBLE` - Table format\n* `REGX` - Regex processing\n* `GREP` - Grep command output"},"Field":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"order":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"retrieval_value":{"type":"string","nullable":true,"maxLength":255},"override_target":{"type":"boolean","nullable":true},"new_target":{"type":"string","nullable":true},"retrieval_method":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/FieldRetrievalMethodEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"retrieval_output":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/RetrievalOutputEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"section":{"type":"integer"},"options":{"nullable":true}},"required":["id","name"]},"FieldRetrievalMethodEnum":{"enum":["FILE","BASH","PW","CMD"],"type":"string","description":"* `FILE` - Read file\n* `BASH` - Bash command\n* `PW` - Powershell command\n* `CMD` - Cmd command"},"NullEnum":{"enum":[null]}}}} ``` ## The PatchedSnmpConfig object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedSnmpConfig":{"type":"object","description":"This serializer class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":128},"version":{"$ref":"#/components/schemas/VersionEnum"},"user":{"type":"string","nullable":true,"maxLength":128},"auth_level":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/AuthLevelEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"password":{"type":"string","nullable":true,"maxLength":128},"auth_protocol":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/AuthProtocolEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"priv_protocol":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/PrivProtocolEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"priv_password":{"type":"string","nullable":true,"maxLength":128},"retries":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"timeout":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"subnets":{}}},"VersionEnum":{"enum":["1","2c","3"],"type":"string","description":"* `1` - SNMPv1\n* `2c` - SNMPv2c\n* `3` - SNMPv3"},"AuthLevelEnum":{"enum":["noAuthNoPriv","authNoPriv","authPriv"],"type":"string","description":"* `noAuthNoPriv` - noAuthNoPriv\n* `authNoPriv` - authNoPriv\n* `authPriv` - authPriv"},"BlankEnum":{"enum":[""]},"NullEnum":{"enum":[null]},"AuthProtocolEnum":{"enum":["MD5","SHA","None"],"type":"string","description":"* `MD5` - MD5\n* `SHA` - SHA\n* `None` - None"},"PrivProtocolEnum":{"enum":["DES","AES","None"],"type":"string","description":"* `DES` - DES\n* `AES` - AES\n* `None` - None"}}}} ``` ## The PatchedSnmpScanner object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedSnmpScanner":{"type":"object","description":"This serializer class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":100},"ip":{"type":"string"},"subnets":{},"notes":{"type":"string","nullable":true},"last_updated":{"type":"string","format":"date-time","readOnly":true},"total_scanned":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"total_found":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"last_scan_date":{"type":"string","format":"date-time","nullable":true},"configs":{"type":"array","items":{"type":"integer"}},"assets":{"type":"array","items":{"type":"integer"}}}}}}} ``` ## The PatchedSoftwareDictionary object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedSoftwareDictionary":{"type":"object","description":"Serialize aggregated asset/software relationships","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"version":{"type":"string","nullable":true,"maxLength":128},"major_version":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"minor_version":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"patch_version":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"assets":{"type":"array","items":{"type":"integer"},"readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true},"installation_number":{"type":"integer","readOnly":true}}}}}} ``` ## The PatchedSoftwareMapping object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedSoftwareMapping":{"type":"object","description":"Mixin to dynamically expand nested fields based on the \"expand\" query parameter.\n\nTo use, add an `expandable_fields` dictionary in your serializer's Meta:\n\n expandable_fields = {\n \"some_relation\": SomeNestedSerializer,\n \"other_relation\": OtherNestedSerializer,\n }\n\nThe mixin will:\n - Expand all fields and childs if expand=\"*\"\n - Expand fields provided in a comma separated list (expand=field1,field2)\n - or return the pks for the relation","properties":{"id":{"type":"integer","readOnly":true},"template":{"type":"integer"},"section":{"type":"integer"},"name":{"type":"integer","nullable":true},"publisher":{"type":"integer","nullable":true},"version":{"type":"integer","nullable":true},"major_version":{"type":"integer","nullable":true},"minor_version":{"type":"integer","nullable":true},"patch_version":{"type":"integer","nullable":true}}}}}} ``` ## The PatchedTemplate object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedTemplate":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"os":{"$ref":"#/components/schemas/OsEnum"},"is_protected":{"type":"boolean"},"last_update":{"type":"string","format":"date-time","readOnly":true},"sections":{"type":"array","items":{"$ref":"#/components/schemas/Section"}}}},"OsEnum":{"enum":["LEG","DEB","RHEL","MAC","WIN","SNMP","VIRT"],"type":"string","description":"* `LEG` - Legacy\n* `DEB` - Linux (Debian based)\n* `RHEL` - Linux (RHEL based)\n* `MAC` - Mac\n* `WIN` - Windows\n* `SNMP` - SNMP\n* `VIRT` - Virtualization"},"Section":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"retrieval_method":{"$ref":"#/components/schemas/SectionRetrievalMethodEnum"},"retrieval_output":{"$ref":"#/components/schemas/RetrievalOutputEnum"},"target":{"type":"string"},"template":{"type":"integer"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/Field"}},"options":{"nullable":true},"is_active":{"type":"boolean"}},"required":["fields","id","name","target"]},"SectionRetrievalMethodEnum":{"enum":["FILE","BASH","PW","CMD","SNMP_WALK","SNMP_GET"],"type":"string","description":"* `FILE` - Read file\n* `BASH` - Bash command\n* `PW` - Powershell command\n* `CMD` - Cmd command\n* `SNMP_WALK` - Walk the SNMP tree starting from a specific OID\n* `SNMP_GET` - Get a specific OID"},"RetrievalOutputEnum":{"enum":["PTXT","JSON","TBLE","REGX","GREP"],"type":"string","description":"* `PTXT` - Plain text\n* `JSON` - JSON format\n* `TBLE` - Table format\n* `REGX` - Regex processing\n* `GREP` - Grep command output"},"Field":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"order":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"retrieval_value":{"type":"string","nullable":true,"maxLength":255},"override_target":{"type":"boolean","nullable":true},"new_target":{"type":"string","nullable":true},"retrieval_method":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/FieldRetrievalMethodEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"retrieval_output":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/RetrievalOutputEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"section":{"type":"integer"},"options":{"nullable":true}},"required":["id","name"]},"FieldRetrievalMethodEnum":{"enum":["FILE","BASH","PW","CMD"],"type":"string","description":"* `FILE` - Read file\n* `BASH` - Bash command\n* `PW` - Powershell command\n* `CMD` - Cmd command"},"NullEnum":{"enum":[null]}}}} ``` ## The PatchedTrigger object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedTrigger":{"type":"object","properties":{"trigger":{"type":"string"},"model_name":{"type":"string"},"action_targets":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"context_fields":{"type":"string","readOnly":true}}}}}} ``` ## The PatchedUser object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedUser":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"username":{"type":"string","description":"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.","pattern":"^[\\w.@+-]+$","maxLength":150},"email":{"title":"Email address","oneOf":[{"type":"string","format":"email","maxLength":254},{"type":"string","maxLength":0}]},"first_name":{"type":"string","maxLength":150},"last_name":{"type":"string","maxLength":150},"password":{"type":"string","writeOnly":true,"maxLength":128},"is_superuser":{"type":"boolean","title":"Superuser status","description":"Designates that this user has all permissions without explicitly assigning them."},"groups":{"type":"array","items":{"type":"integer"},"description":"The groups this user belongs to. A user will get all permissions granted to each of their groups."},"group_assignments":{"type":"string","readOnly":true},"user_permissions":{"type":"array","items":{"type":"integer"},"description":"Specific permissions for this user."}}}}}} ``` ## The PatchedVirtualCol object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedVirtualCol":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"visibility":{"$ref":"#/components/schemas/VisibilityEnum"},"allow_group_modification":{"type":"boolean"},"name":{"type":"string","maxLength":100},"target":{"$ref":"#/components/schemas/TargetEnum"},"mapping":{},"last_updated":{"type":"string","format":"date-time","readOnly":true},"user":{"type":"integer","readOnly":true},"groups":{"type":"array","items":{"type":"integer"}}}},"VisibilityEnum":{"enum":["public","private_personal","private_group"],"type":"string","description":"* `public` - Public\n* `private_personal` - Private (Personal)\n* `private_group` - Private (Group)"},"TargetEnum":{"enum":["asset"],"type":"string","description":"* `asset` - Assets"}}}} ``` ## The PatchedWindowsBuildMapping object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PatchedWindowsBuildMapping":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"build":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","description":"Windows build number (e.g. 22621)"},"channel":{"type":"string","description":"endoflife.date channel slug (e.g. 22h2)","maxLength":20}}}}}} ``` ## The Permission object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Permission":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":255},"content_type":{"type":"integer"},"codename":{"type":"string","maxLength":100}},"required":["codename","content_type","id","name"]}}}} ``` ## The PrivProtocolEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"PrivProtocolEnum":{"enum":["DES","AES","None"],"type":"string","description":"* `DES` - DES\n* `AES` - AES\n* `None` - None"}}}} ``` ## The ReconciliationError object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"ReconciliationError":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}} ``` ## The ReconciliationResponse object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"ReconciliationResponse":{"type":"object","description":"id: the matched asset's id, or False if no asset matched","properties":{"id":{}},"required":["id"]}}}} ``` ## The RecurrenceEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"RecurrenceEnum":{"enum":["hourly","daily","weekly","monthly"],"type":"string","description":"* `hourly` - hourly\n* `daily` - daily\n* `weekly` - weekly\n* `monthly` - monthly"}}}} ``` ## The Result object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Result":{"type":"object","description":"This serializer class provides the API representation","properties":{"id":{"type":"integer","readOnly":true},"package":{"type":"integer","nullable":true},"asset":{"type":"integer","nullable":true},"group":{"type":"integer","nullable":true},"name":{"type":"string","maxLength":128},"status":{"allOf":[{"$ref":"#/components/schemas/ResultStatusEnum"}],"minimum":-9223372036854776000,"maximum":9223372036854776000},"comment":{"type":"string","nullable":true},"date_created":{"type":"string","format":"date-time","readOnly":true}},"required":["asset","date_created","group","id","name"]},"ResultStatusEnum":{"enum":[0,1,2,3],"type":"integer","description":"* `0` - Sucess\n* `1` - Waiting notification\n* `2` - Notified\n* `3` - Error"}}}} ``` ## The ResultStatusEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"ResultStatusEnum":{"enum":[0,1,2,3],"type":"integer","description":"* `0` - Sucess\n* `1` - Waiting notification\n* `2` - Notified\n* `3` - Error"}}}} ``` ## The RetrievalOutputEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"RetrievalOutputEnum":{"enum":["PTXT","JSON","TBLE","REGX","GREP"],"type":"string","description":"* `PTXT` - Plain text\n* `JSON` - JSON format\n* `TBLE` - Table format\n* `REGX` - Regex processing\n* `GREP` - Grep command output"}}}} ``` ## The Rule object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Rule":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"priority":{"type":"integer"},"description":{"type":"string","nullable":true,"maxLength":255},"trigger":{"$ref":"#/components/schemas/TriggerEnum"},"enabled":{"type":"boolean"},"logic":{},"break_on_match":{"type":"boolean"},"actions":{"type":"array","items":{"type":"integer"}}},"required":["actions","id","logic","trigger"]},"TriggerEnum":{"enum":["inventory_received","user_login","netdevice_received"],"type":"string","description":"* `inventory_received` - Inventory Received\n* `user_login` - User Login\n* `netdevice_received` - Netdevice Received"}}}} ``` ## The Scheduler object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Scheduler":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":100},"description":{"type":"string","maxLength":1024},"active":{"type":"boolean"},"recurrence":{"$ref":"#/components/schemas/RecurrenceEnum"},"last_execution":{"type":"string","format":"date-time","nullable":true},"hour":{"type":"string","format":"time","nullable":true},"day_of_week":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"day_of_month":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"is_protected":{"type":"boolean"}},"required":["active","description","id","name"]},"RecurrenceEnum":{"enum":["hourly","daily","weekly","monthly"],"type":"string","description":"* `hourly` - hourly\n* `daily` - daily\n* `weekly` - weekly\n* `monthly` - monthly"}}}} ``` ## The ScopeEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"ScopeEnum":{"enum":["INVENTORY_BASE_INSERT","INVENTORY_BASE_UPDATE","INVENTORY_EXT_INSERT","INVENTORY_EXT_UPDATE","INVENTORY_BASE_ERR","INVENTORY_EXT_ERR","DEPLOYMENT_ACK","DEPLOYMENT_ERR","CONFIG_UPDATE","CONFIG_ERR","TEMPLATE_UPDATE","TEMPLATE_ERR","UNKNOWN"],"type":"string","description":"* `INVENTORY_BASE_INSERT` - Inserting new items into the base inventory\n* `INVENTORY_BASE_UPDATE` - Updating existing items in the base inventory\n* `INVENTORY_EXT_INSERT` - Inserting new items into the extended inventory\n* `INVENTORY_EXT_UPDATE` - Updating existing items in the extended inventory\n* `INVENTORY_BASE_ERR` - Error related to the base inventory operations\n* `INVENTORY_EXT_ERR` - Error related to the extended inventory operations\n* `DEPLOYMENT_ACK` - Acknowledgment of a successful deployment\n* `DEPLOYMENT_ERR` - Error during the deployment process\n* `CONFIG_UPDATE` - Updating configuration settings\n* `CONFIG_ERR` - Error related to configuration operations\n* `TEMPLATE_UPDATE` - Updating templates for a process\n* `TEMPLATE_ERR` - Error related to template operations\n* `UNKNOWN` - Unknown error happend (default)"}}}} ``` ## The Search object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Search":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"visibility":{"$ref":"#/components/schemas/VisibilityEnum"},"allow_group_modification":{"type":"boolean"},"search":{},"last_updated":{"type":"string","format":"date-time","readOnly":true},"name":{"type":"string","maxLength":50},"description":{"type":"string","nullable":true},"user":{"type":"integer"},"groups":{"type":"array","items":{"type":"integer"}}},"required":["id","last_updated","name","search","user"]},"VisibilityEnum":{"enum":["public","private_personal","private_group"],"type":"string","description":"* `public` - Public\n* `private_personal` - Private (Personal)\n* `private_group` - Private (Group)"}}}} ``` ## The SearchCondition object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"SearchCondition":{"type":"object","description":"One search condition, as sent in a search_data AND-group.\n\nExample:\n{\"object\": \"software_dictionary_entries\", \"route\": \"software_dictionary\",\n \"field\": \"name\", \"fieldtype\": \"string\", \"operator\": \"iexact\",\n \"value\": \"Git\", \"link\": \"AND\"}","properties":{"object":{"type":"string","description":"Target model key, e.g. 'InventoryBase', 'AccountinfoConfig', 'results', 'logs', 'snmpscanner', 'inventory_sections', 'software_dictionary_entries'."},"route":{"type":"string","description":"Frontend route associated with the condition."},"field":{"type":"string","description":"Field name to filter on."},"fieldtype":{"type":"string","description":"Field type hint, e.g. 'string', 'select', 'checkbox'."},"operator":{"type":"string","description":"Lookup operator, e.g. 'exact', 'iexact', 'icontains', 'istartswith', 'iendswith'."},"value":{"description":"Value to compare the field against."},"link":{"allOf":[{"$ref":"#/components/schemas/LinkEnum"}],"default":"AND","description":"How this condition links to the previous one.\n\n* `AND` - AND\n* `OR` - OR"},"section":{"type":"string","description":"Template section id, required when object is 'inventory_sections'."}},"required":["field","object","operator","value"]},"LinkEnum":{"enum":["AND","OR"],"type":"string","description":"* `AND` - AND\n* `OR` - OR"}}}} ``` ## The SearchError object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"SearchError":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}} ``` ## The SearchRequest object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"SearchRequest":{"type":"object","description":"Payload accepted by POST /search/.\n\nsearch_data is a list of AND-groups; groups are combined using each\ngroup's first condition 'link' (AND/OR).","properties":{"search_data":{"type":"array","items":{"type":"array","items":{"$ref":"#/components/schemas/SearchCondition"}},"description":"List of AND-condition groups to combine into the search query."},"grouped":{"type":"boolean","default":true,"description":"If true, results are grouped by asset with a single matched row per relation."},"ungroup":{"type":"boolean","default":false,"description":"If true, one row is returned per matched related record instead of one per asset."}}},"SearchCondition":{"type":"object","description":"One search condition, as sent in a search_data AND-group.\n\nExample:\n{\"object\": \"software_dictionary_entries\", \"route\": \"software_dictionary\",\n \"field\": \"name\", \"fieldtype\": \"string\", \"operator\": \"iexact\",\n \"value\": \"Git\", \"link\": \"AND\"}","properties":{"object":{"type":"string","description":"Target model key, e.g. 'InventoryBase', 'AccountinfoConfig', 'results', 'logs', 'snmpscanner', 'inventory_sections', 'software_dictionary_entries'."},"route":{"type":"string","description":"Frontend route associated with the condition."},"field":{"type":"string","description":"Field name to filter on."},"fieldtype":{"type":"string","description":"Field type hint, e.g. 'string', 'select', 'checkbox'."},"operator":{"type":"string","description":"Lookup operator, e.g. 'exact', 'iexact', 'icontains', 'istartswith', 'iendswith'."},"value":{"description":"Value to compare the field against."},"link":{"allOf":[{"$ref":"#/components/schemas/LinkEnum"}],"default":"AND","description":"How this condition links to the previous one.\n\n* `AND` - AND\n* `OR` - OR"},"section":{"type":"string","description":"Template section id, required when object is 'inventory_sections'."}},"required":["field","object","operator","value"]},"LinkEnum":{"enum":["AND","OR"],"type":"string","description":"* `AND` - AND\n* `OR` - OR"}}}} ``` ## The Section object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Section":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"retrieval_method":{"$ref":"#/components/schemas/SectionRetrievalMethodEnum"},"retrieval_output":{"$ref":"#/components/schemas/RetrievalOutputEnum"},"target":{"type":"string"},"template":{"type":"integer"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/Field"}},"options":{"nullable":true},"is_active":{"type":"boolean"}},"required":["fields","id","name","target"]},"SectionRetrievalMethodEnum":{"enum":["FILE","BASH","PW","CMD","SNMP_WALK","SNMP_GET"],"type":"string","description":"* `FILE` - Read file\n* `BASH` - Bash command\n* `PW` - Powershell command\n* `CMD` - Cmd command\n* `SNMP_WALK` - Walk the SNMP tree starting from a specific OID\n* `SNMP_GET` - Get a specific OID"},"RetrievalOutputEnum":{"enum":["PTXT","JSON","TBLE","REGX","GREP"],"type":"string","description":"* `PTXT` - Plain text\n* `JSON` - JSON format\n* `TBLE` - Table format\n* `REGX` - Regex processing\n* `GREP` - Grep command output"},"Field":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"order":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"retrieval_value":{"type":"string","nullable":true,"maxLength":255},"override_target":{"type":"boolean","nullable":true},"new_target":{"type":"string","nullable":true},"retrieval_method":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/FieldRetrievalMethodEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"retrieval_output":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/RetrievalOutputEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"section":{"type":"integer"},"options":{"nullable":true}},"required":["id","name"]},"FieldRetrievalMethodEnum":{"enum":["FILE","BASH","PW","CMD"],"type":"string","description":"* `FILE` - Read file\n* `BASH` - Bash command\n* `PW` - Powershell command\n* `CMD` - Cmd command"},"NullEnum":{"enum":[null]}}}} ``` ## The SectionRetrievalMethodEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"SectionRetrievalMethodEnum":{"enum":["FILE","BASH","PW","CMD","SNMP_WALK","SNMP_GET"],"type":"string","description":"* `FILE` - Read file\n* `BASH` - Bash command\n* `PW` - Powershell command\n* `CMD` - Cmd command\n* `SNMP_WALK` - Walk the SNMP tree starting from a specific OID\n* `SNMP_GET` - Get a specific OID"}}}} ``` ## The ServerInfo object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"ServerInfo":{"type":"object","properties":{"backend_version":{"type":"string","nullable":true},"authentication_type":{"type":"array","items":{"type":"string"}},"infrastructure_type":{"type":"string","nullable":true},"operating_system":{"type":"string","nullable":true},"operating_system_version":{"type":"string","nullable":true},"db_engine":{"type":"string","nullable":true},"ocs_configuration":{},"python_version":{"type":"string","nullable":true},"python_libs_version":{"type":"object","additionalProperties":{"type":"string","nullable":true}}},"required":["authentication_type","backend_version","db_engine","infrastructure_type","ocs_configuration","operating_system","operating_system_version","python_libs_version","python_version"]}}}} ``` ## The SeverityEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"SeverityEnum":{"enum":["critical","high","medium","low"],"type":"string","description":"* `critical` - Critical\n* `high` - High\n* `medium` - Medium\n* `low` - Low"}}}} ``` ## The SnmpConfig object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"SnmpConfig":{"type":"object","description":"This serializer class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":128},"version":{"$ref":"#/components/schemas/VersionEnum"},"user":{"type":"string","nullable":true,"maxLength":128},"auth_level":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/AuthLevelEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"password":{"type":"string","nullable":true,"maxLength":128},"auth_protocol":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/AuthProtocolEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"priv_protocol":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/PrivProtocolEnum"},{"$ref":"#/components/schemas/BlankEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"priv_password":{"type":"string","nullable":true,"maxLength":128},"retries":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"timeout":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"subnets":{}},"required":["id","name","subnets","version"]},"VersionEnum":{"enum":["1","2c","3"],"type":"string","description":"* `1` - SNMPv1\n* `2c` - SNMPv2c\n* `3` - SNMPv3"},"AuthLevelEnum":{"enum":["noAuthNoPriv","authNoPriv","authPriv"],"type":"string","description":"* `noAuthNoPriv` - noAuthNoPriv\n* `authNoPriv` - authNoPriv\n* `authPriv` - authPriv"},"BlankEnum":{"enum":[""]},"NullEnum":{"enum":[null]},"AuthProtocolEnum":{"enum":["MD5","SHA","None"],"type":"string","description":"* `MD5` - MD5\n* `SHA` - SHA\n* `None` - None"},"PrivProtocolEnum":{"enum":["DES","AES","None"],"type":"string","description":"* `DES` - DES\n* `AES` - AES\n* `None` - None"}}}} ``` ## The SnmpScanner object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"SnmpScanner":{"type":"object","description":"This serializer class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":100},"ip":{"type":"string"},"subnets":{},"notes":{"type":"string","nullable":true},"last_updated":{"type":"string","format":"date-time","readOnly":true},"total_scanned":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"total_found":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"last_scan_date":{"type":"string","format":"date-time","nullable":true},"configs":{"type":"array","items":{"type":"integer"}},"assets":{"type":"array","items":{"type":"integer"}}},"required":["id","ip","last_updated","name"]}}}} ``` ## The SoftwareDictionary object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"SoftwareDictionary":{"type":"object","description":"Serialize aggregated asset/software relationships","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","nullable":true},"publisher":{"type":"string","nullable":true},"version":{"type":"string","nullable":true,"maxLength":128},"major_version":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"minor_version":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"patch_version":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","nullable":true},"assets":{"type":"array","items":{"type":"integer"},"readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true},"installation_number":{"type":"integer","readOnly":true}},"required":["assets","id","installation_number","updated_at"]}}}} ``` ## The SoftwareMapping object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"SoftwareMapping":{"type":"object","description":"Mixin to dynamically expand nested fields based on the \"expand\" query parameter.\n\nTo use, add an `expandable_fields` dictionary in your serializer's Meta:\n\n expandable_fields = {\n \"some_relation\": SomeNestedSerializer,\n \"other_relation\": OtherNestedSerializer,\n }\n\nThe mixin will:\n - Expand all fields and childs if expand=\"*\"\n - Expand fields provided in a comma separated list (expand=field1,field2)\n - or return the pks for the relation","properties":{"id":{"type":"integer","readOnly":true},"template":{"type":"integer"},"section":{"type":"integer"},"name":{"type":"integer","nullable":true},"publisher":{"type":"integer","nullable":true},"version":{"type":"integer","nullable":true},"major_version":{"type":"integer","nullable":true},"minor_version":{"type":"integer","nullable":true},"patch_version":{"type":"integer","nullable":true}},"required":["id","section","template"]}}}} ``` ## The TargetEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"TargetEnum":{"enum":["asset"],"type":"string","description":"* `asset` - Assets"}}}} ``` ## The TargetOsEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"TargetOsEnum":{"enum":["WIN","LIN","MAC"],"type":"string","description":"* `WIN` - Windows\n* `LIN` - Linux\n* `MAC` - Mac"}}}} ``` ## The Template object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Template":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"os":{"$ref":"#/components/schemas/OsEnum"},"is_protected":{"type":"boolean"},"last_update":{"type":"string","format":"date-time","readOnly":true},"sections":{"type":"array","items":{"$ref":"#/components/schemas/Section"}}},"required":["id","last_update","name","sections"]},"OsEnum":{"enum":["LEG","DEB","RHEL","MAC","WIN","SNMP","VIRT"],"type":"string","description":"* `LEG` - Legacy\n* `DEB` - Linux (Debian based)\n* `RHEL` - Linux (RHEL based)\n* `MAC` - Mac\n* `WIN` - Windows\n* `SNMP` - SNMP\n* `VIRT` - Virtualization"},"Section":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"retrieval_method":{"$ref":"#/components/schemas/SectionRetrievalMethodEnum"},"retrieval_output":{"$ref":"#/components/schemas/RetrievalOutputEnum"},"target":{"type":"string"},"template":{"type":"integer"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/Field"}},"options":{"nullable":true},"is_active":{"type":"boolean"}},"required":["fields","id","name","target"]},"SectionRetrievalMethodEnum":{"enum":["FILE","BASH","PW","CMD","SNMP_WALK","SNMP_GET"],"type":"string","description":"* `FILE` - Read file\n* `BASH` - Bash command\n* `PW` - Powershell command\n* `CMD` - Cmd command\n* `SNMP_WALK` - Walk the SNMP tree starting from a specific OID\n* `SNMP_GET` - Get a specific OID"},"RetrievalOutputEnum":{"enum":["PTXT","JSON","TBLE","REGX","GREP"],"type":"string","description":"* `PTXT` - Plain text\n* `JSON` - JSON format\n* `TBLE` - Table format\n* `REGX` - Regex processing\n* `GREP` - Grep command output"},"Field":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"name":{"type":"string","maxLength":50},"order":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64"},"retrieval_value":{"type":"string","nullable":true,"maxLength":255},"override_target":{"type":"boolean","nullable":true},"new_target":{"type":"string","nullable":true},"retrieval_method":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/FieldRetrievalMethodEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"retrieval_output":{"nullable":true,"oneOf":[{"$ref":"#/components/schemas/RetrievalOutputEnum"},{"$ref":"#/components/schemas/NullEnum"}]},"section":{"type":"integer"},"options":{"nullable":true}},"required":["id","name"]},"FieldRetrievalMethodEnum":{"enum":["FILE","BASH","PW","CMD"],"type":"string","description":"* `FILE` - Read file\n* `BASH` - Bash command\n* `PW` - Powershell command\n* `CMD` - Cmd command"},"NullEnum":{"enum":[null]}}}} ``` ## The Trigger object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"Trigger":{"type":"object","properties":{"trigger":{"type":"string"},"model_name":{"type":"string"},"action_targets":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"context_fields":{"type":"string","readOnly":true}},"required":["action_targets","context_fields","model_name","trigger"]}}}} ``` ## The TriggerEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"TriggerEnum":{"enum":["inventory_received","user_login","netdevice_received"],"type":"string","description":"* `inventory_received` - Inventory Received\n* `user_login` - User Login\n* `netdevice_received` - Netdevice Received"}}}} ``` ## The User object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"User":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"username":{"type":"string","description":"Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.","pattern":"^[\\w.@+-]+$","maxLength":150},"email":{"title":"Email address","oneOf":[{"type":"string","format":"email","maxLength":254},{"type":"string","maxLength":0}]},"first_name":{"type":"string","maxLength":150},"last_name":{"type":"string","maxLength":150},"password":{"type":"string","writeOnly":true,"maxLength":128},"is_superuser":{"type":"boolean","title":"Superuser status","description":"Designates that this user has all permissions without explicitly assigning them."},"groups":{"type":"array","items":{"type":"integer"},"description":"The groups this user belongs to. A user will get all permissions granted to each of their groups."},"group_assignments":{"type":"string","readOnly":true},"user_permissions":{"type":"array","items":{"type":"integer"},"description":"Specific permissions for this user."}},"required":["group_assignments","id","password","username"]}}}} ``` ## The VersionEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"VersionEnum":{"enum":["1","2c","3"],"type":"string","description":"* `1` - SNMPv1\n* `2c` - SNMPv2c\n* `3` - SNMPv3"}}}} ``` ## The VirtualCol object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"VirtualCol":{"type":"object","description":"This serialize class provide the API representation","properties":{"id":{"type":"integer","readOnly":true},"visibility":{"$ref":"#/components/schemas/VisibilityEnum"},"allow_group_modification":{"type":"boolean"},"name":{"type":"string","maxLength":100},"target":{"$ref":"#/components/schemas/TargetEnum"},"mapping":{},"last_updated":{"type":"string","format":"date-time","readOnly":true},"user":{"type":"integer","readOnly":true},"groups":{"type":"array","items":{"type":"integer"}}},"required":["id","last_updated","name","user"]},"VisibilityEnum":{"enum":["public","private_personal","private_group"],"type":"string","description":"* `public` - Public\n* `private_personal` - Private (Personal)\n* `private_group` - Private (Group)"},"TargetEnum":{"enum":["asset"],"type":"string","description":"* `asset` - Assets"}}}} ``` ## The VisibilityEnum object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"VisibilityEnum":{"enum":["public","private_personal","private_group"],"type":"string","description":"* `public` - Public\n* `private_personal` - Private (Personal)\n* `private_group` - Private (Group)"}}}} ``` ## The WindowsBuildMapping object ```json {"openapi":"3.0.3","info":{"title":"OCS Inventory Backend API References","version":"3.0.0"},"components":{"schemas":{"WindowsBuildMapping":{"type":"object","properties":{"id":{"type":"integer","readOnly":true},"build":{"type":"integer","maximum":9223372036854776000,"minimum":-9223372036854776000,"format":"int64","description":"Windows build number (e.g. 22621)"},"channel":{"type":"string","description":"endoflife.date channel slug (e.g. 22h2)","maxLength":20}},"required":["build","channel","id"]}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://documentation.ocsinventory-ng.org/open-api-reference/models.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.