[Index]

API Reference for relation/WebExClient

WebEx User add/mod/del relation.

Model ref.: relation/WebExClient

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

Get the Add form

Task Call URL Parameters Response
Get the GUI Add form. GET /api/relation/WebExClient/add/
  • hierarchy=[hierarchy]
  • format=json
The GUI Add form of relation/WebExClient as JSON

The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.

Create

Task Call URL Parameters Payload
Create POST /api/relation/WebExClient hierarchy=[hierarchy]
(For payload specification)

  • Response is a transaction pkid for the create action.
  • Use the GET call to
    tool/Transaction/[trans pkid]
    to inspect the created resource and its instance pkid.
  • Instance API Reference

    Add Cucm User

    Task Call URL Parameters Payload
    Add Cucm User POST /api/relation/WebExClient/[pkid]/+AddCUCMUser hierarchy=[hierarchy] If payload required:

    Add Ldap User

    Task Call URL Parameters Payload
    Add Ldap User POST /api/relation/WebExClient/[pkid]/+AddLDAPUser hierarchy=[hierarchy] If payload required:

    Add Sso User

    Task Call URL Parameters Payload
    Add Sso User POST /api/relation/WebExClient/[pkid]/+AddSSOUser hierarchy=[hierarchy] If payload required:

    Add Web Ex User

    Task Call URL Parameters Payload
    Add Web Ex User POST /api/relation/WebExClient/[pkid]/+AddWebExUser hierarchy=[hierarchy] If payload required:

    Del Cucm User

    Task Call URL Parameters Payload
    Del Cucm User POST /api/relation/WebExClient/[pkid]/+DelCUCMUser hierarchy=[hierarchy] If payload required:

    Del Ldap User

    Task Call URL Parameters Payload
    Del Ldap User POST /api/relation/WebExClient/[pkid]/+DelLDAPUser hierarchy=[hierarchy] If payload required:

    Del Sso User

    Task Call URL Parameters Payload
    Del Sso User POST /api/relation/WebExClient/[pkid]/+DelSSOUser hierarchy=[hierarchy] If payload required:

    Del Web Ex User

    Task Call URL Parameters Payload
    Del Web Ex User POST /api/relation/WebExClient/[pkid]/+DelWebExUser hierarchy=[hierarchy] If payload required: