[Index]
HcsWorkflowRegistryDAT
Model ref.: data/HcsWorkflowRegistryDAT
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": {
"event": {
"is_password": false,
"description": "This field is a reference to an HcsWorkflowRegistryEventsDAT entry.",
"format": "uri",
"title": "Event",
"required": true,
"displayable": false,
"choices": [],
"target_attr": "event",
"readonly": false,
"maxLength": 1024,
"target_model_type": "data/HcsWorkflowRegistryEventsDAT",
"type": "string",
"target": "/api/data/HcsWorkflowRegistryEventsDAT/choices/?field=event&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"workflow": {
"is_password": false,
"description": "This specifies a workflow name which should be executed for the specified event.",
"format": "uri",
"title": "Workflow",
"required": true,
"displayable": false,
"choices": [],
"target_attr": "name",
"readonly": false,
"maxLength": 1024,
"target_model_type": "data/ProvisioningWorkflow",
"type": "string",
"target": "/api/data/ProvisioningWorkflow/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
},
"schema_version": "2.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/HcsWorkflowRegistryDAT/add/ |
|
The GUI Add form of data/HcsWorkflowRegistryDAT 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/data/HcsWorkflowRegistryDAT/ | 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/data/HcsWorkflowRegistryDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsWorkflowRegistryDAT/[pkid1]", "/api/data/HcsWorkflowRegistryDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsWorkflowRegistryDAT/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/HcsWorkflowRegistryDAT/ |
|
The data/HcsWorkflowRegistryDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsWorkflowRegistryDAT instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "event",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/HcsWorkflowRegistryDAT/?skip=0&limit=3&order_by=event&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 5
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {
"hierarchy": false,
"unique": [
"event"
]
},
"schema_version": "2.0",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/data/HcsWorkflowRegistryDAT/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsWorkflowRegistryDAT/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/HcsWorkflowRegistryDAT/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
}
],
"model_type": "data/HcsWorkflowRegistryDAT",
"model_specific_actions": [
"list",
"get",
"add",
"update",
"remove",
"import",
"execute"
],
"summary_attrs": [
{
"name": "event",
"title": "Event"
},
{
"name": "workflow",
"title": "Workflow"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "6109728de04a4a001501fbae",
"meta": {
"tags": [
"HcsLdapIntegration",
"V4UC",
"ba_dcpld__SYSdotHCS"
],
"cached": true,
"title": "title format",
"business_key": {
"hierarchy": false,
"unique": [
"event"
]
},
"schema_version": "2.0",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6109728de04a4a001501fbae",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbae/"
}
],
"parent": [
{
"pkid": "61097058e04a4a001501b18c",
"href": "/api/data/HierarchyNode/61097058e04a4a001501b18c"
}
],
"foreign_key": [
{
"pkid": "610971ade04a4a001501bcdb",
"path": "event",
"model_type": "data/HcsWorkflowRegistryEventsDAT"
},
{
"model_type": "data/ProvisioningWorkflow",
"path": "workflow"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbae/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbae/",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbae/import/",
"class": "import",
"title": "Import"
}
},
{
"execute": {
"support_async": true,
"class": "execute",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbae/execute/",
"method": "POST",
"title": "Execute"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbae/",
"method": "GET",
"title": "Get"
}
}
],
"model_type": "data/HcsWorkflowRegistryDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109728de04a4a001501fbae"
],
"summary_attrs": [
{
"name": "event",
"title": "Event"
},
{
"name": "workflow",
"title": "Workflow"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"pkid": "6109728de04a4a001501fbb1",
"hierarchy_friendly_name": "hcs (Hcs)",
"workflow": "HcsRemoveUserManagementLogsPWF",
"event": "deleteCustomer",
"hierarchy_path": "sys.hcs"
}
},
{
"pkid": "6109728de04a4a001501fbb7",
"meta": {
"tags": [
"HcsDialPlan",
"V4UC",
"ba_dcpld__SYSdotHCS"
],
"cached": true,
"title": "title format",
"business_key": {
"hierarchy": false,
"unique": [
"event"
]
},
"schema_version": "2.0",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6109728de04a4a001501fbb7",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbb7/"
}
],
"parent": [
{
"pkid": "61097058e04a4a001501b18c",
"href": "/api/data/HierarchyNode/61097058e04a4a001501b18c"
}
],
"foreign_key": [
{
"pkid": "610971ade04a4a001501bcd4",
"path": "event",
"model_type": "data/HcsWorkflowRegistryEventsDAT"
},
{
"model_type": "data/ProvisioningWorkflow",
"path": "workflow"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbb7/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbb7/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"import": {
"support_async": true,
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbb7/import/",
"title": "Import",
"method": "POST",
"class": "import"
}
},
{
"execute": {
"support_async": true,
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbb7/execute/",
"title": "Execute",
"class": "execute",
"method": "POST"
}
},
{
"get": {
"support_async": false,
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbb7/",
"title": "Get",
"class": "get",
"method": "GET"
}
}
],
"model_type": "data/HcsWorkflowRegistryDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109728de04a4a001501fbb7"
],
"summary_attrs": [
{
"name": "event",
"title": "Event"
},
{
"name": "workflow",
"title": "Workflow"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"pkid": "6109728de04a4a001501fbba",
"hierarchy_friendly_name": "hcs (Hcs)",
"workflow": "HcsDpCleanupCustomerDialPlanPWF",
"event": "deleteNDL",
"hierarchy_path": "sys.hcs"
}
},
{
"pkid": "6109728de04a4a001501fbc9",
"meta": {
"tags": [
"HcsLdapIntegration",
"V4UC",
"ba_dcpld__SYSdotHCS"
],
"cached": true,
"title": "title format",
"business_key": {
"hierarchy": false,
"unique": [
"event"
]
},
"schema_version": "2.0",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6109728de04a4a001501fbc9",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbc9/"
}
],
"parent": [
{
"pkid": "61097058e04a4a001501b18c",
"href": "/api/data/HierarchyNode/61097058e04a4a001501b18c"
}
],
"foreign_key": [
{
"pkid": "610971ace04a4a001501bccd",
"path": "event",
"model_type": "data/HcsWorkflowRegistryEventsDAT"
},
{
"model_type": "data/ProvisioningWorkflow",
"path": "workflow"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbc9/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbc9/",
"class": "delete",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"class": "import",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbc9/import/",
"method": "POST",
"title": "Import"
}
},
{
"execute": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbc9/execute/",
"class": "execute",
"title": "Execute"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbc9/",
"class": "get",
"title": "Get"
}
}
],
"model_type": "data/HcsWorkflowRegistryDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109728de04a4a001501fbc9"
],
"summary_attrs": [
{
"name": "event",
"title": "Event"
},
{
"name": "workflow",
"title": "Workflow"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"pkid": "6109728de04a4a001501fbcc",
"hierarchy_friendly_name": "hcs (Hcs)",
"workflow": "HcsRemoveUserManagementLogsPWF",
"event": "deleteProvider",
"hierarchy_path": "sys.hcs"
}
}
]
}
(Show the first instance)
{
"pkid": "6109728de04a4a001501fbae",
"meta": {
"tags": [
"HcsLdapIntegration",
"V4UC",
"ba_dcpld__SYSdotHCS"
],
"cached": false,
"title": "title format",
"business_key": {
"hierarchy": false,
"unique": [
"event"
]
},
"schema_version": "2.0",
"references": {
"parent": [
{
"pkid": "61097058e04a4a001501b18c",
"href": "/api/data/HierarchyNode/61097058e04a4a001501b18c"
}
],
"self": [
{
"pkid": "6109728de04a4a001501fbae",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbae/"
}
],
"foreign_key": [
{
"pkid": "610971ade04a4a001501bcdb",
"path": "event",
"model_type": "data/HcsWorkflowRegistryEventsDAT"
},
{
"model_type": "data/ProvisioningWorkflow",
"path": "workflow"
}
],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbae/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbae/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbae/import/?hierarchy=[hierarchy]",
"class": "import",
"title": "Import"
}
},
{
"execute": {
"support_async": true,
"class": "execute",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbae/execute/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Execute"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsWorkflowRegistryDAT/6109728de04a4a001501fbae/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
}
],
"model_type": "data/HcsWorkflowRegistryDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109728de04a4a001501fbae"
],
"summary_attrs": [
{
"name": "event",
"title": "Event"
},
{
"name": "workflow",
"title": "Workflow"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"pkid": "6109728de04a4a001501fbb1",
"event": "deleteCustomer",
"workflow": "HcsRemoveUserManagementLogsPWF"
}
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/HcsWorkflowRegistryDAT/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/HcsWorkflowRegistryDAT/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/data/HcsWorkflowRegistryDAT/[pkid]/import/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Execute | POST | /api/data/HcsWorkflowRegistryDAT/[pkid]/execute/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/HcsWorkflowRegistryDAT/[pkid]/ | hierarchy=[hierarchy] | The data/HcsWorkflowRegistryDAT instance with [pkid]. |