Confiável pelas melhores organizações do mundo
Este documento descreve as diferenças entre a API V3 descontinuada e a nova API V3 para o módulo de Ativos. A nova API V3 está disponível para clientes que atualizaram para o build15100do ServiceDesk Plus ou7700do AssetExplorer, e apresenta uma abordagem mais robusta e padronizada para o gerenciamento de ativos.
Recomendamos a migração para a nova API V3 para todas as novas integrações e aplicações.
Nota:
O suporte para a API V3 mais antiga será fornecido até abril de 2026.
Todas as operações CRUD são suportadas nas APIs. No entanto, apenas os campos adicionais antigos de ativos e estações de trabalho, juntamente com atributos de CI criados antes da migração, serão buscados nas APIs antigas.
APIs Temporariamente Suportadas | APIs Não Suportadas |
|
|
Conteúdo:
A API de ativos foi renomeada para asset_assets.
A API asset_assets não suporta a operação de Adicionar Ativo.
Anteriormente, uma API comum era usada para tipos de produto. Agora, há uma API separada para cada tipo de produto.
A API para o tipo de produto Ponto de Acesso é fornecida abaixo:
| Formato Antigo | Novo Formato |
URL | /api/v3/assets | api/v3/asset_access_points |
Dados de Entrada | { "asset": { "name": "asset-auto-lab1", "product": { "name": "HP LaserJet M1005" }, "barcode": "YD-KKE-KDKKD", "asset_tag": "393939KDEK", "acquisition_date": { "value": "1588617009000" }, "purchase_cost": "1000.00", "expiry_date": { "value": "1588617940000" }, "warranty_expiry": { "value": "1588617200800" }, "state": { "name": "In Store" } } } | { "asset_access_point": { "name": "Access Point Asset 1", "product": { "id": "1201", "name": "Access Point Product 1" }, "asset_tag": "Asset Tag 123", "vendor": { "id": "301", "name": "Vendor 1" }, "barcode": "Access Point Asset 1", "state": { "id": "1", "name": "In Store" }, "retain_user_site": true, "is_loanable": false, "purchase_cost": "2000.00" } } |
Para requisições GET, forneça os dados de entrada (input_data) na seção de Parâmetros GET e codifique-os antes de enviar a requisição.
The older assets API in the released version fetches all access points as mentioned in "filter_by": { "id": 9 }
A nova API asset_assets busca todos os ativos, incluindo tipos de produto personalizados e componentes.
To fetch assets under a specific product type, you can either use API specific to the product type API (e.g., api/v3/asset_access_points), or use the search_criteria field with module.id instead of product_type.id.
Using the API specific to the product type will list all the assets including the assets of child product types. Whereas using search criteria lists only the assets of that particular module.
A API asset_assets não busca campos específicos de tipos de produto, como subformulários e UDFs. Apenas os campos básicos (campos incluídos para o tipo de produto Ativo) são retornados.
| Formato Antigo | Novo Formato |
URL | api/v3/assets | api/v3/asset_assets |
Dados de Entrada | { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": { "condition": "is", "field": "product_type.id", "value": "9" }, "sort_field": "name", "sort_order": "asc", "filter_by": { "id": 9 }, "fields_required": [ "name", "product_type", "product", "state", "user", "department", "org_serial_number", "purchase_cost", "vendor", "is_loaned", "loan_end", "ci", "last_success_audit" ] } } | { "list_info": { "sort_field": "name", "sort_order": "asc", "row_count": "25", "search_criteria": { "condition": "is", "field": "module.id", "value": "70" }, "fields_required": [ "name", "module", "product", "primary_ip", "state", "barcode", "user", "department", "used_by_asset", "site", "purchase_cost", "vendor", "loan_end" ] } } |
Use a API específica para o tipo de produto para obter o metainfo.
Campos adicionais criados em Administração > Personalização > Campos Adicionais > Ativo devem ser associados a um layout de tipo de produto para aparecer no metainfo.
O ID do template (ID do tipo de produto) não é necessário nos dados de entrada.
| Formato Antigo | Novo Formato |
URL | api/v3/assets/metainfo | api/v3/asset_servers/_metainfo |
Dados de Entrada | { "template": { "id": "{product_type_id}" } } |
- |
A API de estações de trabalho foi renomeada para asset_computers.
O campo is_server está descontinuado. Use a API asset_servers para buscar detalhes.
Certos nomes de campos no subformulário de Processadores foram alterados.
model → cpu_model
serial_number → cpu_serial_number
O formato de entrada do campo de velocidade do processador agora é um número em vez de uma string.
Campos de memória (tanto campos individuais quanto os presentes em subformulários), como free_space, capacity, virtual_memory, total_memory etc., agora exigem entrada no formato de um valor e uma unidade (ex.: 8GB).
Em network_adapters, o campo dhcp (string) é substituído por is_dhcp (booleano). Da mesma forma, em printer_details, o campo is_default é alterado de string para booleano.
Grupos como sound_card e keyboard agora são subformulários e permitem múltiplas entradas.
Todos os grupos (ex.: memory, operating_system, computer_system, etc.) foram removidos. Seus campos agora são campos individuais. Por exemplo,
operating_system.os → os_name
computer_system.service_tag → service_tag
Os campos computer_system.system_manufacturer e computer_system.model foram removidos, pois são os mesmos que os campos manufacturer e product.
As alterações acima, juntamente com exemplos, estão destacadas abaixo.
| Formato Antigo | Novo Formato |
URL | /api/v3/workstations/{asset_id} | /api/v3/asset_computers/{asset_id} |
Dados de Entrada | { "workstation": { "is_server": true, "processors": [ { "number_of_cores": "1", "name": "Intel(R) Xeon(R) CPU E5-2640 v3 @ 2.80GHz", "cpu_manufacturer": "Intel(R) Xeon(R) CPU E5-2640 v3 @ 2.60GHz", "model": "2", "serial_number": "LJLJ", "cpu_stepping": "55", "family": "F", "core_count": "8", "speed": "2600.00", "manufacturer": "GenuineIntel" }], "logical_drives": [ { "drive_type": "Local Disk", "file_system": "NTFS", "name": "C:", "serial_number": "B67EC8845", "free_space": "476233871360", "capacity": "536276365312" }], "network_adapters": [ { "ipnet_mask": "255.255.225.0", "mac_address": "00:0C:29:51:C8:5C", "name": "Intel(R) 82574L Gigabit Network Connection", "description": "Intel(R) 82574L Gigabit Network Connection", "dhcp_server": "193.168.100.20", "nic_lease": "DF", "ip_address": "172.24.146.246", "gateway": "172.24.128.1", "dhcp": "true", "network": "172.24.128.0" }], "memory": { "virtual_memory": "39458934784", "physical_memory": "34358661120" }, "printer_details": [ { "server": "sdpp-printers-serverr", "name": "Microsoft Print to PDF", "model": "Microsoft Print To PDF", "location": "12th Floor", "type": "Local", "is_default": "True" } ], "sound_card": { "sound_card_name": "Alphs Sound Card234" }, "operating_system": { "os": "Microsoft Windows Server 2016 Standard", "service_pack": "0", "product_id": "00377-70321-39146-AA856", "build_number": "14393", "version": "10.0.14393" }, "keyboard": { "keyboard_manufacturer": "Samsung", "keyboard_serial_number": "JJHJKDH98989", "keyboard_type": "Enhanced (101- or 102-key)" }, "hard_disks": [ { "model": "VMware Virtual disk SCSI Disk Device", "serial_number": "6000c298fcde8ed0b55dd9aada6591f1a", "free_space": "0", "capacity": "536864025600", "manufacturer": "(Standard disk drives)" } ], "computer_system": { "system_manufacturer": "Microsoft", "service_tag": "b1 c9 83 15-4a 4a 7c cb 9b 51 c8 5c", "model": "VMware17,1", "bios_version": "INTEL- 6040000" }, "memory_modules": [ { "module_tag": "Physical Memory 0", "bank_label": "RAM slot 0", "memory_type": "DRAM", "socket": "RAM slot 0", "capacity": "17179869184", "frequency": null } ] } }
| { "asset_computer": { "processors": [ { "cpu_model": 43, "number_of_cores": 63, "name": "Processor Y2 80", "cpu_manufacturer": "Intel", "cpu_serial_number": "LK1L0X06-RH0L0C98-YG9G9Y25", "cpu_stepping": 5, "family": "Q", "core_count": 91, "speed": 3.53, "manufacturer": "Samsung" }], "logical_drives": [ { "drive_type": "PATA", "file_system": "NTFS", "drive_serial_number": "AZ9X7Q72-HY8V4B93-UF9I3W99", "name": "Logical Drive R1 54", "drive_capacity": { "value": 95, "unit": "TB" }, "free_space": { "value": 24, "unit": "TB" } }], "network_adapters": [ { "ipnet_mask": "163.38.56.102", "is_dhcp": false, "mac_address": "81:f0:99:8f:b3:5e", "name": "Network Adapter J0 35", "description": "Added via API (Data population tool)", "dhcp_server": "177.140.220.42", "nic_lease": "32.146.175.177", "ip_address": "207.126.22.229", "gateway": "198.204.98.163", "network": "217.251.159.6" }], "virtual_memory": { "value": 110, "unit": "TB" }, "physical_memory": { "value": 114, "unit": "TB" }, "printer_details": [ { "server": "SDP-D23-Asset", "name": "Printer Detail G2 43", "location": "Rack-90", "model": 38, "is_default": true, "type": "3D Printer" }], "sound_cards": [ { "name": "Sound Card Y0 10", "manufacturer": "Toshiba" }, { "name": "Sound Card L0 77", "manufacturer": "Intel" } ], "product_id": "YU3E4B08-YK3J1N52-MA2R4T58", "service_pack": "DM SP6", "os_version": "7.7.49", "build_number": "5.6.78 Build 2", "os_name": "Debian 2019 Version", "keyboards": [ { "serial_number": "AK2T3J47-XI5I5E14-AC6Z2Q88", "type": "Mechanical Keyboard", "manufacturer": "Microsoft" }, { "serial_number": "MI3Y0V45-UN4Q8Y08-KM9N6Q75", "type": "Ergonomic Keyboard", "manufacturer": "Intel" } ], "hard_disks": [ { "disk_manufacturer": "HP", "disk_model": 77, "disk_serial_number": "ML0R2T52-JY1G1C75-MG8D2Y10", "disk_type": "CD-ROM Drive", "disk_capacity": { "value": 97, "unit": "TB" }, "free_space": { "value": 21, "unit": "TB" } } ], "bios_name": "test", "bios_version": "8.8.27", "service_tag": "WJ4X409N2", "bios_date": "2024-02-28 16:29:41", "sm_bios_version": "2.2.82", "memory_modules": [ { "module_tag": "EZ7M453B5", "bank_label": "different", "memory_type": "MRAM", "socket": 79, "memory_capacity": { "value": 85, "unit": "TB" }, "frequency": "3100" } ] } }
|
| Formato Antigo | Novo Formato |
URL | /api/v3/workstations | /api/v3/asset_workstations |
Dados de Entrada | { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": { "field": "operating_system.os", "value": "windows", "condition": "contains", "logical_operator": "AND" }, "sort_field": "name", "sort_order": "asc", "filter_by": { "id": 1 }, "fields_required": [ "agentstatus", "name", "product_type", "computer_system.model", "operating_system.os", "ip_addresses", "computer_system.service_tag", "state", "user", "department", "org_serial_number", "purchase_cost", "vendor", "icon", "ci", "operating_system.os", "last_success_audit" ] } }
| { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": { "field": "os_name", "value": "windows", "condition": "contains", "logical_operator": "AND" }, "sort_field": "name", "sort_order": "asc", "fields_required": [ "name", "module", "product", "vm_host", "os_name", "primary_ip", "service_tag", "state", "barcode", "user", "department", "used_by_asset", "site", "purchase_cost", "vendor", "loan_end", "os_name", "module" ] } }
|
Todos os campos adicionais de um tipo de produto e seus pais estão listados em uma única chave: udf_fields.
Os atributos de CI não são mais suportados. Apenas campos adicionais de tipos de produto podem ser atualizados.
| Formato Antigo | Novo Formato |
URL | /api/v3/workstations/{asset_id} | /api/v3/asset_computers/{asset_id} |
Dados de Entrada | { "workstation": { "ci_server_fields": { "udf_sline_165": null, "udf_pick_166": null }, "workstation_udf_fields": { "udf_sline_33": "20", "udf_date_36": { "display_value": "Jul 28, 2024 12:37 AM", "value": "1722107260000" }, "udf_mline_34": "Jeniffer", "udf_sline_32": "Sample text updated", "udf_long_35": "20" }, "udf_fields": { "udf_sline_27": "zylker Corp", "udf_mline_28": "Sample multi line data", "udf_date_31": { "display_value": "May 13, 2021 02:51 PM", "value": "1620897660000" }, "udf_pick_29": "HR", "udf_long_30": "39393" }, "ci_default_fields": { "udf_pickref_1": null }, "ci_windowsserver_fields": {} } }
| { "asset_computer": { "udf_fields":{ "udf_asset_sline1":"asset field", "udf_ap_sline_1":"Computer udf field" } } }
|
O campo is_server não é mais usado para buscar estações de trabalho ou servidores.
Use as APIs asset_workstations e asset_servers para buscar dados de estações de trabalho ou servidores.
| Formato Antigo | Novo Formato |
URL | /api/v3/workstations | /api/v3/asset_servers |
Dados de Entrada | { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": { "field": "is_server", "condition": "is", "value": "true", "logical_operator": "AND" }, "sort_field": "name", "sort_order": "asc", "fields_required": [ "name", "product_type", "computer_system.model" ] } }
| { "list_info": { "row_count": "25", "start_index": 1, "sort_field": "name", "sort_order": "asc", "fields_required": [ "name", "module", "product" ] } }
|
Os atributos de CI não são suportados na nova API V3.
Apenas campos adicionais associados a um tipo de produto são suportados para operações de pesquisa, obtenção e atualização.
Os atributos de CI existentes serão convertidos em campos adicionais e mapeados para os tipos de produto respectivos.
Atributos do CI de elemento base (Atributos Padrão) → Campos adicionais no tipo de produto Ativo
Atributos de CIs de Estação de Trabalho → Campos adicionais no tipo de produto Estação de Trabalho
Atributos de CI de Servidor → Campos adicionais no tipo de produto Servidor
Campos Adicionais de Ativo → Campos adicionais no tipo de produto Ativo
Campos Adicionais de Estação de Trabalho → Campos adicionais no tipo de produto Computador.
| Formato Antigo | Novo Formato |
URL | /api/v3/assets | /api/v3/asset_servers |
Dados de Entrada | { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": { "field": "ci.id", "condition": "is", "value": "124", "logical_operator": "AND" }, "fields_required": [ "name", "product_type", "computer_system.model", "ci_default_fields.udf_pickref_171" ], "ci_attributes": { "ci_default_fields.udf_pickref_171": "aa" } } }
| { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": { "field": "udf_fields.udf_asset_sline1", "value": "aa", "condition": "contains", "logical_operator": "AND" }, "fields_required": [ "name", "module", "product", "udf_fields.udf_asset_sline1" ] } }
|
Nem todos os ativos são CIs, e um ativo não pode ser pesquisado usando um ID de CI. No entanto, se um ativo estiver vinculado a um CI, ele pode ser pesquisado usando o campo linked_instance.
| Formato Antigo | Novo Formato |
URL | /api/v3/assets | /api/v3/asset_servers |
Dados de Entrada | { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": { "field": "ci.id", "condition": "is", "value": "301", "logical_operator": "AND" }, "fields_required": [ "name", "product_type", "computer_system.model" ] } }
{"list_info":{"search_fields":{"ci.id":"301"},"fields_required":"[id,name,ci_default_field | { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": { "field": "linked_instance.id", "value": "1", "condition": "is", "logical_operator": "AND" }, "fields_required": [ "name", "module", "product" ] } }
|
Não existe uma API separada para hosts virtuais.
Use o campo vm_platform para buscar hosts virtuais.
| Formato Antigo | Novo Formato |
URL | /api/v3/virtual_hosts | /api/v3/asset_computers |
Dados de Entrada | { "list_info": { "sort_field": "name", "sort_order": "asc", "row_count": "25", "fields_required": [ "agentstatus", "name", "computer_system.model", "operating_system.os", "installed_vms", "logical_cpu_count", "memory.physical_memory", "purchase_cost", "icon", "ci", "operating_system.os", "last_success_audit" ] } }
| { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": { "field": "vm_platform", "value": null, "condition": "is not", "logical_operator": "AND" }, "fields_required": [ "name", "module", "vm_platform", "product" ] } }
|
Não existe uma API separada para máquinas virtuais.
Use o campo vm_host para buscar máquinas virtuais.
As máquinas virtuais só podem ser buscadas fornecendo os detalhes do host.
| Formato Antigo | Novo Formato |
URL | /api/v3/virtual_machines | /api/v3/asset_computers |
Dados de Entrada | { "list_info": { "sort_field": "name", "sort_order": "asc", "row_count": "25", "fields_required": [ "agentstatus", "name", "computer_system.model", "operating_system.os", "installed_vms", "logical_cpu_count", "memory.physical_memory", "purchase_cost", "icon", "ci", "operating_system.os", "last_success_audit" ] } }
| { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": { "field": "vm_host", "condition": "is not", "value": null, "logical_operator": "and" }, "fields_required": [ "name", "module", "product" ] } }
|
Use o campo vm_host para recuperar máquinas virtuais associadas a um host.
| Formato Antigo | Novo Formato |
URL | /api/v3/virtual_machines | /api/v3/asset_computers |
Dados de Entrada | { "list_info": { "sort_field": "name", "sort_order": "asc", "row_count": "25", "search_criteria": { "field": "vm_host.id", "condition": "is", "value": "3", "logical_operator": "AND" } } }
| { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": { "field": "vm_host.id", "condition": "is", "value": "3", "logical_operator": "AND" }, "fields_required": [ "name", "module", "product" ] } }
|
| Formato Antigo | Novo Formato |
URL | /api/v3/workstations/{asset_id}/software | /api/v3/asset_computers/{asset_id}/softwares |
Dados de Entrada | { "list_info": { "sort_order": "desc", "row_count": "25", "fields_required": [ "software", "version", "software_type", "software_category", "product_key", "installed_on", "software_usage" ] } }
| { "list_info": { "sort_order": "desc", "row_count": "25", "fields_required": [ "software.name", "version", "software.type", "software.category", "product_key", "installed_on", "usage" ] } }
|
A API de estações de trabalho foi renomeada para asset_workstations.
| Formato Antigo | Novo Formato |
URL | /api/v3/workstations | /api/v3/asset_workstations |
Dados de Entrada | { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": { "field": "is_server", "condition": "is", "value": "false", "children": "[{\"field\": \"network_adapters.ip_address\", \"values\": [\"2\"], \"condition\": \"contains\", \"logical_operator\": \"and\"}]" }, "fields_required": [ "name", "product_type", "computer_system.model" ] } }
| { "list_info": { "row_count": 25, "start_index": 1, "search_criteria": { "field": "network_adapters.ip_address", "values": ["2"], "condition": "contains", "logical_operator": "and" }, "fields_required": [ "product", "service_tag", "name", "module" ] } }
|
A API de ativos foi renomeada para asset_assets.
| Formato Antigo | Novo Formato |
URL | /api/v3/assets | /api/v3/asset_assets |
Dados de Entrada | { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": {"field":"ip_addresses","values":"[\"2\"]","condition":"contains","logical_operator":"and"}, "fields_required": [ "name", "product_type", "computer_system.model" ] } }
| { "list_info": { "row_count": 25, "start_index": 1, "search_criteria": { "field": "ip_addresses", "values": ["2"], "condition": "contains", "logical_operator": "and" }, "fields_required": [ "product", "service_tag", "name", "module" ] } }
|
A operação de adição de custos é suportada na API asset_assets.
O ID do fator de custo pode ser obtido usando a API api/v3/asset_assets/{asset_id}/costs/cost_factor.
A chave asset_cost foi alterada para asset_sub_cost.
| Formato Antigo | Novo Formato |
URL | /api/v3/assets/{asset_id}/costs | /api/v3/asset_firewalls/{asset_id}/costs |
Dados de Entrada | { "asset_cost": { "date": { "value": "1746037800000" }, "cost_factor": { "id": "3" }, "amount": "123", "description": "" } }
| { "asset_sub_cost": { "date": { "value": "1746469800000" }, "cost_factor": { "id": "3" }, "amount": "1234", "description": "" } }
|
Anteriormente, a chave filter_by era usada para buscar ativos no estado descartado. Agora, use a chave asset_filter_by com o valor disposed_assets para buscar ativos no estado Descartado.
| Formato Antigo | Novo Formato |
URL | /api/v3/assets | /api/v3/asset_assets |
Dados de Entrada | { "list_info": { "row_count": "25", "start_index": 1, "filter_by": { "id": 5, "name": "disposed" }, "fields_required": [ "name", "product_type", "computer_system.model" ] } } | { "list_info": { "row_count": "25", "start_index": 1, "asset_filter_by": { "name": "disposed_assets" }, "fields_required": [ "name", "module", "product" ] } }
|
| Formato Antigo | Novo Formato |
URL | /api/v3/assets/{asset_id}/upload | /api/v3/asset_assets/{asset_id}/_upload |
Dados de Entrada | input_file
| input_file
|
Obtenha a lista de todos os anexos de um ativo usando a seguinte URL da API:
| Formato Antigo | Novo Formato |
URL | /api/v3/assets/{asset_id}/attachments | /api/v3/asset_assets/{asset_id}/attachments |
Baixe anexos de um ativo usando a seguinte URL da API:
| Formato Antigo | Novo Formato |
URL | /api/v3/assets/{asset_id}/attachments/{attachment_id}/_download | /api/v3/asset_assets/{assetId}/attachments/{attachment_id}/_download |
Todas as chaves de operações de conveniência (ex.: metainfo, copy, etc.) devem ser prefixadas com sublinhado (_) na URL (ou seja, api/v3/asset_servers/_metainfo e api/v3/asset_servers/_copy).
A API para configurar depreciação não é mais suportada. A depreciação agora deve ser configurada para um ativo usando uma operação de atualização.
| Formato Antigo | Novo Formato |
URL | POST - api/v3/assets/{asset_id}/_configure_depreciation | PUT - api/v3/asset_access_points/{asset_id} |
Dados de Entrada | { "config": { "depreciation": { "salvage_value": "10", "depreciation_percent": null, "useful_life": "24", "depreciation_type": { "name": "Straight Line", "id": "1" } }, "type": "asset", "purchase_cost": "390.00", "acquisition_date": { "value": 1620153000000 } } } | { "asset_access_point": { "is_asset_depreciation": true, "depreciation_detail": { "salvage_value": "300", "useful_life": "23", "depreciation_type": { "name": "Declining Balance", "id": "2" } }, "purchase_cost": "2500", "acquisition_date": { "value": 1746037800000 } } } |
A API de atualização em massa permite atualizar os campos de vários ativos com valores diferentes.
Use asset_id nos dados de entrada para atualizar ativos.
Apenas os campos básicos (campos disponíveis para o tipo de produto Ativo) podem ser atualizados usando a API asset_assets. Para atualizar campos adicionais e outros campos específicos de tipo de produto, use a API do tipo de produto correspondente.
| Formato Antigo | Novo Formato |
URL | /api/v3/assets?ids={id1,id2,id3} | /api/v3/asset_assets?ids={id1,id2,id3} |
Dados de Entrada | { "assets": [ { "asset_tag": "TAG2125w", "org_serial_number": "JASKL-KJSKJ-PIJSNJ5", "id": "5" }, { "asset_tag": "TAG2126w", "org_serial_number": "JASKL-KJSKJ-PIJSNJ6", "id": "6" }, { "asset_tag": "TAG2127w", "org_serial_number": "JASKL-KJSKJ-PIJSNJ7", "id": "7" } ] } | { "asset_assets": [ { "asset_tag": "TAG2125", "org_serial_number": "JASKL-KJSKJ-PIJSNJ5", "id": "5" }, { "asset_tag": "TAG2126", "org_serial_number": "JASKL-KJSKJ-PIJSNJ6", "id": "6" }, { "asset_tag": "TAG2127", "org_serial_number": "JASKL-KJSKJ-PIJSNJ7", "id": "7" } ] } |
Como os grupos foram removidos, computer_system.service_tag agora é service_tag .
| Formato Antigo | Novo Formato |
URL | /api/v3/workstations | /api/v3/asset_workstations |
Dados de Entrada | { "list_info": { "row_count": 100, "start_index": 1, "search_criteria": { "field": "org_serial_number", "condition": "=", "value": null, "children": [ { "field": "computer_system.service_tag", "condition": "!=", "value": null, "logical_operator": "and" } ] } } } | { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": { "condition": "is", "field": "org_serial_number", "logical_operator": "and", "value": null, "children": [ { "condition": "is not", "field": "service_tag", "logical_operator": "and", "value": null }] } } }
|
| Formato Antigo | Novo Formato |
URL | /api/v3/assets | /api/v3/asset_assets |
Dados de Entrada | { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": { "field": "user", "values": "[{\"id\": \"3\", \"name\": \"administrator\"}]", "condition": "is", "logical_operator": "and" }, "filter_by": { "id": 9 } } } | { "list_info": { "row_count": 25, "start_index": 1, "search_criteria": { "field": "user", "values": [ { "id": "5", "name": "administrator" } ], "condition": "is", "logical_operator": "and" } } }
|
Use o campo user name nos search_criteria para recuperar ativos associados a um usuário.
| Formato Antigo | Novo Formato |
URL | /api/v3/assets | /api/v3/asset_assets |
Dados de Entrada | { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": { "field": "user.name", "values": "[\"admin\"]", "condition": "is", "logical_operator": "and" }, "sort_field": "name", "sort_order": "asc", "filter_by": { "id": 9 } } } | { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": { "field": "user.name", "value": "admin", "condition": "is", "logical_operator": "and" }, "sort_field": "name", "sort_order": "asc" } }
|
| Formato Antigo | Novo Formato |
URL | /api/v3/assets | /api/v3/asset_assets |
Dados de Entrada | { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": { "field": "state.name", "values": "[\"In Store\"]", "condition": "is", "logical_operator": "and" }, "sort_field": "name", "sort_order": "asc", "filter_by": { "id": 9 } } } | { "list_info": { "row_count": "25", "start_index": 1, "search_criteria": { "field": "state.name", "value": "In Store", "condition": "is", "logical_operator": "and" }, "sort_field": "name", "sort_order": "asc" } }
|
Os ativos descartados normalmente não são acessíveis ao buscar ativos, mas a chave filter_by pode ser usada para recuperar todos os ativos independentemente do estado.
Para obter ativos descartados, use a chave asset_filter_by com o valor all_states para recuperar todos os ativos, incluindo aqueles no estado Descartado.
| Formato Antigo | Novo Formato |
URL | /api/v3/assets | /api/v3/asset_assets |
Dados de Entrada | { "list_info": { "row_count": "25", "start_index": 1, "filter_by":{ "id":9, "name":"all_states" }, "fields_required": [ "name", "product_type", "computer_system.model" ] } } | { "list_info": { "row_count": "25", "start_index": 1, "asset_filter_by": { "name": "all_states" }, "fields_required": [ "name", "module", "product" ] } }
|
| Formato Antigo | Novo Formato |
URL | /api/v3/requests/assets | /api/v3/requests/assets |
Dados de Entrada | { "list_info": { "row_count": 100, "start_index": 1, "sort_field": "id", "sort_order": "asc", "search_criteria": [ { "field": "product.id", "condition": "is", "value": "{product_id}", "logical_operator": "and" }, { "field": "state.id", "condition": "is", "value": "{in_store_state_id}", "logical_operator": "AND" } ], "get_total_count": true } } | { "list_info": { "row_count": 100, "start_index": 1, "sort_field": "id", "sort_order": "asc", "search_criteria": [ { "field": "product.id", "condition": "is", "value": "{product_id}", "logical_operator": "and" }, { "field": "state.id", "condition": "is", "value": "{in_store_state_id}", "logical_operator": "AND" } ], "get_total_count": true } } |
| Formato Antigo | Novo Formato |
URL | /api/v3/requests/assets/product_type | /api/v3/requests/assets/module |
Dados de Entrada | { "list_info": { "row_count": 100, "start_index": 1, "sort_field": "id", "sort_order": "asc", "get_total_count": true } } | { "list_info": { "row_count": 100, "start_index": 1, "sort_field": "id", "sort_order": "asc", "get_total_count": true } } |
| { "product_type": [ { "name": "Access Point", "internal_name": "Access Point", "id": "9", "is_default": true, "icon_name": { "content-url": "/api/v3/requests/assets/product_type/9/images/1509", "id": "1509" } } ], "response_status": { "status_code": 2000, "status": "success" }, "image_token": "dbf295caeb3bc697f73f", "list_info": { "has_more_rows": true, "start_index": 1, "sort_field": "id", "page": 1, "sort_order": "asc", "row_count": 10 } } | { "response_status": { "status_code": 2000, "status": "success" }, "module": [ { "parent": { "api_plural_name": "asset_assets", "name": "asset_asset", "id": "68", "display_name": "Asset", "display_plural_name": "Assets" }, "api_plural_name": "asset_access_points", "icon": { "content-url": "/api/v3/asset_modules/79/images/32", "id": "32" }, "is_deletable": true, "display_name": "Access Point", "display_plural_name": "Access Points", "asset_category": { "name": "IT", "id": "2" }, "internal_name": "Access Point", "inactive": false, "api_name": "asset_access_point", "name": "asset_access_point", "asset_type": { "name": "Asset", "id": "1" }, "id": "79", "is_child_allowed": true, "category": { "name": "asset", "id": "12", "display_name": "Asset" } } ], "image_token": "6b2ea7b6b64770f895dde1216d9", "list_info": { "has_more_rows": true, "sort_field": "id", "start_index": 1, "sort_order": "asc", "row_count": 10 } } |