Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing Feature to changelog for API 1.16 and add method #445

Open
2 tasks
MichaelOv opened this issue Mar 12, 2024 · 0 comments
Open
2 tasks

Add missing Feature to changelog for API 1.16 and add method #445

MichaelOv opened this issue Mar 12, 2024 · 0 comments
Labels
API documentation Improvements or additions to documentation

Comments

@MichaelOv
Copy link
Member

MichaelOv commented Mar 12, 2024

  • Add "Get a connection endpoint of a cable via API" to changelog
  • Add method examples

This endpoint can be called with cmdb.cabling.read and retrieves the information which connector is connected of a cable object.

Call Example:

{
    "jsonrpc": "2.0",
    "method": "cmdb.cabling.read",
    "id": 1,
    "params": {
        "objID": 2821,
        "apikey": [{api-key}]
    }
}

Response Example:

{
    "id": 1,
    "jsonrpc": "2.0",
    "result": {
        "start": {
            "presentation": "server11 > server_output11",
            "connector": {
                "id": 2,
                "title": "server_output11",
                "type": "C__CATG__CONNECTOR",
                "inOutput": "Output"
            },
            "ciObject": {
                "id": 162,
                "title": "server11",
                "type": "Server",
                "typeConstant": "C__OBJTYPE__SERVER"
            }
        },
        "end": {
            "presentation": "switch_classic > input_switch11",
            "connector": {
                "id": 3,
                "title": "input_switch11",
                "type": "C__CATG__CONNECTOR",
                "inOutput": "Input"
            },
            "ciObject": {
                "id": 172,
                "title": "switch_classic",
                "type": "Switch",
                "typeConstant": "C__OBJTYPE__SWITCH"
            }
        }
    }
}
@MichaelOv MichaelOv added documentation Improvements or additions to documentation API labels Mar 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant