Replace a client at a port

Replacing a client on a port is done by first swapping the client's port to occupy the desired port and then connecting the client to it. This is done as follows:

Example

Let’s assume that we already have the splitter ID.

Splitter ID: 5dc06d1275fc7d0006732525

Based on this data, we follow the process:

We search for the splitter information if we do not yet have the port data.

By applying a filter that matches the id with the splitter ID we already have, we can fetch the splitter port information. The call to OZmap would be made as follows:

curl --location -g --request GET 'https://synsuite.ozmap.com.br:9994/api/v2/splitters?filter=[{"property": "id","value":"5dc06d1275fc7d0006732525","operator":"eq"}]' \
--header 'Authorization: <API Key>' \

Below is the the filtered splitter information

{
            "isBalanced": true,
            "orientation": "right",
            "implanted": true,
            "isDrop": true,
            "kind": "Splitter",
            "parent": "5dc06d1275fc7d0006732521",
            "project": "5d51a87046cbe700148328bf",
            "name": "SS 22-05",
            "splitterType": "5d51727f46cbe700148327e2",
            "connectables": {
                "input": [
                    "5dc06d1275fc7d0006732524"
                ],
                "output": [
                    null,
                    "6307c1ff21648d00136bc1e8",
                    "637fb13856610e00133eafd4",
                    "6320c658e8c3730043d354d1",
                    "60e8b97394c65c0027a8d92d",
                    "6320c7e5e8c3730043d355c2",
                    null,
                    null
                ]
            },
            "ratio": {
                "output": 8,
                "input": 1
            },
            "id": "5dc06d1275fc7d0006732525"
        }

We disconnect the client using the port.

By passing as elementA the splitter and its ID, and elementB as the fiber ID going from the client to the splitter (present in the splitter's “output”), the call to OZmap would be made as follows (note that the route is /disconnect):

curl --location --request POST 'https://synsuite.ozmap.com.br:9994/api/v2/disconnect' \
--header 'Authorization: <API Key>' \
--data-raw '{
    "elementA": {
        "id": "5dc06d1275fc7d0006732525",
        "kind": "splitter"
    },
    "elementB": {
        "id": "6320c658e8c3730043d354d1",
        "kind": "fiber"
    }
}'

After that, we connect the client to another available port (described as “null” in the splitter's “output”).

By again passing as elementA the splitter and its ID, and elementB as the fiber of the initial client, the call would be made as follows (note that the route is now /connect):

After that, we just need to send the edit/create call to activate the client

In this example of property update, we use ‘force’ since the client's property was already connected to another splitter. The ‘connector’, in this case, is the desired splitter, and ‘box’ is the parent box of that splitter.