[Index]

API Reference for view/AddUccxAgentToTeam

This feature allows an admin to add a UCCX agent to a team.

Model ref.: view/AddUccxAgentToTeam

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

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

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

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

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "agent": {
               "required": true, 
               "type": "string", 
               "description": "Agent to be added to the team.", 
               "title": "Agent"
          }, 
          "team": {
               "required": true, 
               "type": "string", 
               "description": "The team the agent will be added to.", 
               "title": "Team"
          }
     }, 
     "schema_version": "1.0.0"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/view/AddUccxAgentToTeam/add/	hierarchy=[hierarchy] format=json	The GUI Add form of view/AddUccxAgentToTeam 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/AddUccxAgentToTeam	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 a compressed format of the Bulk Load spreadsheet template for view/AddUccxAgentToTeam	POST	/api/view/AddUccxAgentToTeam/export_bulkload_template/	hierarchy=[hierarchy] modeltype=view/AddUccxAgentToTeam	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Get the on-line Help for view/AddUccxAgentToTeam.	GET	/api/view/AddUccxAgentToTeam/help	hierarchy=[hierarchy]	On-line help of Model ref.: view/AddUccxAgentToTeam 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
Get	GET	/api/view/AddUccxAgentToTeam/[pkid]	hierarchy=[hierarchy]	The view/AddUccxAgentToTeam instance with [pkid].

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

API Reference for view/AddUccxAgentToTeam

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

Get the Add form

Create

Export Bulk Load Template

Help

Instance API Reference

Get

Help