[Index]

API Reference for relation/WebexSchedules

Webex Schedules

Model ref.: relation/WebexSchedules

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/WebexSchedules/add/
  • hierarchy=[hierarchy]
  • format=json
The GUI Add form of relation/WebexSchedules 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/WebexSchedules 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.
  • Bulk Delete

    Task Call URL Parameters Payload
    Bulk delete [pkid1],[pkid2]... DELETE /api/relation/WebexSchedules/ hierarchy=[hierarchy] {"hrefs":["/api/relation/WebexSchedules/[pkid1]", "/api/relation/WebexSchedules/[pkid2]", ...]}
    • For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: relation/WebexSchedules
      GET http://[host-proxy]/api/relation/WebexSchedules/?hierarchy=[hierarchy]&format=json

    Configuration Template

    Task Call URL Parameters Response
    Configuration Template GET /api/relation/WebexSchedules/configuration_template/ hierarchy=[hierarchy]
    • POST call to create the Configuration Template
    • Configuration Template schema

    • Use the returned properties to create the POST payload data for the .
    • For a description of the schema that shows properties to add to the POST payload:
      • The POST call is of the format:
      • POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

    List

    Task Call URL Parameters Response
    List GET /api/relation/WebexSchedules/
    • hierarchy=[hierarchy]
    • format=json
    • schema=true
    The relation/WebexSchedules schema and all instances as JSON.

    (The list will return 0 to 3 relation/WebexSchedules instances)

    (Show the first instance)

    Instance API Reference

    Modify

    Task Call URL Parameters Payload
    Modify PUT /api/relation/WebexSchedules/[pkid] hierarchy=[hierarchy] (For payload specification)

    For Bulk modification, refer to the Bulk Modify section.

    Delete

    Task Call URL Parameters Response
    Delete DELETE /api/relation/WebexSchedules/[pkid] hierarchy=[hierarchy]

    Clone

    Task Call URL Parameters Response
    Clone instance with [pkid]. The schema rules are applied. GET /api/relation/WebexSchedules/[pkid]/clone/?schema=&schema_rules=true
    • hierarchy=[hierarchy]
    A JSON payload with:
    • A POST action URL.
    • The unchanged model [pkid] payload to be modified to create a new instance.
    • For the instance pkids that can cloned, refer to the List GET call for relation/WebexSchedules
    • GET http://[host-proxy]/api/relation/WebexSchedules/?hierarchy=[hierarchy]&format=json
    • Use the POST action in the response with a modification of the response payload to create the clone.

    Tag

    Task Call URL Parameters Payload
    Tag PATCH /api/relation/WebexSchedules/[pkid]/+tag hierarchy=[hierarchy] If payload required:

    Get

    Task Call URL Parameters Response
    Get GET /api/relation/WebexSchedules/[pkid] hierarchy=[hierarchy] The relation/WebexSchedules instance with [pkid].