API Reference for view/AudiocodeSBCINI

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/AudiocodeSBCINI/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "sbc": {
               "title": "Target SBC",
               "description": "Choice of SBC to manage",
               "type": "string"
          },
          "operation": {
               "title": "Operation",
               "description": "Field to choose operation to perform",
               "type": "string",
               "choices": [
                    {
                         "value": "backup",
                         "title": "Backup"
                    },
                    {
                         "value": "push",
                         "title": "Push & Activate"
                    }
               ]
          },
          "note": {
               "title": "Note",
               "description": "note entry for friendly lookup",
               "type": "string"
          },
          "configData": {
               "title": "Configuration Data",
               "description": "Ensure you select the correct Configuration Data backup file, choosing the incorrect file will result in data loss and potentially impact call flow on the selected SBC",
               "type": "string"
          }
     }
}

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

API Reference for view/AudiocodeSBCINI

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

Get the Add form

Create

Instance API Reference