[Index]

API Reference for relation/GS_SME_Event_REL

Rel over event data model. Calls workflow to manage events

Model ref.: relation/GS_SME_Event_REL

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

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "customer": {
               "title": "Customer",
               "type": "string"
          },
          "customerUsesSlc": {
               "title": "SLC Based Dialplan",
               "type": "boolean"
          },
          "smeArray": {
               "title": "SME List",
               "type": "array",
               "minItems": 1,
               "items": {
                    "type": "object",
                    "properties": {
                         "smeBkey": {
                              "title": "SME",
                              "type": "string"
                         }
                    }
               }
          },
          "smeSetupTemplate": {
               "title": "SME Setup Template",
               "type": "string"
          },
          "siteDialplan": {
               "title": "Site Dialplan",
               "type": "boolean"
          },
          "siteDialplanSlcTemplate": {
               "title": "SLC based site dialplan template name",
               "type": "string"
          },
          "siteDialplanFlatTemplate": {
               "title": "Flat site dialplan template name",
               "type": "string"
          },
          "firstInCountry": {
               "title": "First site In Country",
               "type": "boolean"
          },
          "firstSiteInCountryTemplate": {
               "title": "First Site In Country Template",
               "type": "string"
          },
          "dnRouting": {
               "title": "DN Routing",
               "type": "boolean"
          },
          "dnRoutingTemplate": {
               "title": "DN Routing Template",
               "type": "string"
          },
          "associate1to1": {
               "title": "Associate E164 1 to 1",
               "type": "boolean"
          },
          "associate1to1Template": {
               "title": "Associate 1 to 1 Template",
               "type": "string"
          },
          "associate1toN": {
               "title": "Associate E164 1 to N",
               "type": "boolean"
          },
          "associate1toNTemplate": {
               "title": "Associate 1 to N Template",
               "type": "string"
          },
          "addFmc": {
               "title": "Add FMC",
               "type": "boolean"
          },
          "addFmcTemplate": {
               "title": "FMC Template",
               "type": "string"
          },
          "updateFmcTemplate": {
               "title": "FMC update Template",
               "type": "string"
          },
          "huntGroupPilot": {
               "title": "Hunt Group Pilot",
               "type": "boolean"
          },
          "huntGroupPilotTemplate": {
               "title": "Hunt Group Pilot Template",
               "type": "string"
          },
          "externalGroupCli": {
               "title": "External Group CLI",
               "type": "boolean"
          },
          "externalGroupCliTemplate": {
               "title": "External Group CLI Template",
               "type": "string"
          },
          "leafClusterData": {
               "title": "Leaf Cluster Data",
               "type": "array",
               "required": true,
               "items": {
                    "type": "object",
                    "properties": {
                         "leafClusterBkey": {
                              "title": "Leaf Cluster",
                              "type": "string"
                         },
                         "leafClusterRL": {
                              "title": "Route List to Leaf Cluster",
                              "description": "Route List name on SME to route to leaf cluster",
                              "type": "string"
                         }
                    }
               }
          },
          "noInstance": {
               "title": "No Instance",
               "type": "array",
               "items": {
                    "type": "object",
                    "properties": {
                         "name": {
                              "title": "Name",
                              "type": "string",
                              "maxLength": 1024,
                              "required": true,
                              "readonly": false,
                              "is_password": false,
                              "displayable": false
                         }
                    }
               },
               "maxItems": 1
          }
     }
}

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

Task	Call	URL	Parameters	Payload
Bulk delete [pkid1],[pkid2]...	DELETE	/api/relation/GS_SME_Event_REL/	hierarchy=[hierarchy]	{"hrefs":["/api/relation/GS_SME_Event_REL/[pkid1]", "/api/relation/GS_SME_Event_REL/[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/GS_SME_Event_REL
```
GET http://[host-proxy]/api/relation/GS_SME_Event_REL/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/GS_SME_Event_REL; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/relation/GS_SME_Event_REL/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/relation/GS_SME_Event_REL/[pkid1]", "/api/relation/GS_SME_Event_REL/[pkid2]",...]}}

For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

The XLSX format can be used to bulk load instances of relation/GS_SME_Event_REL and the JSON format can be used to import instances of relation/GS_SME_Event_REL.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for relation/GS_SME_Event_REL:

 GET http://[host-proxy]/api/relation/GS_SME_Event_REL/?hierarchy=[hierarchy]

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

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

GET http://[host]/api/relation/GS_SME_Event_REL/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "pagination": {
          "skip": 0,
          "limit": 3,
          "maximum_limit": 2000,
          "total": 0,
          "total_limit": null,
          "order_by": "customer",
          "direction": "asc",
          "current": "/api/relation/GS_SME_Event_REL/?skip=0&limit=3&order_by=customer&direction=asc&traversal=down"
     },
     "operations": [
          "list",
          "help",
          "field_display_policy",
          "get",
          "configuration_template",
          "update",
          "bulk_update",
          "export",
          "add",
          "remove",
          "export_bulkload_template"
     ],
     "meta": {
          "model_type": "relation/GS_SME_Event_REL",
          "summary_attrs": [
               {
                    "name": "customer",
                    "title": "Customer"
               },
               {
                    "name": "hierarchy_friendly_name",
                    "title": "Located At",
                    "allow_filtering": true
               }
          ],
          "tagged_versions": [],
          "tags": [],
          "title": "",
          "business_key": {},
          "api_version": "21.2",
          "cached": true,
          "references": {
               "children": [],
               "parent": [
                    {
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
                         "pkid": "6t0ggef2c0deab00hb595101"
                    }
               ],
               "device": [
                    {
                         "href": "",
                         "pkid": ""
                    }
               ],
               "foreign_key": [],
               "self": [
                    {
                         "href": "/api/relation/GS_SME_Event_REL/None/",
                         "pkid": null
                    }
               ]
          },
          "model_specific_actions": [
               "list",
               "update",
               "remove",
               "add",
               "export",
               "export_bulkload_template",
               "get"
          ],
          "schema_version": null,
          "actions": [
               {
                    "add": {
                         "method": "GET",
                         "class": "add",
                         "href": "/api/relation/GS_SME_Event_REL/add/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Add"
                    }
               },
               {
                    "remove": {
                         "method": "DELETE",
                         "class": "delete",
                         "href": "/api/relation/GS_SME_Event_REL/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Delete"
                    }
               },
               {
                    "export": {
                         "method": "POST",
                         "class": "export",
                         "href": "/api/relation/GS_SME_Event_REL/export/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export",
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken],
                         "submit": "payload"
                    }
               },
               {
                    "list": {
                         "method": "GET",
                         "class": "list",
                         "href": "/api/relation/GS_SME_Event_REL/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "List"
                    }
               }
          ]
     },
     "resources": []
}

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	Payload
Modify	PUT	/api/relation/GS_SME_Event_REL/[pkid]	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

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

Task	Call	URL	Parameters	Response
Get a selected [export_format] of the schema and a single instance with [pkid] of relation/GS_SME_Event_REL; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/relation/GS_SME_Event_REL/[pkid]/export	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	The response is an attachment. Refer to the list below.

For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=json, the response is a time stamped zip file of data in JSON and a response format:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

The XLSX format can be used to bulk load instances of relation/GS_SME_Event_REL and the JSON format can be used to import instances of relation/GS_SME_Event_REL.

For Bulk Export, refer to the Bulk Export section.

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

API Reference for relation/GS_SME_Event_REL

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

Get the Add form

Create

Bulk Delete

Bulk Export

List

GET http://[host]/api/relation/GS_SME_Event_REL/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Instance API Reference

Modify

Delete

Export

Get