[Index]
Model ref.: device/cuc/SubjectLineParameter
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": {
"ParameterType": {
"description": " Identifies the type of Replaceable Parameter in the Parameter column.",
"title": "Parameter Type",
"minItems": 0,
"readonly": true,
"type": "integer",
"name": "ParameterType"
},
"LanguageCode": {
"description": " The language code (LCID) indicating the language of the text in the Value.",
"title": "Language Code",
"minItems": 0,
"readonly": true,
"type": "integer",
"name": "LanguageCode"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a CallAction object. - template parameter [1]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"FactoryDefaultParameter": {
"description": " Factory Default Replaceable Parameter of a SubjectLine. This value is localized for the specified language.",
"title": "Factory Default Parameter",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "FactoryDefaultParameter"
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"MessageType": {
"description": " Identifies the type of Message the Replaceable Parameter is associated with.",
"title": "Message Type",
"minItems": 0,
"readonly": true,
"type": "integer",
"name": "MessageType"
},
"Parameter": {
"minItems": 0,
"title": "Parameter",
"type": "string",
"description": "The computed result of Factory Default Replacable Parameter line or the Customized Paremeter when it exists.",
"name": "Parameter"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/SubjectLineParameter/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/SubjectLineParameter/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/SubjectLineParameter/[pkid1]", "/api/v0/device/cuc/SubjectLineParameter/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/SubjectLineParameter/?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/SubjectLineParameter |
|
{"hrefs": ["/api/device/cuc/SubjectLineParameter/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/SubjectLineParameter |
|
{"hrefs": ["/api/device/cuc/SubjectLineParameter/[pkid1]", "/api/device/cuc/SubjectLineParameter/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/SubjectLineParameter; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/SubjectLineParameter/export/ |
|
{ "hrefs":["/api/device/cuc/SubjectLineParameter/[pkid1]", "/api/device/cuc/SubjectLineParameter/[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/SubjectLineParameter and the JSON format can be used to import instances of device/cuc/SubjectLineParameter.
GET http://[host-proxy]/api/device/cuc/SubjectLineParameter/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/SubjectLineParameter | POST | /api/device/cuc/SubjectLineParameter/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/SubjectLineParameter/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/SubjectLineParameter/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/SubjectLineParameter/ |
|
The device/cuc/SubjectLineParameter schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/SubjectLineParameter instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "ObjectId",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/SubjectLineParameter/?skip=0&limit=3&order_by=ObjectId&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 105
},
"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/SubjectLineParameter/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/SubjectLineParameter",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/SubjectLineParameter/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/SubjectLineParameter/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/SubjectLineParameter/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/SubjectLineParameter/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/SubjectLineParameter/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/SubjectLineParameter/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/SubjectLineParameter/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/SubjectLineParameter",
"model_specific_actions": [
"list",
"update",
"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": "61b13221eadb826afd7c7308",
"meta": {
"tags": [],
"cached": true,
"title": "03f318dd-faa5-4539-97be-5dceac2b2525",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "61b12f13eadb826afd7b7dd9",
"href": "/api/v0/data/UnityConnection/61b12f13eadb826afd7b7dd9"
}
],
"self": [
{
"pkid": "61b13221eadb826afd7c7308",
"href": "/api/device/cuc/SubjectLineParameter/61b13221eadb826afd7c7308/"
}
],
"parent": [
{
"pkid": "61b12e93eadb826afd7b5dad",
"href": "/api/data/HierarchyNode/61b12e93eadb826afd7b5dad"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/SubjectLineParameter/61b13221eadb826afd7c7308/",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/SubjectLineParameter/61b13221eadb826afd7c7308/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/61b13221eadb826afd7c7308/?model_type=device/cuc/SubjectLineParameter",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/SubjectLineParameter/61b13221eadb826afd7c7308/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/SubjectLineParameter/61b13221eadb826afd7c7308/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/SubjectLineParameter/61b13221eadb826afd7c7308/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/SubjectLineParameter/61b13221eadb826afd7c7308/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/SubjectLineParameter",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b13221eadb826afd7c7308"
],
"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": {
"ParameterType": 2,
"LanguageCode": 1033,
"ObjectId": "03f318dd-faa5-4539-97be-5dceac2b2525",
"hierarchy": "61b12e93eadb826afd7b5dad",
"FactoryDefaultParameter": "Unknown called ID",
"URI": "/vmrest/subjectlineparameters/03f318dd-faa5-4539-97be-5dceac2b2525",
"MessageType": 1,
"hierarchy_friendly_name": "CS-P (Provider)",
"summary_device": "Partitioned CUCxn, 192.168.100.22, 8443, hcs.CS-P",
"Parameter": "Unknown called ID",
"hierarchy_path": "sys.hcs.CS-P"
}
},
{
"pkid": "61b132adeadb826afd7c95f3",
"meta": {
"tags": [],
"cached": true,
"title": "06e59718-e8f7-4a3d-8299-0d6fd8a83c1f",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "61b12f56eadb826afd7b8db9",
"href": "/api/v0/data/UnityConnection/61b12f56eadb826afd7b8db9"
}
],
"self": [
{
"pkid": "61b132adeadb826afd7c95f3",
"href": "/api/device/cuc/SubjectLineParameter/61b132adeadb826afd7c95f3/"
}
],
"parent": [
{
"pkid": "61b12edfeadb826afd7b715a",
"href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cuc/SubjectLineParameter/61b132adeadb826afd7c95f3/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/SubjectLineParameter/61b132adeadb826afd7c95f3/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/61b132adeadb826afd7c95f3/?model_type=device/cuc/SubjectLineParameter",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/SubjectLineParameter/61b132adeadb826afd7c95f3/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/SubjectLineParameter/61b132adeadb826afd7c95f3/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/SubjectLineParameter/61b132adeadb826afd7c95f3/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/SubjectLineParameter/61b132adeadb826afd7c95f3/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/SubjectLineParameter",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b12ed1eadb826afd7b6ddc",
"61b12edfeadb826afd7b715a",
"61b132adeadb826afd7c95f3"
],
"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": {
"ParameterType": 5,
"LanguageCode": 1034,
"ObjectId": "06e59718-e8f7-4a3d-8299-0d6fd8a83c1f",
"hierarchy": "61b12edfeadb826afd7b715a",
"FactoryDefaultParameter": "urgente",
"URI": "/vmrest/subjectlineparameters/06e59718-e8f7-4a3d-8299-0d6fd8a83c1f",
"MessageType": 1,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"Parameter": "urgente",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "61b134daeadb826afd7d0951",
"meta": {
"tags": [],
"cached": true,
"title": "06e59718-e8f7-4a3d-8299-0d6fd8a83c1f",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "61b12fa5eadb826afd7ba3e2",
"href": "/api/v0/data/UnityConnection/61b12fa5eadb826afd7ba3e2"
}
],
"self": [
{
"pkid": "61b134daeadb826afd7d0951",
"href": "/api/device/cuc/SubjectLineParameter/61b134daeadb826afd7d0951/"
}
],
"parent": [
{
"pkid": "61b12edfeadb826afd7b715a",
"href": "/api/data/HierarchyNode/61b12edfeadb826afd7b715a"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/cuc/SubjectLineParameter/61b134daeadb826afd7d0951/",
"class": "update",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/SubjectLineParameter/61b134daeadb826afd7d0951/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/61b134daeadb826afd7d0951/?model_type=device/cuc/SubjectLineParameter",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/cuc/SubjectLineParameter/61b134daeadb826afd7d0951/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/SubjectLineParameter/61b134daeadb826afd7d0951/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/SubjectLineParameter/61b134daeadb826afd7d0951/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cuc/SubjectLineParameter/61b134daeadb826afd7d0951/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cuc/SubjectLineParameter",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b12ed1eadb826afd7b6ddc",
"61b12edfeadb826afd7b715a",
"61b134daeadb826afd7d0951"
],
"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": {
"ParameterType": 5,
"LanguageCode": 1034,
"ObjectId": "06e59718-e8f7-4a3d-8299-0d6fd8a83c1f",
"hierarchy": "61b12edfeadb826afd7b715a",
"FactoryDefaultParameter": "urgente",
"URI": "/vmrest/subjectlineparameters/06e59718-e8f7-4a3d-8299-0d6fd8a83c1f",
"MessageType": 1,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Dedicated CUCxn, 192.168.100.21, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"Parameter": "urgente",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "61b13221eadb826afd7c7308",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "03f318dd-faa5-4539-97be-5dceac2b2525",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "61b12e93eadb826afd7b5dad",
"href": "/api/data/HierarchyNode/61b12e93eadb826afd7b5dad"
}
],
"self": [
{
"pkid": "61b13221eadb826afd7c7308",
"href": "/api/device/cuc/SubjectLineParameter/61b13221eadb826afd7c7308/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "61b12f13eadb826afd7b7dd9",
"href": "/api/v0/data/UnityConnection/61b12f13eadb826afd7b7dd9"
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/SubjectLineParameter/61b13221eadb826afd7c7308/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/SubjectLineParameter/61b13221eadb826afd7c7308/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/61b13221eadb826afd7c7308/?hierarchy=[hierarchy]&model_type=device/cuc/SubjectLineParameter",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/SubjectLineParameter/61b13221eadb826afd7c7308/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/SubjectLineParameter/61b13221eadb826afd7c7308/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/SubjectLineParameter/61b13221eadb826afd7c7308/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/SubjectLineParameter/61b13221eadb826afd7c7308/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/SubjectLineParameter",
"path": [
"6t0ggef2c0deab00hb595101",
"61b0e48541e9336d6e1ee12e",
"61b12e93eadb826afd7b5dad",
"61b13221eadb826afd7c7308"
],
"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": {
"ParameterType": 2,
"LanguageCode": 1033,
"ObjectId": "03f318dd-faa5-4539-97be-5dceac2b2525",
"FactoryDefaultParameter": "Unknown called ID",
"URI": "/vmrest/subjectlineparameters/03f318dd-faa5-4539-97be-5dceac2b2525",
"MessageType": 1,
"Parameter": "Unknown called ID"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/SubjectLineParameter. | GET | /api/device/cuc/SubjectLineParameter/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/SubjectLineParameter as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cuc/SubjectLineParameter/[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/SubjectLineParameter/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/SubjectLineParameter/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/SubjectLineParameter | 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/SubjectLineParameter; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/SubjectLineParameter/[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/SubjectLineParameter and the JSON format can be used to import instances of device/cuc/SubjectLineParameter.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/SubjectLineParameter/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/SubjectLineParameter instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/SubjectLineParameter/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/SubjectLineParameter. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/SubjectLineParameter/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |