[Index]
This relation wraps the default CUCM Time Schedule element.
Model ref.: relation/HcsTimeScheduleREL
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": {
"description": {
"title": "Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 255,
"type": "string"
},
"isPublished": {
"description": "TimeSchedule cannot be published if it has a todOwnerId assigned to it. Only Administrative Time Schedule can be published.",
"title": "Is Published",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"timeScheduleCategory": {
"title": "Time Schedule Category",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Regular",
"title": "Regular"
},
{
"value": "Holiday or Vacation",
"title": "Holiday or Vacation"
}
],
"default": "Regular",
"maxItems": 1,
"type": "string"
},
"members": {
"title": "Members",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"member": {
"name": "member",
"title": "Member",
"minItems": 1,
"items": {
"type": [
"object",
"null"
],
"properties": {
"timePeriodName": {
"name": "timePeriodName",
"title": "Time Period Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
}
}
},
"required": true,
"type": "array"
}
}
},
"todOwnerIdName": {
"target": "/api/device/cucm/User/choices/?field=userid&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": false,
"choices": [],
"target_attr": "userid",
"maxItems": 1,
"target_model_type": "device/cucm/User",
"title": "Tod Owner Id Name",
"type": [
"string",
"null"
]
},
"shadow": {
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"type": "array",
"maxItems": 1,
"title": "Shadow"
},
"name": {
"title": "Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"maxLength": 50,
"type": "string"
}
},
"schema_version": "2.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsTimeScheduleREL/add/ |
|
The GUI Add form of relation/HcsTimeScheduleREL 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/HcsTimeScheduleREL | hierarchy=[hierarchy] |
|
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/HcsTimeScheduleREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsTimeScheduleREL/[pkid1]", "/api/relation/HcsTimeScheduleREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsTimeScheduleREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsTimeScheduleREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsTimeScheduleREL/export/ |
|
{ "hrefs":["/api/relation/HcsTimeScheduleREL/[pkid1]", "/api/relation/HcsTimeScheduleREL/[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/HcsTimeScheduleREL and the JSON format can be used to import instances of relation/HcsTimeScheduleREL.
GET http://[host-proxy]/api/relation/HcsTimeScheduleREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsTimeScheduleREL | POST | /api/relation/HcsTimeScheduleREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsTimeScheduleREL/ |
|
The relation/HcsTimeScheduleREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsTimeScheduleREL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"list",
"update",
"remove",
"add",
"bulk_update",
"export",
"export_bulkload_template"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/HcsTimeScheduleREL/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 5
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2.1",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/HcsTimeScheduleREL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/HcsTimeScheduleREL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsTimeScheduleREL/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsTimeScheduleREL/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/HcsTimeScheduleREL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/HcsTimeScheduleREL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsTimeScheduleREL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsTimeScheduleREL",
"model_specific_actions": [
"help",
"get",
"clone",
"list",
"update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"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": "5f3ae597ce894e0012055349",
"meta": {
"tags": [],
"cached": true,
"title": "All the time",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae58ace894e00120550c2",
"href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae597ce894e0012055349",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae597ce894e0012055349/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae597ce894e0012055349/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae597ce894e0012055349/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae597ce894e0012055349/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae597ce894e0012055349/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae597ce894e0012055349/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae597ce894e0012055349/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsTimeScheduleREL",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae597ce894e0012055349"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"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": {
"name": "All the time",
"description": "Applies to all days and times",
"isPublished": false,
"timeScheduleCategory": "Regular",
"members": {
"member": [
{
"timePeriodName": "All the time"
}
]
},
"todOwnerIdName": null,
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
},
{
"pkid": "5f3ae59ace894e001205544e",
"meta": {
"tags": [],
"cached": true,
"title": "Cu1-AfterHrs-TSchd",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5f3ae58ace894e00120550c2",
"href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2"
}
],
"self": [
{
"pkid": "5f3ae59ace894e001205544e",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae59ace894e001205544e/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/relation/HcsTimeScheduleREL/5f3ae59ace894e001205544e/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/relation/HcsTimeScheduleREL/5f3ae59ace894e001205544e/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/relation/HcsTimeScheduleREL/5f3ae59ace894e001205544e/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae59ace894e001205544e/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/relation/HcsTimeScheduleREL/5f3ae59ace894e001205544e/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/relation/HcsTimeScheduleREL/5f3ae59ace894e001205544e/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "relation/HcsTimeScheduleREL",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae59ace894e001205544e"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"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": {
"description": "After Hours Time Schedule 18-8",
"hierarchy": "5f3ae552ce894e00120537fa",
"isPublished": false,
"name": "Cu1-AfterHrs-TSchd",
"timeScheduleCategory": "Regular",
"members": {
"member": [
{
"timePeriodName": "Cu1-AfterHrs1-TPer"
},
{
"timePeriodName": "Cu1-AfterHrs2-TPer"
}
]
},
"todOwnerIdName": null,
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
},
{
"pkid": "5f3ae599ce894e0012055441",
"meta": {
"tags": [],
"cached": true,
"title": "Cu1-AllDay-TSchd",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5f3ae58ace894e00120550c2",
"href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2"
}
],
"self": [
{
"pkid": "5f3ae599ce894e0012055441",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae599ce894e0012055441/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae599ce894e0012055441/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae599ce894e0012055441/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae599ce894e0012055441/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae599ce894e0012055441/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae599ce894e0012055441/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae599ce894e0012055441/help",
"class": "help",
"title": "Help"
}
}
],
"model_type": "relation/HcsTimeScheduleREL",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae599ce894e0012055441"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"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": {
"description": "All Day Time Schedule 0-24",
"hierarchy": "5f3ae552ce894e00120537fa",
"isPublished": false,
"name": "Cu1-AllDay-TSchd",
"timeScheduleCategory": "Regular",
"members": {
"member": [
{
"timePeriodName": "Cu1-AllDay-TPer"
}
]
},
"todOwnerIdName": null,
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
}
]
}
(Show the first instance)
{
"pkid": "5f3ae597ce894e0012055349",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "All the time",
"business_key": {},
"schema_version": "2.1",
"references": {
"device": [
{
"pkid": "5f3ae58ace894e00120550c2",
"href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2"
}
],
"self": [
{
"pkid": "5f3ae597ce894e0012055349",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae597ce894e0012055349/"
}
],
"children": [],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae597ce894e0012055349/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae597ce894e0012055349/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae597ce894e0012055349/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae597ce894e0012055349/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae597ce894e0012055349/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/HcsTimeScheduleREL/5f3ae597ce894e0012055349/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/HcsTimeScheduleREL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"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": {
"description": "Applies to all days and times",
"isPublished": false,
"timeScheduleCategory": "Regular",
"members": {
"member": [
{
"timePeriodName": "All the time"
}
]
},
"todOwnerIdName": null,
"shadow": [],
"name": "All the time"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsTimeScheduleREL. | GET | /api/relation/HcsTimeScheduleREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsTimeScheduleREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsTimeScheduleREL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsTimeScheduleREL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/HcsTimeScheduleREL/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/HcsTimeScheduleREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsTimeScheduleREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsTimeScheduleREL/[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 relation/HcsTimeScheduleREL and the JSON format can be used to import instances of relation/HcsTimeScheduleREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsTimeScheduleREL/[pkid] | hierarchy=[hierarchy] | The relation/HcsTimeScheduleREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsTimeScheduleREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsTimeScheduleREL. |