Overview

XML microservice are used to manage entities that expose a REST API that return a response formatted in XML or for Adapter that are not supporting JSON microservice and JsonPath.

To create a XML microservice, you need to check XML for the configuration type when creating a new microservice

do not try to change the configuration type of an existing microservice as this is not supported.

The functions Create, Update and Delete

Create and Update

These functions will call the REST API design to create or update the managed entity configuration.

For instance, the REST API to create a new tenant is

HTTP Request: /operator/{$prefix}

Method: POST

Parameter Name Type Description

name

String

the name of the tenant

Example:

POST /api/tenancy/tenants/

In case you need to pass in a JSON payload with the parameters, the microservice Create will look like this.

microservice console xml create 1

Delete

microservice console xml delete

Import

microservice console xml import

The main difference between the CLI and REST (Json/XML) Microservice definition is the implementation of the functions Create/Update/…​

CLI Microservice definition is covered in the documentation about the CLI microservice editor.

This documentation uses the Netbox REST adapter and the Netbox REST API to illustrate the design of XML Microservice.