[Index]
Model ref.: relation/HcsHCMFScheduleREL
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": {
"name": {
"is_password": false,
"description": "The name of the schedule.",
"format": "uri",
"required": true,
"displayable": false,
"target_attr": "name",
"readonly": false,
"target": "/api/data/Schedule/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"maxLength": 1024,
"title": "Name",
"type": "string",
"target_model_type": "data/Schedule",
"choices": []
},
"schedule": {
"title": "Schedule",
"type": "object",
"properties": {
"name": {
"description": "Name of this Schedule",
"title": "Schedule Name",
"required": true,
"readonly": false,
"type": "string"
},
"last_executed": {
"description": "Last time that this schedule executed",
"title": "Last Executed (UTC Time)",
"required": false,
"readonly": false,
"type": "string"
},
"owner": {
"description": "A business key that identifies the data/User who created the schedule.",
"title": "Owner",
"required": false,
"readonly": true,
"type": "string"
},
"schedule_type": {
"description": "Type of Schedule",
"title": "Schedule Type",
"required": true,
"choices": [
{
"value": "single",
"title": "Single Execution"
},
{
"value": "multi",
"title": "Multi Execution"
}
],
"readonly": false,
"type": "string"
},
"active": {
"description": "Is the entire schedule active or not.",
"title": "Active",
"default": true,
"required": false,
"readonly": false,
"type": "boolean"
},
"skip_next": {
"description": "Skip immediate execution on activation.",
"title": "Skip execution on activation.",
"default": false,
"required": false,
"readonly": false,
"type": "boolean"
},
"scheduled_resources": {
"description": "List of resources that will be actioned",
"title": "Scheduled resources",
"minItems": 1,
"items": {
"type": "object",
"properties": {
"action": {
"description": "Action to perform",
"title": "Action",
"required": true,
"choices": [
{
"value": "execute",
"title": "Execute"
}
],
"readonly": false,
"type": "string"
},
"resource_type": {
"description": "Resource types to which this schedule will apply.",
"title": "Resource Type",
"required": true,
"choices": [
{
"value": "",
"title": ""
}
],
"type": "string"
},
"resource_attribute": {
"description": "Resource attribute that will be used to filter/choose from.",
"title": "Resource Attribute",
"required": true,
"choices": [
{
"value": "",
"title": ""
}
],
"type": "string"
},
"resource_instance": {
"description": "DESCRIPTION",
"title": "Resource",
"required": true,
"choices": [
{
"value": "",
"title": ""
}
],
"type": "string"
},
"perform_action": {
"default": true,
"type": "boolean",
"description": "DESCRIPTION",
"title": "Perform Action"
}
}
},
"required": true,
"type": "array"
},
"single_execute": {
"description": "Single Execution",
"title": "Single Execution",
"required": false,
"readonly": false,
"type": "object",
"properties": {
"single_date": {
"description": "Execution Date",
"title": "Execution Date (YYYY-MM-DD. Local date)",
"pattern": "^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12]\\d|3[01])$",
"required": false,
"readonly": false,
"type": "string"
},
"single_time": {
"description": "Execution Time",
"title": "Execution Time (HH:MM:SS. Local time)",
"pattern": "^([0-1]\\d|2[0-3]):(0[0-9]|[1-5]\\d):(0[0-9]|[1-5]\\d)$",
"required": false,
"readonly": false,
"type": "string"
},
"single_timezone": {
"description": "Timezone for Execution",
"title": "Execution Timezone (Local timezone)",
"default": "0",
"pattern": "^[-+]?\\d+$",
"required": false,
"readonly": false,
"type": "string"
}
}
},
"multi_execute": {
"description": "Multi Execution",
"title": "Multiple Executions",
"required": false,
"readonly": false,
"type": "object",
"properties": {
"use_specific": {
"description": "Use specific executions.",
"title": "Use Specific Executions",
"default": false,
"required": false,
"readonly": false,
"type": "boolean"
},
"use_calender": {
"description": "Use calendar executions.",
"title": "Use Calendar Executions",
"default": false,
"required": false,
"readonly": false,
"type": "boolean"
},
"use_timed": {
"description": "Use timed executions.",
"title": "Use Timed Executions",
"default": false,
"required": false,
"readonly": false,
"type": "boolean"
},
"specific_execute": {
"description": "Specific Execution Dates",
"title": "Specific Execution Dates",
"items": {
"type": "object",
"properties": {
"specific_date": {
"description": "Execution Date",
"title": "Execution Date (YYYY-MM-DD. Local date)",
"pattern": "^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12]\\d|3[01])$",
"required": false,
"readonly": false,
"type": "string"
},
"specific_time": {
"description": "Execution Time",
"title": "Execution Time (HH:MM:SS. Local time)",
"pattern": "^([0-1]\\d|2[0-3]):(0[0-9]|[1-5]\\d):(0[0-9]|[1-5]\\d)$",
"required": false,
"readonly": false,
"type": "string"
},
"specific_timezone": {
"description": "Timezone for Execution",
"title": "Execution Timezone (Local timezone)",
"default": "0",
"pattern": "^[-+]?\\d+$",
"required": false,
"readonly": false,
"type": "string"
}
}
},
"required": false,
"readonly": false,
"type": "array"
},
"calender_execute": {
"description": "Repeated Execution by Calendar",
"title": "Calendar Executions",
"required": false,
"readonly": false,
"type": "object",
"properties": {
"calender_month": {
"description": "Calendar Month",
"title": "Calendar Month",
"required": false,
"maximum": 12,
"readonly": false,
"minimum": 1,
"type": "integer"
},
"calender_day": {
"description": "Calendar Day",
"title": "Calendar Day",
"required": false,
"maximum": 31,
"readonly": false,
"minimum": 1,
"type": "integer"
},
"calender_hour": {
"description": "Calendar Hour",
"title": "Calendar Hour",
"required": false,
"maximum": 23,
"readonly": false,
"minimum": 0,
"type": "integer"
},
"calender_minute": {
"description": "Calendar Minute",
"title": "Calendar Minute",
"required": false,
"maximum": 59,
"readonly": false,
"minimum": 0,
"type": "integer"
},
"calender_timezone": {
"description": "Timezone for Execution",
"title": "Execution Timezone (Local timezone)",
"default": "0",
"pattern": "^[-+]?\\d+$",
"required": false,
"readonly": false,
"type": "string"
}
}
},
"timed_execute": {
"description": "Timed Execution",
"title": "Timed Executions",
"required": false,
"readonly": false,
"type": "object",
"properties": {
"first_date": {
"description": "Execution Date",
"title": "First Execution Date (YYYY-MM-DD. Local date)",
"pattern": "^\\d{4}\\-(0[1-9]|1[012])\\-(0[1-9]|[12]\\d|3[01])$",
"required": false,
"readonly": false,
"type": "string"
},
"first_time": {
"description": "Execution Time",
"title": "First Execution Time (HH:MM:SS. Local time)",
"pattern": "^([0-1]\\d|2[0-3]):(0[0-9]|[1-5]\\d):(0[0-9]|[1-5]\\d)$",
"required": false,
"readonly": false,
"type": "string"
},
"first_timezone": {
"description": "Timezone for Execution",
"title": "First Execution Timezone (Local timezone)",
"default": "0",
"pattern": "^[-+]?\\d+$",
"required": false,
"readonly": false,
"type": "string"
},
"repeat_day": {
"description": "Repeat Days",
"title": "Repeat after (x) Days",
"default": 0,
"required": false,
"readonly": false,
"minimum": 0,
"type": "integer"
},
"repeat_hour": {
"description": "Repeat Hours",
"title": "Repeat after (x) Hours",
"default": 0,
"required": false,
"readonly": false,
"minimum": 0,
"type": "integer"
},
"repeat_minute": {
"description": "Repeat Minutes",
"title": "Repeat after (x) Minutes",
"default": 0,
"required": false,
"readonly": false,
"minimum": 0,
"type": "integer"
},
"repeat_number": {
"description": "Number of Repeats",
"title": "Number of Repeats (0 = infinite)",
"default": 0,
"required": false,
"readonly": false,
"minimum": 0,
"type": "integer"
}
}
}
}
}
}
}
},
"schema_version": "2.1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsHCMFScheduleREL/add/ |
|
The GUI Add form of relation/HcsHCMFScheduleREL 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/HcsHCMFScheduleREL | 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/HcsHCMFScheduleREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsHCMFScheduleREL/[pkid1]", "/api/relation/HcsHCMFScheduleREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsHCMFScheduleREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsHCMFScheduleREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsHCMFScheduleREL/export/ |
|
{ "hrefs":["/api/relation/HcsHCMFScheduleREL/[pkid1]", "/api/relation/HcsHCMFScheduleREL/[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/HcsHCMFScheduleREL and the JSON format can be used to import instances of relation/HcsHCMFScheduleREL.
GET http://[host-proxy]/api/relation/HcsHCMFScheduleREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsHCMFScheduleREL | POST | /api/relation/HcsHCMFScheduleREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsHCMFScheduleREL/ |
|
The relation/HcsHCMFScheduleREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsHCMFScheduleREL instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 1,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/HcsHCMFScheduleREL/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"bulk_update",
"help",
"update",
"add",
"export",
"get",
"list",
"export_bulkload_template",
"remove",
"configuration_template",
"field_display_policy"
],
"meta": {
"model_type": "relation/HcsHCMFScheduleREL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/HcsHCMFScheduleREL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"help",
"update",
"add",
"export",
"get",
"list",
"export_bulkload_template",
"remove"
],
"schema_version": "2.1",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/HcsHCMFScheduleREL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsHCMFScheduleREL/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/HcsHCMFScheduleREL/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/HcsHCMFScheduleREL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/HcsHCMFScheduleREL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsHCMFScheduleREL/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"name": "HcsHcmfSyncSCHED",
"pkid": "5df0b281ce894e0012755196",
"hierarchy_friendly_name": "hcs (Hcs)",
"hierarchy_path": "sys.hcs"
},
"meta": {
"model_type": "relation/HcsHCMFScheduleREL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "title format",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5da4c643ce894e0012225c90",
"href": "/api/data/HierarchyNode/5da4c643ce894e0012225c90"
}
],
"foreign_key": [
{
"pkid": "5df0b281ce894e0012755183",
"path": "name",
"model_type": "data/Schedule"
}
],
"self": [
{
"href": "/api/relation/HcsHCMFScheduleREL/5df0b281ce894e0012755193/",
"pkid": "5df0b281ce894e0012755193"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"5df0b281ce894e0012755193"
],
"schema_version": "2.0",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsHCMFScheduleREL/5df0b281ce894e0012755193/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsHCMFScheduleREL/5df0b281ce894e0012755193/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsHCMFScheduleREL/5df0b281ce894e0012755193/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsHCMFScheduleREL/5df0b281ce894e0012755193/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsHCMFScheduleREL/5df0b281ce894e0012755193/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5df0b281ce894e0012755193"
}
]
}
(Show the first instance)
{
"data": {
"name": "HcsHcmfSyncSCHED",
"schedule": {
"scheduled_resources": [
{
"action": "execute",
"resource_instance": "HcsHcmfPullDS",
"resource_attribute": "name",
"perform_action": true,
"resource_type": "data/DataSync"
}
],
"multi_execute": {
"use_specific": false,
"use_timed": true,
"timed_execute": {
"repeat_day": 14,
"repeat_minute": 0,
"first_date": "2019-12-11",
"first_timezone": "0",
"repeat_number": 0,
"repeat_hour": 0,
"first_time": "09:10:34"
},
"use_calender": false,
"specific_execute": [
{
"specific_time": "09:10:34",
"specific_date": "2019-12-11",
"specific_timezone": "0"
}
]
},
"name": "HcsHcmfSyncSCHED",
"last_executed": "2024-08-19 03:02:25",
"schedule_type": "multi",
"active": true,
"single_execute": {
"single_time": "09:10:34",
"single_date": "2019-12-11",
"single_timezone": "0"
}
}
},
"meta": {
"model_type": "relation/HcsHCMFScheduleREL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "HcsHcmfSyncSCHED",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"children": [],
"parent": [
{
"pkid": "5da4c643ce894e0012225c90",
"href": "/api/data/HierarchyNode/5da4c643ce894e0012225c90"
}
],
"self": [
{
"href": "/api/relation/HcsHCMFScheduleREL/5df0b281ce894e0012755193/",
"pkid": "5df0b281ce894e0012755193"
}
]
},
"schema_version": "2.1",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HcsHCMFScheduleREL/5df0b281ce894e0012755193/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsHCMFScheduleREL/5df0b281ce894e0012755193/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsHCMFScheduleREL/5df0b281ce894e0012755193/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsHCMFScheduleREL/5df0b281ce894e0012755193/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsHCMFScheduleREL/5df0b281ce894e0012755193/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "5df0b281ce894e0012755193"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsHCMFScheduleREL. | GET | /api/relation/HcsHCMFScheduleREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsHCMFScheduleREL as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HcsHCMFScheduleREL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsHCMFScheduleREL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsHCMFScheduleREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsHCMFScheduleREL/[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/HcsHCMFScheduleREL and the JSON format can be used to import instances of relation/HcsHCMFScheduleREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsHCMFScheduleREL/[pkid] | hierarchy=[hierarchy] | The relation/HcsHCMFScheduleREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsHCMFScheduleREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsHCMFScheduleREL. |