[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", "required": true, "displayable": false, "target_attr": "event", "readonly": false, "target": "/api/data/HcsWorkflowRegistryEventsDAT/choices/?field=event&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "maxLength": 1024, "title": "Event", "type": "string", "target_model_type": "data/HcsWorkflowRegistryEventsDAT", "choices": [] }, "workflow": { "is_password": false, "description": "This specifies a workflow name which should be executed for the specified event.", "format": "uri", "required": true, "displayable": false, "target_attr": "name", "readonly": false, "target": "/api/data/ProvisioningWorkflow/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "maxLength": 1024, "title": "Workflow", "type": "string", "target_model_type": "data/ProvisioningWorkflow", "choices": [] } }, "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)
{ "pagination": { "skip": 0, "limit": 3, "maximum_limit": 2000, "total": 5, "total_limit": null, "order_by": "event", "direction": "asc", "current": "/api/data/HcsWorkflowRegistryDAT/?skip=0&limit=3&order_by=event&direction=asc&traversal=down" }, "operations": [ "field_display_policy", "update", "help", "remove", "move", "add", "export", "list", "configuration_template", "get", "bulk_update_form", "migration", "transform", "export_bulkload_template" ], "meta": { "model_type": "data/HcsWorkflowRegistryDAT", "summary_attrs": [ { "name": "event", "title": "Event" }, { "name": "workflow", "title": "Workflow" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "", "business_key": { "hierarchy": false, "unique": [ "event" ] }, "api_version": "21.2", "cached": true, "references": { "children": [], "parent": [ { "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101", "pkid": "6t0ggef2c0deab00hb595101" } ], "device": [ { "href": "", "pkid": "" } ], "foreign_key": [] }, "model_specific_actions": [ "list", "get", "add", "update", "remove", "import", "execute" ], "schema_version": "2.0", "actions": [ { "add": { "method": "GET", "class": "add", "href": "/api/data/HcsWorkflowRegistryDAT/add/?hierarchy=[hierarchy]", "support_async": false, "title": "Add" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/HcsWorkflowRegistryDAT/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "list": { "method": "GET", "class": "list", "href": "/api/data/HcsWorkflowRegistryDAT/?hierarchy=[hierarchy]", "support_async": false, "title": "List" } } ] }, "resources": [ { "data": { "event": "deleteCustomer", "workflow": "HcsRemoveUserManagementLogsPWF", "pkid": "5ad5cc77affa9343e4d9719f", "hierarchy_friendly_name": "hcs (Hcs)", "hierarchy_path": "sys.hcs" }, "meta": { "model_type": "data/HcsWorkflowRegistryDAT", "summary_attrs": [ { "name": "event", "title": "Event" }, { "name": "workflow", "title": "Workflow" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [ { "pkid": "5ad5cc77affa9343e4d971a0", "version": "0.1.1", "href": "/api/v0/data/HcsWorkflowRegistryDAT/5ad5cc77affa9343e4d9719a/?cached=5ad5cc77affa9343e4d971a0" } ], "tags": [ "HcsLdapIntegration", "V4UC", "ba_CommonOverlay" ], "title": "title format", "business_key": { "hierarchy": false, "unique": [ "event" ] }, "api_version": "21.2", "cached": true, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "pkid": "5ad5bacbaffa9343e4d93e01", "href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01" } ], "foreign_key": [ { "pkid": "5ad5cc72affa9343e4d9718a", "path": "event", "model_type": "data/HcsWorkflowRegistryEventsDAT" }, { "path": "workflow", "model_type": "data/ProvisioningWorkflow" } ], "self": [ { "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc77affa9343e4d9719a/", "pkid": "5ad5cc77affa9343e4d9719a" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "5ad5cc77affa9343e4d9719a" ], "version_tag": "0.1.1", "schema_version": "2.0", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc77affa9343e4d9719a/", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc77affa9343e4d9719a/", "support_async": true, "title": "Delete" } }, { "import": { "method": "POST", "class": "import", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc77affa9343e4d9719a/import/", "support_async": true, "title": "Import" } }, { "execute": { "method": "POST", "class": "execute", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc77affa9343e4d9719a/execute/", "support_async": true, "title": "Execute" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc77affa9343e4d9719a/", "support_async": false, "title": "Get" } } ], "summary": "false" }, "pkid": "5ad5cc77affa9343e4d9719a" }, { "data": { "event": "deleteNDL", "workflow": "HcsDpCleanupCustomerDialPlanPWF", "pkid": "5ad5cc7baffa9343e4d971b4", "hierarchy_friendly_name": "hcs (Hcs)", "hierarchy_path": "sys.hcs" }, "meta": { "model_type": "data/HcsWorkflowRegistryDAT", "summary_attrs": [ { "name": "event", "title": "Event" }, { "name": "workflow", "title": "Workflow" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [ { "pkid": "5ad5cc7baffa9343e4d971b5", "version": "0.1.1", "href": "/api/v0/data/HcsWorkflowRegistryDAT/5ad5cc7baffa9343e4d971af/?cached=5ad5cc7baffa9343e4d971b5" } ], "tags": [ "HcsDialPlan", "V4UC", "ba_CommonOverlay" ], "title": "title format", "business_key": { "hierarchy": false, "unique": [ "event" ] }, "api_version": "21.2", "cached": true, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "pkid": "5ad5bacbaffa9343e4d93e01", "href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01" } ], "foreign_key": [ { "pkid": "5ad5cc6eaffa9343e4d9717e", "path": "event", "model_type": "data/HcsWorkflowRegistryEventsDAT" }, { "path": "workflow", "model_type": "data/ProvisioningWorkflow" } ], "self": [ { "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc7baffa9343e4d971af/", "pkid": "5ad5cc7baffa9343e4d971af" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "5ad5cc7baffa9343e4d971af" ], "version_tag": "0.1.1", "schema_version": "2.0", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc7baffa9343e4d971af/", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc7baffa9343e4d971af/", "support_async": true, "title": "Delete" } }, { "import": { "method": "POST", "class": "import", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc7baffa9343e4d971af/import/", "support_async": true, "title": "Import" } }, { "execute": { "method": "POST", "class": "execute", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc7baffa9343e4d971af/execute/", "support_async": true, "title": "Execute" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc7baffa9343e4d971af/", "support_async": false, "title": "Get" } } ], "summary": "false" }, "pkid": "5ad5cc7baffa9343e4d971af" }, { "data": { "event": "deleteProvider", "workflow": "HcsRemoveUserManagementLogsPWF", "pkid": "5ad5cc7aaffa9343e4d971ad", "hierarchy_friendly_name": "hcs (Hcs)", "hierarchy_path": "sys.hcs" }, "meta": { "model_type": "data/HcsWorkflowRegistryDAT", "summary_attrs": [ { "name": "event", "title": "Event" }, { "name": "workflow", "title": "Workflow" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [ { "pkid": "5ad5cc7aaffa9343e4d971ae", "version": "0.1.1", "href": "/api/v0/data/HcsWorkflowRegistryDAT/5ad5cc7aaffa9343e4d971a8/?cached=5ad5cc7aaffa9343e4d971ae" } ], "tags": [ "HcsLdapIntegration", "V4UC", "ba_CommonOverlay" ], "title": "title format", "business_key": { "hierarchy": false, "unique": [ "event" ] }, "api_version": "21.2", "cached": true, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "pkid": "5ad5bacbaffa9343e4d93e01", "href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01" } ], "foreign_key": [ { "pkid": "5ad5cc6faffa9343e4d97181", "path": "event", "model_type": "data/HcsWorkflowRegistryEventsDAT" }, { "path": "workflow", "model_type": "data/ProvisioningWorkflow" } ], "self": [ { "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc7aaffa9343e4d971a8/", "pkid": "5ad5cc7aaffa9343e4d971a8" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "5ad5cc7aaffa9343e4d971a8" ], "version_tag": "0.1.1", "schema_version": "2.0", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc7aaffa9343e4d971a8/", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc7aaffa9343e4d971a8/", "support_async": true, "title": "Delete" } }, { "import": { "method": "POST", "class": "import", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc7aaffa9343e4d971a8/import/", "support_async": true, "title": "Import" } }, { "execute": { "method": "POST", "class": "execute", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc7aaffa9343e4d971a8/execute/", "support_async": true, "title": "Execute" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc7aaffa9343e4d971a8/", "support_async": false, "title": "Get" } } ], "summary": "false" }, "pkid": "5ad5cc7aaffa9343e4d971a8" } ] }
(Show the first instance)
{ "data": { "event": "deleteCustomer", "workflow": "HcsRemoveUserManagementLogsPWF", "pkid": "5ad5cc77affa9343e4d9719f" }, "meta": { "model_type": "data/HcsWorkflowRegistryDAT", "summary_attrs": [ { "name": "event", "title": "Event" }, { "name": "workflow", "title": "Workflow" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [ { "pkid": "5ad5cc77affa9343e4d971a0", "version": "0.1.1", "href": "/api/v0/data/HcsWorkflowRegistryDAT/5ad5cc77affa9343e4d9719a/?cached=5ad5cc77affa9343e4d971a0" } ], "tags": [ "HcsLdapIntegration", "V4UC", "ba_CommonOverlay" ], "title": "title format", "business_key": { "hierarchy": false, "unique": [ "event" ] }, "api_version": "21.2", "cached": false, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01", "pkid": "5ad5bacbaffa9343e4d93e01" } ], "foreign_key": [ { "pkid": "5ad5cc72affa9343e4d9718a", "path": "event", "model_type": "data/HcsWorkflowRegistryEventsDAT" }, { "path": "workflow", "model_type": "data/ProvisioningWorkflow" } ], "children": [], "self": [ { "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc77affa9343e4d9719a/", "pkid": "5ad5cc77affa9343e4d9719a" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "5ad5cc77affa9343e4d9719a" ], "version_tag": "0.1.1", "schema_version": "2.0", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc77affa9343e4d9719a/?hierarchy=[hierarchy]", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc77affa9343e4d9719a/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "import": { "method": "POST", "class": "import", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc77affa9343e4d9719a/import/?hierarchy=[hierarchy]", "support_async": true, "title": "Import" } }, { "execute": { "method": "POST", "class": "execute", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc77affa9343e4d9719a/execute/?hierarchy=[hierarchy]", "support_async": true, "title": "Execute" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/HcsWorkflowRegistryDAT/5ad5cc77affa9343e4d9719a/?hierarchy=[hierarchy]", "support_async": false, "title": "Get" } } ] }, "pkid": "5ad5cc77affa9343e4d9719a" }
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]. |