[Index]
Model ref.: device/cuc/Policy
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"TargetUserObjectId": {
"minItems": 0,
"title": "Target User Object Id",
"type": "string",
"description": " The unique identifier of the user object to which this policy applies.",
"name": "TargetUserObjectId"
},
"TargetUserURI": {
"name": "TargetUserURI",
"title": "Target User URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a Policy object. - template parameter [1]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"TargetVmsObjectId": {
"minItems": 0,
"title": "Target Vms Object Id",
"type": "string",
"description": " The unique identifier of the LocationVMS object to which this policy applies.",
"name": "TargetVmsObjectId"
},
"DateExpires": {
"minItems": 0,
"title": "Date Expires",
"type": "string",
"description": " The date and time the policy automatically expires. Used to limit the period of time that a policy is active.",
"name": "DateExpires"
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserURI": {
"name": "UserURI",
"title": "User URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TargetDistributionListObjectId": {
"minItems": 0,
"title": "Target Distribution List Object Id",
"type": "string",
"description": " The unique identifier of the DistributionList object to which this policy applies.",
"name": "TargetDistributionListObjectId"
},
"RoleObjectId": {
"minItems": 0,
"title": "Role Object Id",
"type": "string",
"description": " The unique identifier of the Role object that specifies the privileges to be granted to the subject, for the target. For example, the role could be a \"Technician.\"",
"name": "RoleObjectId"
},
"VmsObjectId": {
"minItems": 0,
"title": "Vms Object Id",
"type": "string",
"description": " The unique identifier of the LocationVMS object to which this policy applies.",
"name": "VmsObjectId"
},
"RoleURI": {
"name": "RoleURI",
"title": "Role URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserObjectId": {
"minItems": 0,
"title": "User Object Id",
"type": "string",
"description": " The unique identifier of the User object (subject) to which this policy is assigned.",
"name": "UserObjectId"
},
"TargetDistributionListURI": {
"name": "TargetDistributionListURI",
"title": "Target Distribution List URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DateCreated": {
"minItems": 0,
"title": "Date Created",
"type": "string",
"description": " The date and time the policy was created.",
"name": "DateCreated"
},
"TargetHandlerObjectId": {
"minItems": 0,
"title": "Target Handler Object Id",
"type": "string",
"description": " The unique identifier of the Handler object to which this policy applies.",
"name": "TargetHandlerObjectId"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/Policy/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/Policy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/Policy/[pkid1]", "/api/v0/device/cuc/Policy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/Policy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cuc/Policy |
|
{"hrefs": ["/api/device/cuc/Policy/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/Policy |
|
{"hrefs": ["/api/device/cuc/Policy/[pkid1]", "/api/device/cuc/Policy/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/Policy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/Policy/export/ |
|
{ "hrefs":["/api/device/cuc/Policy/[pkid1]", "/api/device/cuc/Policy/[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/Policy and the JSON format can be used to import instances of device/cuc/Policy.
GET http://[host-proxy]/api/device/cuc/Policy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/Policy | POST | /api/device/cuc/Policy/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/cuc/Policy/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/cuc/Policy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/Policy/ |
|
The device/cuc/Policy schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/Policy instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "ObjectId",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/Policy/?skip=0&limit=3&order_by=ObjectId&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 12
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "14.0",
"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/Policy/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/Policy",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/Policy/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/Policy/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/Policy/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/Policy/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/Policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/Policy/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/Policy/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/Policy",
"model_specific_actions": [
"list",
"get",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "61b15839eadb826afd81d94c",
"meta": {
"tags": [],
"cached": true,
"title": "09613bff-3923-481c-932d-78ce56fa0563",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "61b15650eadb826afd81b7c1",
"href": "/api/v0/data/UnityConnection/61b15650eadb826afd81b7c1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "61b15839eadb826afd81d94c",
"href": "/api/device/cuc/Policy/61b15839eadb826afd81d94c/"
}
],
"parent": [
{
"pkid": "61b1529aeadb826afd8146c6",
"href": "/api/data/HierarchyNode/61b1529aeadb826afd8146c6"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/Policy/61b15839eadb826afd81d94c/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/61b15839eadb826afd81d94c/?model_type=device/cuc/Policy",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/Policy/61b15839eadb826afd81d94c/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/Policy/61b15839eadb826afd81d94c/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/Policy/61b15839eadb826afd81d94c/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/Policy/61b15839eadb826afd81d94c/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/Policy",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b12ed1eadb826afd7b6ddc",
"61b1529aeadb826afd8146c6",
"61b15839eadb826afd81d94c"
],
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"ObjectId": "09613bff-3923-481c-932d-78ce56fa0563",
"TargetVmsObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"URI": "/vmrest/policies/09613bff-3923-481c-932d-78ce56fa0563",
"UserURI": "/vmrest/users/c20d82cc-4541-480c-ab5d-60949b01f3e6",
"DateCreated": "2017-09-26T09:50:01Z",
"RoleObjectId": "4ddba08b-bd23-41d7-a66b-ded2d3875fd4",
"VmsObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton",
"RoleURI": "/vmrest/roles/4ddba08b-bd23-41d7-a66b-ded2d3875fd4",
"hierarchy_friendly_name": "Overton (Customer)",
"UserObjectId": "c20d82cc-4541-480c-ab5d-60949b01f3e6",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton"
}
},
{
"pkid": "61b15839eadb826afd81d950",
"meta": {
"tags": [],
"cached": true,
"title": "0970516b-bac3-4877-af25-3d5126a22fb5",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "61b15650eadb826afd81b7c1",
"href": "/api/v0/data/UnityConnection/61b15650eadb826afd81b7c1"
}
],
"self": [
{
"pkid": "61b15839eadb826afd81d950",
"href": "/api/device/cuc/Policy/61b15839eadb826afd81d950/"
}
],
"parent": [
{
"pkid": "61b1529aeadb826afd8146c6",
"href": "/api/data/HierarchyNode/61b1529aeadb826afd8146c6"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/Policy/61b15839eadb826afd81d950/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/61b15839eadb826afd81d950/?model_type=device/cuc/Policy",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/Policy/61b15839eadb826afd81d950/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/Policy/61b15839eadb826afd81d950/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/Policy/61b15839eadb826afd81d950/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/Policy/61b15839eadb826afd81d950/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/Policy",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b12ed1eadb826afd7b6ddc",
"61b1529aeadb826afd8146c6",
"61b15839eadb826afd81d950"
],
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"ObjectId": "0970516b-bac3-4877-af25-3d5126a22fb5",
"TargetVmsObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"URI": "/vmrest/policies/0970516b-bac3-4877-af25-3d5126a22fb5",
"UserURI": "/vmrest/users/5e5fc6a9-6142-41b5-9070-77defe44da6a",
"DateCreated": "2017-09-26T09:50:01Z",
"hierarchy": "61b1529aeadb826afd8146c6",
"RoleObjectId": "b9d8df93-0d3b-4287-b21c-9ed90bc743d8",
"VmsObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton",
"RoleURI": "/vmrest/roles/b9d8df93-0d3b-4287-b21c-9ed90bc743d8",
"hierarchy_friendly_name": "Overton (Customer)",
"UserObjectId": "5e5fc6a9-6142-41b5-9070-77defe44da6a",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton"
}
},
{
"pkid": "61b1325ceadb826afd7c8351",
"meta": {
"tags": [],
"cached": true,
"title": "0ab355f4-39c7-4fe2-ad35-e23b0cc2e9d2",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "61b12f56eadb826afd7b8db9",
"href": "/api/v0/data/UnityConnection/61b12f56eadb826afd7b8db9"
}
],
"self": [
{
"pkid": "61b1325ceadb826afd7c8351",
"href": "/api/device/cuc/Policy/61b1325ceadb826afd7c8351/"
}
],
"parent": [
{
"pkid": "61b12edfeadb826afd7b715a",
"href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/Policy/61b1325ceadb826afd7c8351/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/61b1325ceadb826afd7c8351/?model_type=device/cuc/Policy",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/cuc/Policy/61b1325ceadb826afd7c8351/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/Policy/61b1325ceadb826afd7c8351/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/Policy/61b1325ceadb826afd7c8351/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cuc/Policy/61b1325ceadb826afd7c8351/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cuc/Policy",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b12ed1eadb826afd7b6ddc",
"61b12edfeadb826afd7b715a",
"61b1325ceadb826afd7c8351"
],
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"ObjectId": "0ab355f4-39c7-4fe2-ad35-e23b0cc2e9d2",
"TargetVmsObjectId": "2f981bfa-ed9f-4043-928d-a57c288c8abc",
"URI": "/vmrest/policies/0ab355f4-39c7-4fe2-ad35-e23b0cc2e9d2",
"UserURI": "/vmrest/users/659f41d7-9fce-4d70-9d13-bf8502464c2c",
"DateCreated": "2020-05-19T17:26:35Z",
"hierarchy": "61b12edfeadb826afd7b715a",
"RoleObjectId": "500f8ed5-0a7b-47fd-9b49-543e87722a6a",
"VmsObjectId": "2f981bfa-ed9f-4043-928d-a57c288c8abc",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"RoleURI": "/vmrest/roles/500f8ed5-0a7b-47fd-9b49-543e87722a6a",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"UserObjectId": "659f41d7-9fce-4d70-9d13-bf8502464c2c",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "61b15839eadb826afd81d94c",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "09613bff-3923-481c-932d-78ce56fa0563",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "61b1529aeadb826afd8146c6",
"href": "/api/data/HierarchyNode/61b1529aeadb826afd8146c6"
}
],
"self": [
{
"pkid": "61b15839eadb826afd81d94c",
"href": "/api/device/cuc/Policy/61b15839eadb826afd81d94c/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "61b15650eadb826afd81b7c1",
"href": "/api/v0/data/UnityConnection/61b15650eadb826afd81b7c1"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/Policy/61b15839eadb826afd81d94c/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/61b15839eadb826afd81d94c/?hierarchy=[hierarchy]&model_type=device/cuc/Policy",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/Policy/61b15839eadb826afd81d94c/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/Policy/61b15839eadb826afd81d94c/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/Policy/61b15839eadb826afd81d94c/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/Policy/61b15839eadb826afd81d94c/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/Policy",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b12ed1eadb826afd7b6ddc",
"61b1529aeadb826afd8146c6",
"61b15839eadb826afd81d94c"
],
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"ObjectId": "09613bff-3923-481c-932d-78ce56fa0563",
"TargetVmsObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"URI": "/vmrest/policies/09613bff-3923-481c-932d-78ce56fa0563",
"UserURI": "/vmrest/users/c20d82cc-4541-480c-ab5d-60949b01f3e6",
"DateCreated": "2017-09-26T09:50:01Z",
"RoleObjectId": "4ddba08b-bd23-41d7-a66b-ded2d3875fd4",
"VmsObjectId": "cee60b09-5a48-46fc-9fb7-2923257dcffa",
"RoleURI": "/vmrest/roles/4ddba08b-bd23-41d7-a66b-ded2d3875fd4",
"UserObjectId": "c20d82cc-4541-480c-ab5d-60949b01f3e6"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/Policy. | GET | /api/device/cuc/Policy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/Policy as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/Policy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/Policy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/Policy | 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/Policy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/Policy/[pkid]/export/ |
|
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/Policy and the JSON format can be used to import instances of device/cuc/Policy.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/Policy/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/Policy instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/Policy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/Policy. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/Policy/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |