[Index]
AdhocWorkflow data model is used to record extra workflows that can be executed before and/or after any model type operation. When an instance is created an event is created before and after the said model type. This allow us to create extra workflow hooks into any model operation without the need to change existing logic.
Model ref.: data/AdhocWorkflow
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": { "required": true, "type": "string", "description": "A descriptive name identifying the Feature or Functionality that will be executed.", "title": "Name" }, "pre_workflows": { "items": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Active or not.", "title": "Active" }, "scope": { "title": "Workflow search scope", "type": "string", "description": "The search scope to use to find the workflow. If not found the workflow will be ignored.", "choices": [ { "value": "up", "title": "up" }, { "value": "down", "title": "down" }, { "value": "local", "title": "local" } ] }, "workflow": { "type": "string", "description": "Name of the workflow to execute.", "title": "Workflow name" } } }, "type": "array", "description": "List of Pre-process workflows to execute.", "title": "Pre-process Workflows" }, "active": { "default": "(( True ))", "type": "boolean", "description": "Active or not active. The default it true. When false the Events will still be executed but the defined workflows will be ignored.", "title": "Active" }, "model_type": { "description": "The model type to create the Events on.", "title": "Model type", "format": "uri", "required": true, "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "operation": { "required": true, "type": "string", "description": "The operation to create the Events on.", "title": "Operation" }, "post_workflows": { "items": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Active or not.", "title": "Active" }, "scope": { "title": "Workflow search scope", "type": "string", "description": "The search scope to use to find the workflow. If not found the workflow will be ignored.", "choices": [ { "value": "up", "title": "up" }, { "value": "down", "title": "down" }, { "value": "local", "title": "local" } ] }, "workflow": { "type": "string", "description": "Name of the workflow to execute.", "title": "Workflow" } } }, "type": "array", "description": "List of Post-process workflows to execute.", "title": "Post-process Workflows" } }, "schema_version": "0.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/AdhocWorkflow/add/ |
|
The GUI Add form of data/AdhocWorkflow 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/AdhocWorkflow/ | 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/AdhocWorkflow/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/AdhocWorkflow/[pkid1]", "/api/data/AdhocWorkflow/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/AdhocWorkflow/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=data/AdhocWorkflow |
|
{"hrefs": ["/api/data/AdhocWorkflow/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=data/AdhocWorkflow |
|
{"hrefs": ["/api/data/AdhocWorkflow/[pkid1]", "/api/data/AdhocWorkflow/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/AdhocWorkflow; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/AdhocWorkflow/export/ |
|
{ "hrefs":["/api/data/AdhocWorkflow/[pkid1]", "/api/data/AdhocWorkflow/[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 data/AdhocWorkflow and the JSON format can be used to import instances of data/AdhocWorkflow.
GET http://[host-proxy]/api/data/AdhocWorkflow/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/data/AdhocWorkflow/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/AdhocWorkflow/ |
|
The data/AdhocWorkflow schema and all instances as JSON. |
(The list will return 0 to 3 data/AdhocWorkflow instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "list", "update", "remove", "move", "transform", "add", "export", "migration", "bulk_update_form" ], "pagination": { "direction": "asc", "order_by": "name", "maximum_limit": 2000, "skip": 0, "current": "/api/data/AdhocWorkflow/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "? - ? - ?", "business_key": { "hierarchy": true, "unique": [ "name", "model_type", "operation" ] }, "schema_version": "0.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/AdhocWorkflow/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/AdhocWorkflow/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=data/AdhocWorkflow", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/AdhocWorkflow/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/AdhocWorkflow/+tag/?hierarchy=[hierarchy]", "class": "tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "title": "Tag Version", "support_async": true, "method": "PATCH", "href": "/api/data/AdhocWorkflow/+tag_version/?hierarchy=[hierarchy]", "class": "tag_version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/data/AdhocWorkflow/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "list": { "support_async": false, "class": "list", "href": "/api/data/AdhocWorkflow/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/AdhocWorkflow/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/AdhocWorkflow", "model_specific_actions": [ "add", "clone", "export", "get", "help", "import", "list", "remove", "tag", "tag_version", "update", "configuration_template", "move" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "model_type", "title": "Model type" }, { "name": "operation", "title": "Operation" }, { "name": "active", "title": "Active" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/AdhocWorkflow. | GET | /api/data/AdhocWorkflow/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/AdhocWorkflow as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/AdhocWorkflow/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/AdhocWorkflow/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/AdhocWorkflow/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/AdhocWorkflow/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=data/AdhocWorkflow | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Import | POST | /api/data/AdhocWorkflow/[pkid]/import/ | 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 data/AdhocWorkflow; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/AdhocWorkflow/[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 data/AdhocWorkflow and the JSON format can be used to import instances of data/AdhocWorkflow.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/data/AdhocWorkflow/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/AdhocWorkflow/[pkid]/ | hierarchy=[hierarchy] | The data/AdhocWorkflow instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/AdhocWorkflow/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/AdhocWorkflow. |