API Reference for device/cuc/HttpsLink

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

Operations on certain device models affect dependent device models. These are indicated at the operation as a list of descendants.

GET http://[host-proxy]/api/device/cuc/HttpsLink/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "Status": {
               "minItems": 0, 
               "type": "integer", 
               "description": " Indicates the status of the directory synchronication with this location.(Idle or synching)", 
               "name": "Status", 
               "title": "Status"
          }, 
          "VoiceNameSyncStatus": {
               "minItems": 0, 
               "type": "integer", 
               "description": " Indicates the status of voice name synchronication with this location.", 
               "name": "VoiceNameSyncStatus", 
               "title": "Voice Name Sync Status"
          }, 
          "DisplayName": {
               "minItems": 0, 
               "type": "string", 
               "description": " Display Name of the Location.", 
               "name": "DisplayName", 
               "title": "Display Name"
          }, 
          "AcceptCertificateErrors": {
               "minItems": 0, 
               "type": "boolean", 
               "description": " Controls whether or not certificate errors are allowed. Some possible errors are: mismatched hostname, expired certificate not-yet-valid certificate", 
               "name": "AcceptCertificateErrors", 
               "title": "Accept Certificate Errors"
          }, 
          "ObjectId": {
               "description": " The primary key for this table. A globally unique, system-generated identifier for a Location object. - template parameter [1]", 
               "title": "Object Id", 
               "minItems": 0, 
               "readonly": true, 
               "type": "string", 
               "name": "ObjectId"
          }, 
          "BaseFeedURL": {
               "minItems": 0, 
               "type": "string", 
               "description": " URL used by Reader to fetch the Directory (and voice name)", 
               "name": "BaseFeedURL", 
               "title": "Base Feed URL"
          }, 
          "Deleted": {
               "minItems": 0, 
               "type": "boolean", 
               "name": "Deleted", 
               "title": "Deleted"
          }, 
          "WarningMode": {
               "minItems": 0, 
               "type": "boolean", 
               "description": " Indicates whether or not the synchronization from the network is in warning mode.", 
               "name": "WarningMode", 
               "title": "Warning Mode"
          }, 
          "RemoteServer": {
               "type": "string", 
               "description": "The description for the RemoteServer.", 
               "name": "RemoteServer", 
               "title": "Remote Server"
          }, 
          "TimeOfLastSync": {
               "minItems": 0, 
               "type": "string", 
               "description": " Reflects the time at which we last synchronized with the this location.", 
               "name": "TimeOfLastSync", 
               "title": "Time Of Last Sync"
          }, 
          "URI": {
               "name": "URI", 
               "format": "uri", 
               "minItems": 0, 
               "title": "URI", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "LastUsn": {
               "minItems": 0, 
               "type": "integer", 
               "description": " Last USN synched", 
               "name": "LastUsn", 
               "title": "Last Usn"
          }, 
          "ObjectCount": {
               "minItems": 0, 
               "type": "integer", 
               "description": " A count of objects on the local node that originally came from the location.", 
               "name": "ObjectCount", 
               "title": "Object Count"
          }, 
          "UseSSL": {
               "minItems": 0, 
               "type": "boolean", 
               "description": " Controls whether or not SSL will be used when communicating with this location.", 
               "name": "UseSSL", 
               "title": "Use SSL"
          }, 
          "TimeOfLastFailure": {
               "minItems": 0, 
               "type": "string", 
               "description": " Reflects the time at which we encountered an error synchronizing with this location", 
               "name": "TimeOfLastFailure", 
               "title": "Time Of Last Failure"
          }, 
          "DirectorySynchronizationRole": {
               "minItems": 0, 
               "type": "integer", 
               "description": " It specifies the directory synchronization mode in the cluster.", 
               "name": "DirectorySynchronizationRole", 
               "title": "Directory Synchronization Role"
          }, 
          "AcceptSelfSignedCertificates": {
               "minItems": 0, 
               "type": "boolean", 
               "description": " Controls whether or not self signed certificates will be accepted when connecting to a node.", 
               "name": "AcceptSelfSignedCertificates", 
               "title": "Accept Self Signed Certificates"
          }, 
          "SyncDistributionLists": {
               "minItems": 0, 
               "type": "boolean", 
               "description": " Controls whether or not public distribution lists are synced from this remote network.", 
               "name": "SyncDistributionLists", 
               "title": "Sync Distribution Lists"
          }, 
          "LocationBaseURLSub": {
               "minItems": 0, 
               "type": "string", 
               "description": " Feeder URL for subscriber machine used by reader to fetch the directory information.", 
               "name": "LocationBaseURLSub", 
               "title": "Location Base URL Sub"
          }, 
          "MaxUsn": {
               "minItems": 0, 
               "type": "integer", 
               "description": " Max usn recieved in feed response.", 
               "name": "MaxUsn", 
               "title": "Max Usn"
          }
     }, 
     "schema_version": "12.5"
}

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/cuc/HttpsLink/bulk_update/?schema=&schema_rules=true	hierarchy=[hierarchy] format=json pkids=pkid1,pkid2,...	In JSON format: POST call to update the instances of device/cuc/HttpsLink device/cuc/HttpsLink schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/cuc/HttpsLink/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/HttpsLink/[pkid1]", "/api/v0/device/cuc/HttpsLink/[pkid2]",...]}}

To get a list of model instance pkids that are available to Bulk Modify, use the GET call:
```
GET http://[host-proxy]/api/device/cuc/HttpsLink/?hierarchy=[hierarchy]&format=json
```
The POST payload is in JSON format (refer to the Payload example) and contains:
- data in name-value update pairs according to the returned schema
- meta (empty - for a valid payload)
- request_meta with the hrefs list of instances to update

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/cuc/HttpsLink	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/cuc/HttpsLink/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/cuc/HttpsLink	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/cuc/HttpsLink/[pkid1]", "/api/device/cuc/HttpsLink/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/device/cuc/HttpsLink/?hierarchy=[hierarchy]&format=json&schema_rules=true

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/HttpsLink; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/cuc/HttpsLink/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/cuc/HttpsLink/[pkid1]", "/api/device/cuc/HttpsLink/[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 device/cuc/HttpsLink and the JSON format can be used to import instances of device/cuc/HttpsLink.

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

 GET http://[host-proxy]/api/device/cuc/HttpsLink/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/HttpsLink	POST	/api/device/cuc/HttpsLink/export_bulkload_template/	hierarchy=[hierarchy] modeltype=device/cuc/HttpsLink	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/cuc/HttpsLink/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]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/cuc/HttpsLink/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy 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/FieldDisplayPolicy/?hierarchy=[hierarchy]

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

(The list will return 0 to 3 device/cuc/HttpsLink instances)

GET http://[host]/api/device/cuc/HttpsLink/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "DisplayName", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/cuc/HttpsLink/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "meta": {
          "tags": [], 
          "cached": true, 
          "title": "", 
          "business_key": {}, 
          "schema_version": "12.5", 
          "references": {
               "device": [
                    {
                         "pkid": "", 
                         "href": ""
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/cuc/HttpsLink/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", 
                         "method": "GET", 
                         "title": "Bulk Modify"
                    }
               }, 
               {
                    "move": {
                         "title": "Move", 
                         "support_async": true, 
                         "class": "move", 
                         "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cuc/HttpsLink", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/cuc/HttpsLink/export/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export_bulkload_template": {
                         "support_async": false, 
                         "class": "bulkload_template", 
                         "href": "/api/device/cuc/HttpsLink/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/cuc/HttpsLink/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/cuc/HttpsLink/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/cuc/HttpsLink/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/cuc/HttpsLink/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/cuc/HttpsLink/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/cuc/HttpsLink", 
          "model_specific_actions": [
               "list", 
               "update", 
               "get", 
               "bulk_update_form", 
               "clone", 
               "configuration_template", 
               "export", 
               "export_bulkload_template", 
               "field_display_policy", 
               "help", 
               "move"
          ], 
          "summary_attrs": [
               {
                    "name": "DisplayName", 
                    "title": "Display Name"
               }, 
               {
                    "allow_filtering": true, 
                    "name": "hierarchy_friendly_name", 
                    "title": "Located At"
               }
          ], 
          "api_version": "19.3.1", 
          "tagged_versions": []
     }, 
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for device/cuc/HttpsLink.	GET	/api/device/cuc/HttpsLink/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/cuc/HttpsLink 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	Payload
Modify	PUT	/api/device/cuc/HttpsLink/[pkid]/	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/cuc/HttpsLink/[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 device/cuc/HttpsLink

GET http://[host-proxy]/api/device/cuc/HttpsLink/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=device/cuc/HttpsLink	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Response
Get a selected [export_format] of the schema and a single instance with [pkid] of device/cuc/HttpsLink; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/cuc/HttpsLink/[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 device/cuc/HttpsLink and the JSON format can be used to import instances of device/cuc/HttpsLink.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/device/cuc/HttpsLink/[pkid]/	hierarchy=[hierarchy]	The device/cuc/HttpsLink instance with [pkid].

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

Task	Call	URL	Parameters	Payload
Purge	POST	/api/device/cuc/HttpsLink/[pkid]/purge/	hierarchy=[hierarchy]	If payload required:

API Reference for device/cuc/HttpsLink

GET http://[host-proxy]/api/device/cuc/HttpsLink/schema/?hierarchy=[hierarchy]&format=json&schema=1

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

GET http://[host]/api/device/cuc/HttpsLink/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Clone

Move

Export

Get

Help

Purge