API Reference for view/BulkScheduleTool

A tool to change all active schedules to inactive for events like upgrades and put them back after the fact.

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

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.

as UUID. For example: 6t0ggef2c0deab00hb595101
in dot notation. E.g. ProviderName.CustomerName.LocationName

[pkid] is the ID of the resource instance. Refer to the List reference below.

[filename] refers to a file

GET http://[host-proxy]/api/view/BulkScheduleTool/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "action": {
               "choices": [
                    {
                         "value": "deactivate",
                         "title": "Catalog and Deactivate Schedules"
                    },
                    {
                         "value": "activate",
                         "title": "Activate Deactivated Catalog"
                    }
               ],
               "type": "string",
               "title": "Choose Action"
          },
          "new_catalog_name": {
               "type": "string",
               "title": "New Catalog Name"
          },
          "restore_catalog_name": {
               "type": "string",
               "title": "Restore Catalog Name"
          }
     },
     "schema_version": "0.1"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/view/BulkScheduleTool/add/	hierarchy=[hierarchy] format=json	The GUI Add form of view/BulkScheduleTool 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.

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

Response is a transaction pkid for the create action.

The GET call to

tool/Transaction/[trans pkid]

shows the View resource has no instance pkid, because a view model stores no instances.

Task	Call	URL	Parameters	Response
Get the on-line Help for view/BulkScheduleTool.	GET	/api/view/BulkScheduleTool/help	hierarchy=[hierarchy]	On-line help of Model ref.: view/BulkScheduleTool as HTML

Instance API Reference

[pkid] is the ID of the resource instance.

If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Response
Help	GET	/api/view/BulkScheduleTool/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for view/BulkScheduleTool.

API Reference for view/BulkScheduleTool

GET http://[host-proxy]/api/view/BulkScheduleTool/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Help

Instance API Reference

Help