 |
Qorus Integration Engine® Enterprise Edition 6.0.27_prod
|
|
Qorus Integration Engine® Enterprise Edition 6.0.27_prod
|
This URI path always provides access to the latest REST API; in this case it is identical to /api/v7
To ensure that a specific REST API version is used; use the URI path prefix with a specific API version in it instead.
This REST URI path provides qorus metrics
TODO: the todo partThis REST URI path provides actions and information about queues for asynchronous workflow steps
queueid: the queue IDname: the queue nameserviceid: optional: a related service id if presentThis REST URI path provides actions and information about queues for asynchronous workflow steps
queueid: the queue IDname: the queue nameserviceid: optional: a related service id if presentkey the key to the entry in the given queue to cancel| UNKNOWN-QUEUE | invalid queue name |
| INVALID-KEY | no entry exists in the given queue with the given key value |
| INVALID-STATUS | queue entry does not have status OMQ::QS_Waiting |
| WORKFLOW-ACCESS-ERROR | this is exeption is thrown when RBAC is enabled, and the call is made externally, and the user does not have the right to access the given workflow |
key the key to the entryworkflow_instanceid: the workflow instance ID of the step and queue entrystepid: the step ID of the step and queue entryind: the array index of the step and queue entry (0 for non-array steps)queuekey: the queue key stringqueue_data_status: the status of the queue entry: OMQ::QS_Waiting, OMQ::QS_Received, OMQ::QS_Used (Oracle only), or OMQ::QS_Error (rarely, in case of unparsable queue data)corrected: if 1, then the queue entry has been corrected. meaning that the back-end function will not be executed and the step will automatically get a OMQ::StatComplete status.data: the queue data, if any, set only when the queue data status is OMQ::QS_Received404 Not Found: the given key does not exist409 Conflict: UNKNOWN-QUEUE invalid queue name409 Conflict: WORKFLOW-ACCESS-ERROR this is exeption is thrown when RBAC is enabled, and the call is made externally, and the user does not have the right to access the given workflowoldkey the old key namenewkey the new key name| UNKNOWN-QUEUE | invalid queue name |
| UPDATE-KEY-ERROR | empty string passed for oldkey or newkey |
| QUEUE-KEY-UPDATE-ERROR | no queue entry; queue entry does not have status OMQ::QS_Waiting |
| WORKFLOW-ACCESS-ERROR | this is exeption is thrown when RBAC is enabled, and the call is made externally, and the user does not have the right to access the given workflow |
status: a single SQL status value; see OMQ::SQL_QS_ALL and OMQ::QS_ALL for valid values (takes both short and long status codes); default all statuses except "USED" are returneduser: the username to search foruser_interaction_locked: 1 or 0 for the user interaction locked statuslimit: the maximum number of entries to return; default 100offset: the offset to return; default 0queuekey: (string) the key namequeue_data_status: (string) queue entry status:workflow_instanceid: (int) the workflow instance ID of the queue recordstepid: (int) the step ID of the queue recordind: (int) the step index of the queue recorduser_interaction_locked: (bool) True if locked, False if notuser_interaction_user: (string) current user with owning the lock on the queue record, if setuser_interaction_modified: (date) the timestamp the user_interaction_user was last updated, if setcreated: (date) created timestamp for the queue entrymodified: (date) modified timestamp for the queue entry| GET-QUEUE-INFO-ERROR | queueid is invalid |
| INVALID-STATUS | status is invalid |
"USED" status are only returned if the status argument is "USED" (OMQ::QS_Used) or "X" (OMQ::SQL_QS_Used)The queue summary hash has the following structure. Key values are strings with the following format: "<workflow name>/<workflow version>" with queue status subkeys and with integer values corresponding to the number of workflows that have queue entries with the given statuses.
| UNKNOWN-QUEUE | invalid queue name |
key (string): value of the key in the given queuedata (auto): data to post in the queue entry; this data will be passed to the back end function for evaluation"OK" 400 Bad Request: invalid argument, invalid status in queue entry403 Forbidden: access or authorization error404 Not Found: unknown queue or queue keyThis REST API path provides actions and information about Qorus class objects
list: optional; parsed with Qore::parse_boolean(); if True then a list of class names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings with class names, versions, and IDs is returnedtags: optional; a hash of tags to match; only workflows matching at least one of the tags will be returned; use tag=value format as the value of this optiontag_case_insensitive: optional; parsed with Qore::parse_boolean(); if True then tag value comparisons are made with case-insensitive comparisonstag_partial_match: optional; parsed with Qore::parse_boolean(); if True then tag value comparisons succeed if the value given as the tag value appears anywhere in the object's tag of the same namelist nor short options are passed as above):classid: the class IDname: the name of the classversion: the version of the classdescription: the description of the class objectauthor: the author of the class objectcreated: the date/time the class object was createdmodified: the date/time the class object was modifiedsource: the source file that the class object was created fromline: the offset in the source file for the source of the class objectedit_lock: the connection ID of the connection holding the edit lock, if anyThis REST API path provides actions and information about specific class objects
400 Bad Request: returned if the request has invalid arguments403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationname: the name of the class objectversion: the version of the class objectclassid: the class object IDdescription: the description of the classauthor: the author of the classbody: the source code for the class objectcreated: the date/time the class was createdmodified: the date/time the class was modifiedcreatedby: (deprecated) always "omq" modifiedby: (deprecated) always "omq" tags: any user-defined tags on the class objectsource: the source file that the class object was created fromoffset: the offset in the source file for the source of the class objecthost: the hostname of the machine where the class object was loaded fromuser: the OS user who loaded the class objectThis URI path provides API support for Qorus remote code deployments
args: (optional) command-line argumentscmd: (required) the command to execute (ex: oload); if the user does not have the REMOTE-EXEC-ALL permission, this argument must be one of the following values:make-release ocmd ojview oload oprop ostart ostatus ostop oview qdp qrest saprest schema-reverse schema-tool sfrest soaputil sqlutil dir: (required for make-release and oload)files: (required) a list of files for the oload command400 Bad Request: missing or invalid option403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation500 Internal Server Error: returned if there is an error executing the command$OMQ_DIR/bin and not in the whitelist documented hereThis REST URI path provides actions and information about remote Qorus, user and datasource connections
"qorus", user connections under "user", and datasource connections under "datasources")list: optional; parsed with Qore::parse_boolean(); if True then a list of connection names is returnedmonitored: optional; (remote and user connections only) parsed with Qore::parse_boolean(); if True then only monitored connections are returnedremote: optional; (remote connections) parsed with Qore::parse_boolean(); if True then no loopback connections are returned; default if not present: Falsertime: optional; (datasource connections only) parsed with Qore::parse_boolean(); if True then the following attributes are returned as relative date/time values:"warning-timeout" "error-timeout" "pool-wait-max" short: optional; parsed with Qore::parse_boolean(); if True then a list of short strings with connection names and brief info is returnedwith_passwords: (datasource connections only) parsed with Qore::parse_boolean(); if True then the pass key is returned in the REST Datasource Connection Hash return value and then the calling user must have one of the following permissions:
"conntype" value determines the hash format as follows:"DATASOURCE": a REST Datasource Connection Hash"REMOTE" or "USER-CONNECTION": a REST User and Remote Connection Hash (v7)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationwith_passwords option is usedname: (required string) the name of the user connectiondesc: (required string) the description for the new user connectionurl: (required string) the URL for the new user connectionoptions: (optional hash) a hash of options for the user connection (also "opts" is accepted as an alias for "options")info: a string confirming the connection creation403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation409 Conflict: CONNECTION-ERROR: connection already exists; unknown scheme in URL409 Conflict: DATASOURCE-CONNECTION-ERROR: missing or invalid name, desc, url, options arguments - or name and Datasource Hash members409 Conflict: REMOTE-CONNECTION-ERROR: missing or invalid name, desc, url, or options arguments409 Conflict: USER-CONNECTION-ERROR: missing or invalid name, desc, url, or options argumentsThis REST URI path provides actions and information related to a specific connection, which may be:
info (string): a string providing information about the connection update action403 Forbidden: access or authorization errorwith_password (*bool): include the password in the "url" and "url_hash" keystype (string): the connection type ("datasource", "rest", "soap", etc)name (string): the name of the connectionup (bool): a boolean indicating if the connection was monitored to be up or notconnectionid (int): the unique connection IDconntype (string): either "DATASOURCE", "REMOTE", or "USER-CONNECTION" description (string): a description of the connectionurl (string): the URL to the remote hostmonitor (bool): a boolean indicating if the connection is monitored or notlast_check (*date): the date/time value the connection was last checked (loopback remote connections are not checked)updated (*date): the date/time the connection was last updatedstatus (string): \ "OK", "not checked", or an error messageloopback (*bool): (only for remote connections) indicates if the connection is a loopback connectionurl_hash (UndefinedHash): a hash of broken-down URL componentsenabled (bool): indicates if the connecton is enabled or notlocked (*bool): indicates if the connection can be edited or not (only the system schema connection is locked and cannot be edited)debug_data (*bool): if data debugging is enabled for the connectiontags (*UndefinedHash): any tags for the connectionhas_provider (bool): if the connection supports a data providerchildren_can_support_apis (bool): if the data provider or any children support APIschildren_can_support_records (bool): if the data provider or any children support recordschildren_can_support_observers (bool): if the data provider or any children support event observationchildren_can_support_messages (bool): if the data provider or any children support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementopts (*UndefinedHash): a hash of options for the connectionfeatures (*list<string>): a list of connection-specific features supported by the connectionauth_request_uri (*string): a URI to make OAuth2 authorization code grant requests, if supported by the connectioncoord-mode (*bool): if coordinated mode is enabled (datasources only)safe_url (*string): a URL string without any password informationshared-pool (*string): summary information about the DatasourcePool object backing a datasource connectionwarning-timeout (*int): datasource warning timeout in millisecondserror-timeout (*int): datasources error timeout in millisecondspool-wait-max (*int): (datasources only) the maximum wait time for a pool connection to become available in millisecondspool-reqs (*int): (datasources only) the number of connection requests on the poolpool-hits (*int): (datasources only) the number of connection requests that could be served immediately without blockingpool-miss (*int): (datasources only) the number of connection requests that could be served only after blockingpool-hit-pct (*float): the percentage of hits to missesdeps (*list<ConnectionDependencyInfo>): a list of dependent interfacesalerts (*list<AlertInfo>): a list of alerts raised against the connectionhealth (*string): (remote Qorus connections only) a string giving the health color code of the instanceinstance-key (*string): (remote Qorus connections only) the Qorus instance key of the remote instanceomq-version (*string): (remote Qorus connections only) the Qorus versionalert-summary (*SystemAlertInfo): summary of alert infoerror (*string): (remote Qorus connections only) any error summary string for the remote instancedesc (*string): a new description for the connectionurl (*string): a new URL for the connectionoptions (*UndefinedHash): new options for the connectiontags (*UndefinedHash): new tags for the connectioninfo (string): a string providing information about the connection update action403 Forbidden: access or authorization error409 Conflict: error executing the changeinfo (string): a string providing information about the connection update action403 Forbidden: access or authorization errorinfo (string): a string providing information about the connection update action403 Forbidden: access or authorization errorinfo (string): a string providing information about the connection update action403 Forbidden: access or authorization errorinfo (string): a string providing information about the connection update action403 Forbidden: access or authorization errorok (bool): the status of the pingname (string): the name of the connectiondesc (string): the description of the connectionurl (string): the URL for the connectionopts (UndefinedHash): a hash of options for the connection (if any)time (date): the elapsed time for the pinginfo (string): "OK" if the ping was successful or an error message if notresult (string): a string representation of the time in seconds (ex: "0.25s")This URI path provides access to a data provider created from a Qorus connection
where_cond: search parameters for records to be deletedsearch_options: search options400 Bad Request: returned if the request has no where_cond key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationname (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messagesevents (*UndefinedHash): any events supported by the data providermessages (*UndefinedHash): any messages supported by the data providersearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<string>): a list of any data provider childrenchildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementcontext (*list<string>): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeprovider_options (*UndefinedHash): any options to be passed to a factory creation method when accessing this URI endpoint through a factoryname (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messagesevents (*UndefinedHash): any events supported by the data providermessages (*UndefinedHash): any messages supported by the data providersearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<string>): a list of any data provider childrenchildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementcontext (*list<string>): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typesoft (*bool): soft types are returnedprovider_options (*UndefinedHash): a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor optionscontext (*list<string>): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrencontext (*list<string>): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrenrecord: (required) the set of fields making up the new recordcreate_options: any create options supported by the data provider"OK" 400 Bad Request: returned if the request has no record key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationrequest_options: request options403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationwhere_cond: search parameterssearch_options: search options403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationstream: (required) the name of the stream to open; must be either:insert: for an insert streamupsert: for an upsert streamupsert_options: any upsert options supported by the data provider (upsert stream only)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationwhere_cond: search parametersblock_size: number of rows in each block (default = 1000)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationset: (required) set of fields matching where_conf to updatewhere_cond: (required) search parameterssearch_options: search options400 Bad Request: returned if the request has no set or where_cond keys403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationrecord: (required) the set of fields making up the new recordupsert_options: any upsert options supported by the data provider400 Bad Request: returned if the request has no record key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationThis URI path provides access information for a particular data request data type
This URI path provides record information for a data provider
provider_options: the options to be passed to the factory creation method to create the providersoft: optional; parsed with Qore::parse_boolean(); if True then the type is returned with soft types to be used as the target for a mappersoft: optional; parsed with Qore::parse_boolean(); if True then the type is returned with soft types to be used as the target for a mapperThis REST API path provides actions and information about Qorus constant objects
list: optional; parsed with Qore::parse_boolean(); if True then a list of constant names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings with constant names, versions, and IDs is returnedlist nor short options are passed as above):constantid: the constant IDname: the name of the constantversion: the version of the constantdescription: the description of the constant objectauthor: the author of the constant objectcreated: the date/time the constant object was createdmodified: the date/time the constant object was modifiedsource: the source file that the constant object was created fromline: the offset in the source file for source of the constant objectThis REST API path provides actions and information about specific constant objects
name: the name of the constant objectversion: the version of the constant objectconstantid: the constant object IDdescription: the description of the constant objectauthor: the author of the constant objectbody: the source code for the class objectcreated: the date/time the constant object was createdmodified: the date/time the constant object was modifiedcreatedby: (deprecated) always "omq" modifiedby: (deprecated) always "omq" tags: any user-defined tags on the constant objectsource: the source file that the constant object was created fromoffset: the offset in the source file for the source of constant objecthost: the hostname of the machine where the constant object was loaded fromuser: the OS user who loaded the constant objectThis REST URI path provides actions and information for the base path of the creator API
This REST URI path provides actions and information for classes in the creator API
code: (string; required) the source code for the class; must be a non-empty stringid: (int; optional) if present, must be the new class ID from a reservation callmetadata: (hash; required) the metadata for the new classtype: (string; optional) if present must be "class" tab_token: (string; required if there is a name reservation or if lock is true) the WS connection ID holding a name reservation for the new class namecid: (int; required if the lock key is set) the unique connection IDlock: (bool; optional) lock the record after creating (in which case cid and tab_token must also be passed)id: (int) the class ID for the class created400 Bad Request: returned if the request has invalid arguments403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationtype: (string) class id: (int) the class ID reservedfields: (hash) field description for a new class403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationThis REST URI path provides actions and information for a specific class in the creator API
400 Bad Request: returned if the request has invalid arguments403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationcode: (string) the source code for the classmetadata: (hash) the metadata of the class to updatetab_token: (string; required if there is a name reservation) the WS connection ID holding a name reservation for the new class nameid: (int) the class ID updated400 Bad Request: returned if the request has invalid arguments403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationcid: (int) the unique connection IDtab_token: (string) the unique connection ID for the tab subchannellocked: (bool) True or Falseinfo: (hash) only included if the lock failsintent: warning content: msg explaining that the object is already locked400 Bad Request: returned if the request has invalid arguments403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationcid: (int) the unique connection IDtab_token: (string) the unique connection ID for the tab subchannellocked: (bool) True or Falseinfo: (hash) only included if the lock failsintent: warning content: msg explaining that the object is already locked400 Bad Request: returned if the request has invalid arguments403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationThis REST URI path provides actions and information for config items in the creator API
This REST URI path provides actions and information for connections in the creator API
"qorus", user connections under "user", and datasource connections under "datasources")list: optional; parsed with Qore::parse_boolean(); if True then a list of connection names is returnedmonitored: optional; (remote and user connections only) parsed with Qore::parse_boolean(); if True then only monitored connections are returnedremote: optional; (remote connections) parsed with Qore::parse_boolean(); if True then no loopback connections are returned; default if not present: Falsertime: optional; (datasource connections only) parsed with Qore::parse_boolean(); if True then the following attributes are returned as relative date/time values:"warning-timeout" "error-timeout" "pool-wait-max" short: optional; parsed with Qore::parse_boolean(); if True then a list of short strings with connection names and brief info is returnedwith_passwords: (datasource connections only) parsed with Qore::parse_boolean(); if True then the pass key is returned in the REST Datasource Connection Hash return value and then the calling user must have one of the following permissions:
"conntype" value determines the hash format as follows:"DATASOURCE": a REST Datasource Connection Hash"REMOTE" or "USER-CONNECTION": a REST User and Remote Connection Hash403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationwith_passwords option is usedmetadata: (hash; required) the metadata for the new connectiontype: (string; optional) if present must be "connection" tab_token: (string; required if there is a name reservation or if lock is true) the WS connection ID holding a name reservation for the new connection namecid: (int; required if the lock key is set) the unique connection IDlock: (bool; optional) lock the record after creating (in which case cid and tab_token must also be passed)id: (int) the ID of the connection created400 Bad Request: returned if the request has invalid arguments403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationThis REST URI path provides actions and information for a specific connection in the creator API
400 Bad Request: returned if the request has invalid arguments403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationmetadata: (hash) the metadata of the connection to updatetab_token: (string; required if there is a name reservation) the WS connection ID holding a name reservation for the new connection nameid: (int) the connection ID updated400 Bad Request: returned if the request has invalid arguments403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationcid: (int) the unique WebSocket connection IDtab_token: (string) the unique connection ID for the tab subchannellocked: (bool) True or Falseinfo: (hash) only included if the lock failsintent: warning content: msg explaining that the object is already locked400 Bad Request: returned if the request has invalid arguments403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationcid: (int) the unique connection IDtab_token: (string) the unique connection ID for the tab subchannellocked: (bool) True or Falseinfo: (hash) only included if the lock failsintent: warning content: msg explaining that the object is already locked400 Bad Request: returned if the request has invalid arguments403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationThis REST URI path provides actions and information for jobs in the creator API
code: (string; required) the source code for the job; must be a non-empty stringid: (int; optional) if present, must be the new job ID from a reservation callmetadata: (hash; required) the metadata for the new jobtype: (string; optional) if present must be "job" tab_token: (string; required if there is a name reservation or if lock is true) the WS connection ID holding a name reservation for the new job namecid: (int; required if the lock key is set) the unique connection IDlock: (bool; optional) lock the record after creating (in which case cid and tab_token must also be passed)id: (int) the job ID for the job created400 Bad Request: returned if the request has invalid arguments403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationtype: (string) job id: (int) the job ID reservedfields: (hash) field description for a new job403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationThis REST URI path provides actions and information for a specific job in the creator API
400 Bad Request: returned if the request has invalid arguments403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationcode: (string) the source code for the jobmetadata: (hash) the metadata of the job to updatetab_token: (string; required if there is a name reservation) the WS connection ID holding a name reservation for the new job nameid: (int) the job ID updated400 Bad Request: returned if the request has invalid arguments403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationcid: (int) the unique connection IDtab_token: (string) the unique connection ID for the tab subchannellocked: (bool) True or Falseinfo: (hash) only included if the lock failsintent: warning content: msg explaining that the object is already locked400 Bad Request: returned if the request has invalid arguments403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationcid: (int) the unique connection IDtab_token: (string) the unique connection ID for the tab subchannellocked: (bool) True or Falseinfo: (hash) only included if the lock failsintent: warning content: msg explaining that the object is already locked400 Bad Request: returned if the request has invalid arguments403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationThis REST URI path provides actions and information for services in the creator API
type: (string) service id: (int) the service ID reservedfields: (hash) field description for a new service403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationThis REST URI path provides actions and information for a specific service in the creator API
This URI path provides access to data provider functionality
type (string): the type of path: factory, connection, datasource, or remote name (string): the initial segment of the data provider pathpath (*string): the path to the data provideroptions (*UndefinedHash): factory constructor options; invalid options are silently ignoredargs (auto): any arguments to the API call; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local contextcontext (*UndefinedHash): any context data to be used to resolve argumentsrequest_options (*UndefinedHash): any request options400 Bad Request: missing or invalid required argumentstype (string): the type of path: factory, connection, datasource, or remote name (string): the initial segment of the data provider pathpath (*string): the path to the data provideroptions (*UndefinedUiHash): factory constructor options; invalid options are silently ignoredtype (string): the expected type of the argumentvalue (auto): the value of the argument, for values that cannot be serialized as JSON, this will be a string in YAML formatargs (auto): any arguments to the API call; if this argument is a hash, then each hash key must be assigned a hash value with type and value keys, additionally, if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local contextcontext (*UndefinedHash): any context data to be used to resolve argumentsrequest_options (*UndefinedUiHash): any request optionstype (string): the expected type of the argumentvalue (auto): the value of the argument, for values that cannot be serialized as JSON, this will be a string in YAML format400 Bad Request: missing or invalid required argumentstypes giving type and base_type information to compare and returns a list of the results of each comparison.types (QorusTypeComparisonSetInfo): a hash of hashes keyed by a unique user-defined comparison identifierbase_type (QorusTypeInfo): hash describing the input or receiving type (type of variable to accept type)type (string): one of connection, datasource, factory, remote, or type name (string): the name of the type, connection, factory, etcpath (*string): the path to the final objectsubtype (*string): the subtype for type = connection options (*hash<auto>): create option for type = factory hasApiContext (*bool): True if the type is a factory with options to be handled in an APItype (QorusTypeInfo): a hash describing the output or sending type (type of value to be assigned to base_type)type (string): one of connection, datasource, factory, remote, or type name (string): the name of the type, connection, factory, etcpath (*string): the path to the final objectsubtype (*string): the subtype for type = connection options (*hash<auto>): create option for type = factory hasApiContext (*bool): True if the type is a factory with options to be handled in an APItypes argument where the values are boolean values of the results of the type comparisons400 Bad Request: missing or invalid types argument; non-unique name in types list404 Not Found: the given type, factory, connection, etc cannot be foundbase_type (QorusTypeInfo): hash describing the input or receiving type (type of variable to accept type)type (string): one of connection, datasource, factory, remote, or type name (string): the name of the type, connection, factory, etcpath (*string): the path to the final objectsubtype (*string): the subtype for type = connection options (*hash<auto>): create option for type = factory hasApiContext (*bool): True if the type is a factory with options to be handled in an APItype (QorusTypeInfo): a hash describing the output or sending type (type of value to be assigned to base_type)type (string): one of connection, datasource, factory, remote, or type name (string): the name of the type, connection, factory, etcpath (*string): the path to the final objectsubtype (*string): the subtype for type = connection options (*hash<auto>): create option for type = factory hasApiContext (*bool): True if the type is a factory with options to be handled in an API400 Bad Request: missing or invalid types argument; non-unique name in types list404 Not Found: the given type, factory, connection, etc cannot be foundtype (string): the type of path: factory, connection, datasource, or remote name (string): the initial segment of the data provider pathpath (*string): the path to the data provideroptions (*UndefinedHash): factory constructor options; invalid options are silently ignoredrecords (list<UndefinedHash>): the list of new records; each hash in the list represents a new record and must have keys that correspond to valid field names, values are subjected to template resolution by calls to UserApi::expandTemplatedValue() with context as the local contextcontext (*UndefinedHash): any context data to be used to resolve the where argument400 Bad Request: missing or invalid required argumentstype (string): the type of path: factory, connection, datasource, or remote name (string): the initial segment of the data provider pathpath (*string): the path to the data provideroptions (*UndefinedUiHash): factory constructor options; invalid options are silently ignoredtype (string): the expected type of the argumentvalue (auto): the value of the argument, for values that cannot be serialized as JSON, this will be a string in YAML formatrecords (list<UndefinedUiHash>): the list of new records; each hash in the list represents a new record and must have keys that correspond to valid field names, values are subjected to template resolution by calls to UserApi::expandTemplatedValue() with context as the local contextcontext (*UndefinedHash): any context data to be used to resolve the where argument400 Bad Request: missing or invalid required argumentstype (string): the type of path: factory, connection, datasource, or remote name (string): the initial segment of the data provider pathpath (*string): the path to the data provideroptions (*UndefinedHash): factory constructor options; invalid options are silently ignoredwhere (*UndefinedHash): the search criteria for the search where keys are field names and values are either values to be matched or a hash describing a comparison operator for the column with op and value keys; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local contextcontext (*UndefinedHash): any context data to be used to resolve the where argumentsearch_options (*UndefinedHash): any search optionsaffected_records (int): the number of records affected by the operation400 Bad Request: missing or invalid required argumentstype (string): the type of path: factory, connection, datasource, or remote name (string): the initial segment of the data provider pathpath (*string): the path to the data provideroptions (*UndefinedUiHash): factory constructor options; invalid options are silently ignoredtype (string): the expected type of the argumentvalue (auto): the value of the argument, for values that cannot be serialized as JSON, this will be a string in YAML formatwhere (*UndefinedHash): the search criteria for the search where keys are field names and values are either values to be matched or a hash describing a comparison operator for the column with op and value keys; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local contextcontext (*UndefinedHash): any context data to be used to resolve the where argumentsearch_options (*UndefinedUiHash): any search optionstype (string): the expected type of the argumentvalue (auto): the value of the argument, for values that cannot be serialized as JSON, this will be a string in YAML formataffected_records (int): the number of records affected by the operation400 Bad Request: missing or invalid required argumentstype (string): the type of path: factory, connection, datasource, or remote name (string): the initial segment of the data provider pathpath (*string): the path to the data provideroptions (*UndefinedHash): factory constructor options; invalid options are silently ignoredwhere (*UndefinedHash): the search criteria for the search where keys are field names and values are either values to be matched or a hash describing a comparison operator for the column with op and value keys; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local contextcontext (*UndefinedHash): any context data to be used to resolve the where argumentsearch_options (*UndefinedHash): any search options400 Bad Request: missing or invalid required argumentstype (string): the type of path: factory, connection, datasource, or remote name (string): the initial segment of the data provider pathpath (*string): the path to the data provideroptions (*UndefinedUiHash): factory constructor options; invalid options are silently ignoredtype (string): the expected type of the argumentvalue (auto): the value of the argument, for values that cannot be serialized as JSON, this will be a string in YAML formatwhere (*UndefinedHash): the search criteria for the search where keys are field names and values are either values to be matched or a hash describing a comparison operator for the column with op and value keys; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local contextcontext (*UndefinedHash): any context data to be used to resolve the where argumentsearch_options (*UndefinedUiHash): any search optionstype (string): the expected type of the argumentvalue (auto): the value of the argument, for values that cannot be serialized as JSON, this will be a string in YAML format400 Bad Request: missing or invalid required argumentstype (string): the type of path: factory, connection, datasource, or remote name (string): the initial segment of the data provider pathpath (*string): the path to the data provideroptions (*UndefinedHash): factory constructor options; invalid options are silently ignoredwhere (UndefinedHash): the search criteria for the search where keys are field names and values are either values to be matched or a hash describing a comparison operator for the column; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local contextcontext (*UndefinedHash): any context data to be used to resolve the where argumentsearch_options (*UndefinedHash): any search options400 Bad Request: missing or invalid required arguments or if multiple records match the search criteriatype (string): the type of path: factory, connection, datasource, or remote name (string): the initial segment of the data provider pathpath (*string): the path to the data provideroptions (*UndefinedUiHash): factory constructor options; invalid options are silently ignoredtype (string): the expected type of the argumentvalue (auto): the value of the argument, for values that cannot be serialized as JSON, this will be a string in YAML formatwhere (UndefinedUiHash): the search criteria for the search where keys are field names and values are either values to be matched or a hash describing a comparison operator for the column; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local contexttype (string): the expected type of the argumentvalue (auto): the value of the argument, for values that cannot be serialized as JSON, this will be a string in YAML formatcontext (*UndefinedHash): any context data to be used to resolve the where argumentsearch_options (*UndefinedUiHash): any search optionstype (string): the expected type of the argumentvalue (auto): the value of the argument, for values that cannot be serialized as JSON, this will be a string in YAML format400 Bad Request: missing or invalid required arguments or if multiple records match the search criteriatype (string): the type of path: factory, connection, datasource, or remote name (string): the initial segment of the data provider pathpath (*string): the path to the data provideroptions (*UndefinedHash): factory constructor options; invalid options are silently ignoredmessage_id (string): the ID of the message to send; must be a message supported by the data providermessage (auto): the message body; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local contextcontext (*UndefinedHash): any context data to be used to resolve argumentsmessage_options (*UndefinedHash): any message optionsOK 400 Bad Request: missing or invalid message ID or message bodytype (string): the type of path: factory, connection, datasource, or remote name (string): the initial segment of the data provider pathpath (*string): the path to the data provideroptions (*UndefinedUiHash): factory constructor options; invalid options are silently ignoredtype (string): the expected type of the argumentvalue (auto): the value of the argument, for values that cannot be serialized as JSON, this will be a string in YAML formatmessage_id (string): the ID of the message to send; must be a message supported by the data providermessage (auto): the message body; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local contextcontext (*UndefinedHash): any context data to be used to resolve argumentsmessage_options (*UndefinedHash): any message optionsOK 400 Bad Request: missing or invalid message ID or message bodysoft (*bool): if a "soft" type should be returnedtype (QorusTypeInfo): hash describing the input or receiving type (type of variable to accept type)type (string): one of connection, datasource, factory, remote, or type name (string): the name of the type, connection, factory, etcpath (*string): the path to the final objectsubtype (*string): the subtype for type = connection options (*hash<auto>): create option for type = factory hasApiContext (*bool): True if the type is a factory with options to be handled in an APIname (string): the type namedesc (string): the description of the typesupported_options (*UndefinedHash): transformation options supported by the typeoptions (*UndefinedHash): transformation option valuesbase_type (string): the Qore base type namemandatory (bool): can be null / missing?types_accepted (list<string>): list of types accepted on inputtypes_returned (list<string>): list of types returnedfields (*UndefinedHash): fields supported by the typecan_manage_fields (bool): True if fiputTypeelds can be added dynamically to the typetags (*UndefinedHash): any tags set on the typeor_nothing_type (bool): if True, the type will accept NOTHINGtype (string): the type of path: factory, connection, datasource, or remote name (string): the initial segment of the data provider pathpath (*string): the path to the data provideroptions (*UndefinedHash): factory constructor options; invalid options are silently ignoredset (UndefinedHash): keys are field names and values are field values to be updated; values will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local contextwhere (*UndefinedHash): the search criteria for the search where keys are field names and values are either values to be matched or a hash describing a comparison operator for the column with op and value keys; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local contextcontext (*UndefinedHash): any context data to be used to resolve the where argumentsearch_options (*UndefinedHash): any search optionsaffected_records (int): the number of records affected by the operation400 Bad Request: missing or invalid required argumentstype (string): the type of path: factory, connection, datasource, or remote name (string): the initial segment of the data provider pathpath (*string): the path to the data provideroptions (*UndefinedUiHash): factory constructor options; invalid options are silently ignoredtype (string): the expected type of the argumentvalue (auto): the value of the argument, for values that cannot be serialized as JSON, this will be a string in YAML formatset (UndefinedUiHash): keys are field names and values are field values to be updated; values will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local contexttype (string): the expected type of the argumentvalue (auto): the value of the argument, for values that cannot be serialized as JSON, this will be a string in YAML formatwhere (UndefinedUiHash): the search criteria for the search where keys are field names and values are either values to be matched or a hash describing a comparison operator for the column; if present this will be resolved as a template with a call to UserApi::expandTemplatedValue() with context as the local contexttype (string): the expected type of the argumentvalue (auto): the value of the argument, for values that cannot be serialized as JSON, this will be a string in YAML formatcontext (*UndefinedHash): any context data to be used to resolve the where argumentsearch_options (*UndefinedUiHash): any search optionstype (string): the expected type of the argumentvalue (auto): the value of the argument, for values that cannot be serialized as JSON, this will be a string in YAML formataffected_records (int): the number of records affected by the operation400 Bad Request: missing or invalid required argumentsThis URI path provides access to base data type information
list: optional; parsed with Qore::parse_boolean(); if True then a list of type names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings of type information is returnedsoft: optional; parsed with Qore::parse_boolean(); if True then the type is returned with soft types to be used as the target for a mapperThis URI path provides access to base data type information for a specific type
This URI path provides access information for a particular data type
soft: optional; parsed with Qore::parse_boolean(); if True then the type is returned with soft types to be used as the target for a mapperThis URI path provides the root URI for browsing for types and data providers
context (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typetype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typetype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the nodecontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the nodeThis URI path provides the root URI for browsing data providers from user connections
context (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typetype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typetype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the nodecontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the nodeThis URI path provides the root URI for browsing a data provider created from a user connection
context (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typetype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeprovider_options (*UndefinedHash): a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor optionstype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrencontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeprovider_options (*UndefinedHash): a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor optionsname (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrenwhere_cond: search parameters for records to be deletedsearch_options: search options400 Bad Request: returned if the request has no where_cond key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrencontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeprovider_options (*UndefinedHash): any options to be passed to a factory creation method when accessing this URI endpoint through a factoryname (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messagesevents (*UndefinedHash): any events supported by the data providermessages (*UndefinedHash): any messages supported by the data providersearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<string>): a list of any data provider childrenchildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typesoft (*bool): soft types are returnedprovider_options (*UndefinedHash): a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor optionscontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeprovider_options (*UndefinedHash): a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor optionsname (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrencontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrenrecord: (required) the set of fields making up the new recordcreate_options: any create options supported by the data provider"OK" 400 Bad Request: returned if the request has no record key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationrequest_options: request options403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationwhere_cond: search parameterssearch_options: search options403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationstream: (required) the name of the stream to open; must be either:insert: for an insert streamupsert: for an upsert streamupsert_options: any upsert options supported by the data provider (upsert stream only)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationwhere_cond: search parametersblock_size: number of rows in each block (default = 1000)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationset: (required) set of fields matching where_conf to updatewhere_cond: (required) search parameterssearch_options: search options400 Bad Request: returned if the request has no set or where_cond keys403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationrecord: (required) the set of fields making up the new recordupsert_options: any upsert options supported by the data provider400 Bad Request: returned if the request has no record key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationThis URI path provides access information for a particular data request data type
This URI path provides record information for a data provider
provider_options: the options to be passed to the factory creation method to create the providersoft: optional; parsed with Qore::parse_boolean(); if True then the type is returned with soft types to be used as the target for a mappersoft: optional; parsed with Qore::parse_boolean(); if True then the type is returned with soft types to be used as the target for a mapperThis URI path provides the root URI for browsing data providers from datasources
context (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typetype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typetype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the nodecontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the nodeThis URI path provides the root URI for browsing a data provider created from datasources
context (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typetype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeprovider_options (*UndefinedHash): a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor optionstype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrencontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeprovider_options (*UndefinedHash): a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor optionsname (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrenwhere_cond: search parameters for records to be deletedsearch_options: search options400 Bad Request: returned if the request has no where_cond key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrencontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeprovider_options (*UndefinedHash): any options to be passed to a factory creation method when accessing this URI endpoint through a factoryname (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messagesevents (*UndefinedHash): any events supported by the data providermessages (*UndefinedHash): any messages supported by the data providersearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<string>): a list of any data provider childrenchildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typesoft (*bool): soft types are returnedprovider_options (*UndefinedHash): a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor optionscontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeprovider_options (*UndefinedHash): a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor optionsname (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrencontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrenrecord: (required) the set of fields making up the new recordcreate_options: any create options supported by the data provider"OK" 400 Bad Request: returned if the request has no record key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationrequest_options: request options403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationwhere_cond: search parameterssearch_options: search options403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationstream: (required) the name of the stream to open; must be either:insert: for an insert streamupsert: for an upsert streamupsert_options: any upsert options supported by the data provider (upsert stream only)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationwhere_cond: search parametersblock_size: number of rows in each block (default = 1000)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationset: (required) set of fields matching where_conf to updatewhere_cond: (required) search parameterssearch_options: search options400 Bad Request: returned if the request has no set or where_cond keys403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationrecord: (required) the set of fields making up the new recordupsert_options: any upsert options supported by the data provider400 Bad Request: returned if the request has no record key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationThis URI path provides access information for a particular data request data type
This URI path provides record information for a data provider
provider_options: the options to be passed to the factory creation method to create the providersoft: optional; parsed with Qore::parse_boolean(); if True then the type is returned with soft types to be used as the target for a mappersoft: optional; parsed with Qore::parse_boolean(); if True then the type is returned with soft types to be used as the target for a mapperThis URI path provides the root URI for browsing data provider factories
context (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typetype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typetype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the nodecontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the nodeThis URI path provides the root URI for browsing a data provider create from a data provider factory
context (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typetype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeprovider_options (*UndefinedHash): a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor optionstype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrencontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeprovider_options (*UndefinedHash): a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor optionsname (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrenwhere_cond: search parameters for records to be deletedsearch_options: search options400 Bad Request: returned if the request has no where_cond key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrencontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeprovider_options (*UndefinedHash): any options to be passed to a factory creation method when accessing this URI endpoint through a factoryname (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messagesevents (*UndefinedHash): any events supported by the data providermessages (*UndefinedHash): any messages supported by the data providersearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<string>): a list of any data provider childrenchildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typesoft (*bool): soft types are returnedprovider_options (*UndefinedHash): a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor optionscontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeprovider_options (*UndefinedHash): a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor optionsname (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrencontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrenrecord: (required) the set of fields making up the new recordcreate_options: any create options supported by the data provider"OK" 400 Bad Request: returned if the request has no record key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationrequest_options: request options403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationwhere_cond: search parameterssearch_options: search options403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationstream: (required) the name of the stream to open; must be either:insert: for an insert streamupsert: for an upsert streamupsert_options: any upsert options supported by the data provider (upsert stream only)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationwhere_cond: search parametersblock_size: number of rows in each block (default = 1000)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationset: (required) set of fields matching where_conf to updatewhere_cond: (required) search parameterssearch_options: search options400 Bad Request: returned if the request has no set or where_cond keys403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationrecord: (required) the set of fields making up the new recordupsert_options: any upsert options supported by the data provider400 Bad Request: returned if the request has no record key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationThis URI path provides access information for a particular data request data type
This URI path provides record information for a data provider
provider_options: the options to be passed to the factory creation method to create the providersoft: optional; parsed with Qore::parse_boolean(); if True then the type is returned with soft types to be used as the target for a mappersoft: optional; parsed with Qore::parse_boolean(); if True then the type is returned with soft types to be used as the target for a mapperThis URI path provides the root URI for browsing data providers from remote Qorus connections
context (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typetype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typetype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the nodecontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the nodeThis URI path provides the root URI for browsing a data provider created from a remote Qorus connection
context (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typetype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeprovider_options (*UndefinedHash): a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor optionstype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrencontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeprovider_options (*UndefinedHash): a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor optionsname (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrenwhere_cond: search parameters for records to be deletedsearch_options: search options400 Bad Request: returned if the request has no where_cond key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrencontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeprovider_options (*UndefinedHash): any options to be passed to a factory creation method when accessing this URI endpoint through a factoryname (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messagesevents (*UndefinedHash): any events supported by the data providermessages (*UndefinedHash): any messages supported by the data providersearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<string>): a list of any data provider childrenchildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typesoft (*bool): soft types are returnedprovider_options (*UndefinedHash): a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor optionscontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeprovider_options (*UndefinedHash): a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor optionsname (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrencontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrenrecord: (required) the set of fields making up the new recordcreate_options: any create options supported by the data provider"OK" 400 Bad Request: returned if the request has no record key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationrequest_options: request options403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationwhere_cond: search parameterssearch_options: search options403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationstream: (required) the name of the stream to open; must be either:insert: for an insert streamupsert: for an upsert streamupsert_options: any upsert options supported by the data provider (upsert stream only)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationwhere_cond: search parametersblock_size: number of rows in each block (default = 1000)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationset: (required) set of fields matching where_conf to updatewhere_cond: (required) search parameterssearch_options: search options400 Bad Request: returned if the request has no set or where_cond keys403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationrecord: (required) the set of fields making up the new recordupsert_options: any upsert options supported by the data provider400 Bad Request: returned if the request has no record key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationThis URI path provides access information for a particular data request data type
This URI path provides record information for a data provider
provider_options: the options to be passed to the factory creation method to create the providersoft: optional; parsed with Qore::parse_boolean(); if True then the type is returned with soft types to be used as the target for a mappersoft: optional; parsed with Qore::parse_boolean(); if True then the type is returned with soft types to be used as the target for a mapperThis URI path provides the root URI for browsing data types
context (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typetype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typetype (string): one of the following: nav: a navigation node, data-provider: a data provider, type: a data typechildren (list<DataProviderChildBrowseInfo>): a list of children of the current nodematches_context (*bool): if True then the node is a match for the search contextcontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typecontext (*string): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeThis URI path provides access to functionality related to listing available data providers
This URI path provides access to functionality related to listing available data providers
This URI path provides access to functionality related to listing available events for a data provider
This URI path provides access to functionality related to listing available messages for a data provider
This URI path provides access to functionality related to listing available data providers
This URI path provides access to functionality related to listing available data providers
This URI path provides access to functionality related to listing available data providers
This URI path provides access to data factory information
context: if "api" then only factories suitable for API management are returned, if "apicall", then only factories suitable for making API calls are returnedlist: optional; parsed with Qore::parse_boolean(); if True then a list of data provider factory names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings of data provider factory information is returnedThis URI path provides access to data factory information
encoded_example: base-64-encoded string example inputprovider_yaml_options: a string in the following format giving factory provider constructor options: key = base-64-encoded yaml valueThis URI path provides access to a data provider created from a data provider factory
provider_options: the options to be passed to the factory creation method to create the providerwhere_cond: search parameters for records to be deletedsearch_options: search options400 Bad Request: returned if the request has no where_cond key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationname (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messagesevents (*UndefinedHash): any events supported by the data providermessages (*UndefinedHash): any messages supported by the data providersearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<string>): a list of any data provider childrenchildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementname (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messagesevents (*UndefinedHash): any events supported by the data providermessages (*UndefinedHash): any messages supported by the data providersearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<string>): a list of any data provider childrenchildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementcontext (*list<string>): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typeprovider_options (*UndefinedHash): any options to be passed to a factory creation method when accessing this URI endpoint through a factoryname (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messagesevents (*UndefinedHash): any events supported by the data providermessages (*UndefinedHash): any messages supported by the data providersearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<string>): a list of any data provider childrenchildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementcontext (*list<string>): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typesoft (*bool): soft types are returnedprovider_options (*UndefinedHash): a hash of constructor options for a data provider when following the URI path through a data provider factory that takes constructor optionsname: (required string) the name of the child provider to delete400 Bad Request: returned if the request has no name key or if the data provider does not support the current operation403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationcontext (*list<string>): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrencontext (*list<string>): one of the following: api: when browsing for a request-response data provider, record: when browsing for a record-based data provider, event: when browsing for a data provider that can function as an observable event source, message: when browsing for a data provider that supports sending messages, transaction: when browsing for a data provider that supports transaction management, type: when browsing for a typename (string): the name of the data providersupports_read (bool): if the data provider supports record read/search actionssupports_create (bool): if the data provider support record creationsupports_update (bool): if the data provider supports record updatessupports_upsert (bool): if the data provider supports record upserts / mergessupports_delete (bool): if the data provider supports record deletionssupports_native_search (bool): if the data provider supports a native record search APIsupports_bulk_read (bool): if the data provider supports bulk record read / search actionssupports_bulk_create (bool): if the data provider supports bulk record creationsupports_bulk_upsert (bool): if the data provider supports bulk record upsert / mergessupports_request (bool): if the data provider supports the request/reply integration pattern (API calls)supports_children (bool): if the data provider supports childrentransaction_management (bool): if the data provider supports transaction mgmthas_record (bool): if the data provider supports recordsrecord_requires_search_options (bool): if the data provider requires search options when searchingsupports_child_create (bool): if the data provider supports creating child data providerssupports_child_delete (bool): if the data provider supports deleting child data providerssupports_add_field (bool): if the data provider supports the add field APIsupports_update_field (bool): if the data provider supports the update field APIsupports_delete_field (bool): if the data provider supports the delete field APIsupports_schema (bool): if the data provider supports a schemasupports_search_expressions (bool): if the data provider supports generic search expressionssupports_observable (bool): if the data provider supports the observer pattern / event APIsupports_messages (string): if the data provider supports output messages; values are: NONE (messages not supported), SYNC (messages supported 1:1 with observed events), ASYNC (messages supported, no connection to observed events)children_can_support_apis (bool): if the data provider can provide children that support APIschildren_can_support_records (bool): if the data provider can provide children that support recordschildren_can_support_observers (bool): if the data provider can provide children that support event observationchildren_can_support_messages (bool): if the data provider can provide children that support messageschildren_can_support_transactions (bool): if the data provider can provide children that support transaction managementsearch_logic_capabilities (int): a bitfield of supported search logic capabilitiesmapper_keys (*UndefinedHash): a hash of mapper key informationdesc (string): the description of the data providertype (string): the type (class name) of the data providerconstructor_options (*UndefinedHash): any constructor options supported by the data providercreate_options (*UndefinedHash): any record creation options supported by the data providerupsert_options (*UndefinedHash): any record upsert options supported by the data providersearch_options (*UndefinedHash): any record search options supported by the data providerchild_create_options (*UndefinedHash): any child creation options supported by the data providerexpressions (*UndefinedHash): any expressions supported by the data provider (for searches, for example)children (*list<DataProviderSummaryInfo>): a list of any data provider childrenrecord: (required) the set of fields making up the new recordcreate_options: any create options supported by the data provider"OK" 400 Bad Request: returned if the request has no record key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationname: (required string) the current name of the fieldnew_name: (optional string) the new name of the fieldfield: (optional hash) a hash with the following keys:type: (string) the type of the fielddesc: (string) field descriptiondefault_value: (value of field's type) the default value of the field if not presentopts: (hash) any options for the given typeopts: (optional hash) any field update options supported by the data provider"OK" 400 Bad Request: returned if the request has no old_name key or if the data provider does not support the current operation403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationname: (required string) the name of the field to delete400 Bad Request: returned if the request has no name key or if the data provider does not support the current operation403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationname: (required string) the name of the new child providerfield: (required hash) a hash with the following keys:type: (string) the type of the fielddesc: (string) field descriptiondefault_value: (value of field's type) the default value of the field if not presentopts: (hash) any options for the given typeopts: (optional hash) any field creation options supported by the data provider"OK" 400 Bad Request: returned if the request has no name or fields keys or if the data provider does not support the current operation403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationname (string): the name of the new child providerfields (QorusNewFieldSetInfo): the set of fields making up the new record where keys are field names and values describe each fieldtype (string): the type of the fielddesc (string): field descriptiondefault_value (auto): the default value of the field if not present; the value must be compatible with the field's typeopts (*hash<auto>): any options for the given type400 Bad Request: returned if the request has no name or fields keys or if the data provider does not support the current operation403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled, and the user does not have sufficient privileges for the operationrequest_options: request options403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationprovider_options (*UndefinedHash): any options to be passed to a factory creation method when accessing this URI endpoint through a factorywhere_cond (*UndefinedHash): the where CreatorJobDefinitionRestClasssearch_options (*UndefinedHash): any search optionswhere_cond 400 Bad Request: the data provider does not support searching403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled, and the user does not have sufficient privileges for the operationwhere_cond: search parameterssearch_options: search options403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationwhere_cond: search parameterssearch_options: search options400 Bad Request: data provider does not support searching or search matches multiple records403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationwhere_cond: search parametersblock_size: number of rows in each block (default = 1000)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationstream: (required) the name of the stream to open; must be either:insert: for an insert streamupsert: for an upsert streamupsert_options: any upsert options supported by the data provider (upsert stream only)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationwhere_cond: search parametersblock_size: number of rows in each block (default = 1000)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationset: (required) set of fields matching where_conf to updatewhere_cond: (required) search parameterssearch_options: search options400 Bad Request: returned if the request has no set or where_cond keys403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationrecord: (required) the set of fields making up the new recordupsert_options: any upsert options supported by the data provider400 Bad Request: returned if the request has no record key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationThis URI path provides access information for a particular data request data type
This URI path provides record information for a data provider
provider_options: the options to be passed to the factory creation method to create the providersoft: optional; parsed with Qore::parse_boolean(); if True then the type is returned with soft types to be used as the target for a mappersoft: optional; parsed with Qore::parse_boolean(); if True then the type is returned with soft types to be used as the target for a mapperThis URI path provides access to data type information
400 Bad Request: returned if the entry has no type to delete403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation or if the type is a base typepath: (*string) the relative path from the current entry to the new type (ex: "my-types/project-x/my-type")type: (hash) a hash with the following keys:name: (string) the type nameoptions: (*hash) a hash of type optionsfields: (*hash) a hash of fields where names are field names and values are hashes with the following keys:type: (hash) as abovedesc: (*string) a description for the fielddefault: (*string) a default value for the field serialization as YAML400 Bad Request: invalid or missing arguments to REST call403 Forbidden: TYPE-LOCK-ERROR: a static/base type already exists with the given path403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and and the user does not have sufficient privileges for the operationsoft: optional; parsed with Qore::parse_boolean(); if True then the type is returned with soft types to be used as the target for a mapper404 Not Found: returned if the current entry has no typeThis URI path provides access information for a particular data type
soft: optional; parsed with Qore::parse_boolean(); if True then the type is returned with soft types to be used as the target for a mappercontext: optional; if the value is "ui", then the return format will be in a format suitable for the UItype argument and returns a boolean value:True: the type given as an argument is compatible with the current type; i.e. a variable of the current type can be assigned to a value corresponding to the type passed as an argumentFalse: the type given as an argument is not compatible with the current type; i.e. a variable of the current type cannot be assigned to a value corresponding to the type passed as an argument without type errorstype: required; a string path to the other type (ex: "my/other/type")400 Bad Request: missing or invalid "type" argument404 Not Found: the given type cannot be foundThis REST URI path provides actions and information related to Qorus system debugging
This REST URI path provides information related to Qorus remote development data
This REST URI path provides information related to Qorus internal interface action serialization data
This REST URI path provides information related to the internal Qorus service cache
This REST URI path provides summary information related to internal Qorus order statistics processing data
This REST URI path provides information related to internal Qorus synchronization event cache data
This REST URI path provides information related to internal Qorus synchronization event cache summary info
This REST URI path provides information related to Qorus threads
This REST URI path provides actions and information related to a single Qorus thread
This REST URI path provides information related to Qorus internal workflow control data
This URI path provides remote development for Qorus.
This URI path provides API to delete interfaces from Qorus.
function: optional; list of functions to be deletedclass: optional; list of classes to be deletedconstant: optional; list of constants to be deletedservice: optional; list of services to be deletedstep: optional; list of workflow steps to be deletedwfinstances: optional; list of workflow instances to be deletedworkflow: optional; list of workflows to be deletedEach element of the above lists is a hash with the following keys:
name: required; name of the interface.version: required; version of the interface. Also each interface can be deleted by providing only its id:id: required; id of the interface.method: optional; list of service methods to be deleted. Each element is a hash with the following keys:name: required; name of the service.version: required; version of the service.method-name: required; name of the method. Also methods can be deleted by providing only its id:id: required; id of the method.The follow hash keys are accepted and take only the object name for deletion:
datasource: optional; list of datasource connections to be deleted.event: optional; list of events to be deleted.fsm: optional; list of FSMs to be deletedjob: optional; list of jobs to be deleted.jobinstances: optional; list of job instances to be deleted.mapper: optional; list of mappers to be deleted.pipeline: optional; list of pipelines to be deletedqueue: optional; list of queues to be deleted.remote: optional; list of remote connections to be deleted.uconn: optional; list of user connections to be deleted.vmap: optional; list of value maps to be deleted.Each element of the above lists is a hash with the following keys:
name: required; name of the value map. Also each interface from the above list (except for all connections) can be deleted by providing only its id:id: required; id of the interface.options: optional; hash of delete options. List of valid options:reload: reload interfaces in the serververbosity-level: sets verbosity level (greater value = more info)Example of POST request:
This URI path implements delete request to Qorus.
id: required; id of the request to be canceled.id: required; id of the request to obtain status.status: the status of the request:QUEUED - the request is waiting in the queueIN_PROGRESS - the request is in progressCANCELED - the request has been canceled by the userFAILED - the request has failedFINISHED - the request is finishedexit_code: the exit code of the requeststderr: the standard error outputstdout: the standard outputcreated: the date/time the request was createdThis URI path provides remote deployment for Qorus.
files: required; list of files to be deployed. Each element is a hash with in the following format:file_name: string.file_content: base64 encoded string.options: optional; hash of deployment options. List of valid options:allow-redef: allow dangerous workflow redefinitionsforce: force schema verification/downgrade with user schemasvalidate: validate all functions recursivelyreload: reload interfaces in the serververbosity-level: sets verbosity level (greater value = more info)Example of POST request:
File content is base64 encoded. Options parameter is optional.
This URI path implements deployment request to Qorus.
id: required; id of the request to be canceled.id: required; id of the request to obtain status.status: the status of the request:QUEUED - the request is waiting in the queueUPLOADING - the files are uploadingUPLOADED - all files are uploaded to the serverIN_PROGRESS - the request is in progressCANCELED - the request has been canceled by the userFAILED - the request has failedFINISHED - the request is finishedexit_code: the exit code of the requeststderr: the standard error outputstdout: the standard outputcreated: the date/time the request was createdThis URI path provides remote release for Qorus.
files: required; list of files to be released. Files should be archived in tar.bz2 or tar.gz format. Element is a hash with in the following format:file_name: string file name of the archive.file_content: base64 encoded string content of the archive. Archive should contain a .qrf file.options: optional; hash of deployment options. List of valid options:allow-redef: allow dangerous workflow redefinitionsforce: force schema verification/downgrade with user schemasvalidate: validate all functions recursivelyreload: reload interfaces in the serververbosity-level: sets verbosity level (greater value = more info)Example of POST request:
File content is base64 encoded. Options parameter is optional.
This URI path implements release request to Qorus.
id: required; id of the request to be canceled.id: required; id of the request to obtain status.status: the status of the request:QUEUED - the request is waiting in the queueUPLOADING - the files are uploadingUPLOADED - all files are uploaded to the serverIN_PROGRESS - the request is in progressCANCELED - the request has been canceled by the userFAILED - the request has failedFINISHED - the request is finishedexit_code: the exit code of the requeststderr: the standard error outputstdout: the standard outputcreated: the date/time the request was createdThis URI path provides API to execute qtests.
files: required; list of qtest files. Each element is a hash with in the following format:file_name: string.file_content: base64 encoded string.options: optional; hash of delete options. List of valid options:continue_on_error: if True and one of the tests fails, server will continue on execution of the rest.Example of POST request:
File content is base64 encoded. Options parameter is optional.
This URI path implements test request to Qorus.
id: required; id of the request to be canceled.id: required; id of the request to obtain status.status: the status of the request:QUEUED - the request is waiting in the queueUPLOADING - the files are uploadingUPLOADED - all files are uploaded to the serverIN_PROGRESS - the request is in progressCANCELED - the request has been canceled by the userFAILED - the request has failedFINISHED - the request is finishedexit_code: the exit code of the requeststderr: the standard error outputstdout: the standard outputcreated: the date/time the request was createdThis URI path provides actions and information related to workflow errors
errors: optional; a comma-separated string will be split into a list; the workflow errorsfilter: optional; if "global" then only global errors will be listed; other values for this argument key are ignored; takes precendence over wf list: optional; parsed with Qore::parse_boolean(); if True then a list of error names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings with error names and brief info is returnedwf: optional; a workflow ID or name to use to filter the results with; ignored if filter = "global" business_flag: (optional bool) parsed with Qore::parse_boolean(); a boolean business flag value (if not present then False is assumed)description: (required string) the new description of the errorerror: (required string) the error string (ex: "SOCKET-SSL-ERROR")forceworkflow: (optional bool) parsed with Qore::parse_boolean(); if True then the workflow error will be created as a workflow-specific error even if no global error exists; default if not present False; only used if workflowid also presentretry_delay_secs: (optional int) an optional retry value in seconds (only accepted if status is set to OMQ::StatRetry)severity: (optional string) a severity code for the error (if not present OMQ::ES_Major is assumed); for possible values see Error Severity Codesstatus: (optional string) must be one of the following values:status value is provided)workflowid: (optional string) an optional workflow ID for potentially creating a workflow-specific workflow error definition"CREATED-WORKFLOW": a new workflow-specific error definition was created"CREATED-GLOBAL": a new global error was created (only possible if forceworkflow is omitted or False) est)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)409 Conflict: ERROR-EXISTS: this exception is thrown if the workflow-specific error definition already existsworkflowid and forceworkflow options as described abovebusiness_flag: (optional bool) parsed with Qore::parse_boolean(); a boolean business flag value (if not present then False is assumed)description: (required string) the new description of the errorerror: (required string) the error string (ex: "SOCKET-SSL-ERROR")forceworkflow: (optional bool) parsed with Qore::parse_boolean(); if True then the workflow error will be created as a workflow-specific error even if no global error exists; default if not present False; only used if workflowid also presentretry_delay_secs: (optional int) an optional retry value in seconds (only accepted if status is set to OMQ::StatRetry)severity: (optional string) a severity code for the error (if not present OMQ::ES_Major is assumed); for possible values see Error Severity Codesstatus: (optional string) must be one of the following values:status value is provided)workflowid: (optional string) an optional workflow ID for potentially creating a workflow-specific workflow error definition"UPDATED-WORKFLOW": the existing workflow-specific error was updated"CREATED-WORKFLOW": a new workflow-specific error definition was created"UNCHANGED-WORKFLOW": the new workflow-specific definition is identical to the old definition"CREATED-GLOBAL": a new global error was created (only possible if forceworkflow is omitted or False)"UNCHANGED-GLOBAL": the new global definition is identical to the old definition403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)workflowid and forceworkflow options as described aboveglobal: gives the number of global error definitions loadedworkflow: gives the number of all workflow-specific error definitions loaded403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationerrors: a comma-separated string will be split into a list; the workflow errors to search forThis REST URI path provides actions and information related to global workflow errors
errors: optional; a comma-separated string will be split into a list; the global workflow errors to returnlist: optional; parsed with Qore::parse_boolean(); if True then a list of error names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings with error names and brief info is returnedbusiness_flag: (optional bool) parsed with Qore::parse_boolean(); a boolean business flag value (if not present then False is assumed)description: (required string) the new description of the errorerror: (required string) the error string (ex: "SOCKET-SSL-ERROR")retry_delay_secs: (optional int) an optional retry value in seconds (only accepted if status is set to OMQ::StatRetry)severity: (optional string) a severity code for the error (if not present OMQ::ES_Major is assumed); for possible values see Error Severity Codesstatus: (optional string) must be one of the following values:status value is provided)"CREATED-GLOBAL" indicating that a new global workflow error was created403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation409 Conflict: ERROR-EXISTS: this exception is thrown if the global workflow error already existsbusiness_flag: (bool) parsed with Qore::parse_boolean(); a boolean business flag value (if not present then False is assumed)description: (string) the new description of the errorerror: (required string) the error string (ex: "SOCKET-SSL-ERROR")retry_delay_secs: (optional int) an optional retry value in seconds (only accepted if status is set to OMQ::StatRetry)severity: (optional string) a severity code for the error (if not present OMQ::ES_Major is assumed); for possible values see Error Severity Codesstatus: (optional string) must be one of the following values:status value is provided)"UPDATED-GLOBAL": the existing global error was updated"CREATED-GLOBAL": a new global error was created"UNCHANGED-GLOBAL": the new global definition is identical to the old definition403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationThis URI path provides actions and information related to a specific global workflow error
"OK" upon successful execution403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationbusiness_flag: (bool) parsed with Qore::parse_boolean(); a boolean business flag value (if not present then False is assumed)description: (string) the new description of the errorretry_delay_secs: (optional int) an optional retry value in seconds (only accepted if status is set to OMQ::StatRetry)severity: (optional string) a severity code for the error (if not present OMQ::ES_Major is assumed); for possible values see Error Severity Codesstatus: (optional string) must be one of the following values:status value is provided)"UPDATED-GLOBAL": the existing global error was updated"CREATED-GLOBAL": a new global error was created (only possible in case of a race condition where the current error was deleted during this request)"UNCHANGED-GLOBAL": the new global definition is identical to the old definition403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationThis URI path provides actions and information related to workflow-specific workflow-specific workflow errors across all workflows
errors: optional; a comma-separated string will be split into a list; the workflow-specific workflow errors for all accessible workflows to returnlist: optional; parsed with Qore::parse_boolean(); if True then a list of error names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings with error names and brief info is returnedThis URI path provides actions and information related to workflow-specific workflow errors for a particular workflow
errors: optional; a comma-separated string will be split into a list; the workflow-specific workflow errors for the current workflow to returnlist: optional; parsed with Qore::parse_boolean(); if True then a list of error names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings with error names and brief info is returnedbusiness_flag: (optional bool) parsed with Qore::parse_boolean(); a boolean business flag value (if not present then False is assumed)description: (required string) the new description of the errorerror: (required string) the error string (ex: "SOCKET-SSL-ERROR")retry_delay_secs: (optional int) an optional retry value in seconds (only accepted if status is set to OMQ::StatRetry)severity: (optional string) a severity code for the error (if not present OMQ::ES_Major is assumed); for possible values see Error Severity Codesstatus: (optional string) must be one of the following values:status value is provided)"CREATED-WORKFLOW": a new workflow-specific error definition was created"CREATED-GLOBAL": a new global error was created (only possible if forceworkflow is omitted or False)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)409 Conflict: ERROR-EXISTS: this exception is thrown if the workflow-specific error definition already existsbusiness_flag: (optional bool) parsed with Qore::parse_boolean(); a boolean business flag value (if not present then False is assumed)description: (required string) the new description of the errorerror: (required string) the error string (ex: "SOCKET-SSL-ERROR")retry_delay_secs: (optional int) an optional retry value in seconds (only accepted if status is set to OMQ::StatRetry)severity: (optional string) a severity code for the error (if not present OMQ::ES_Major is assumed); for possible values see Error Severity Codesstatus: (optional string) must be one of the following values:status value is provided)"UPDATED-WORKFLOW": the existing workflow-specific error was updated"CREATED-WORKFLOW": a new workflow-specific error definition was created"UNCHANGED-WORKFLOW": the new workflow-specific definition is identical to the old definition403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)This URI path provides actions and information related to a workflow-specific workflow error
"OK" upon successful execution403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationbusiness_flag: (bool) parsed with Qore::parse_boolean(); a boolean business flag value (if not present then False is assumed)description: (string) the new description of the errorretry_delay_secs: (optional int) an optional retry value in seconds (only accepted if status is set to OMQ::StatRetry)severity: (optional string) a severity code for the error (if not present OMQ::ES_Major is assumed); for possible values see Error Severity Codesstatus: (optional string) must be one of the following values:status value is provided)"UPDATED-WORKFLOW": the existing workflow-specific error was updated"CREATED-WORKFLOW": a new workflow-specific error definition was created (only possible in case of a race condition where the current error was deleted during this request)"UNCHANGED-WORKFLOW": the new workflow-specific definition is identical to the old definition403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)This URI path provides actions and information related to a specific workflow error
"OK" upon successful execution403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationbusiness_flag: (bool) parsed with Qore::parse_boolean(); a boolean business flag value (if not present then False is assumed)description: (string) the new description of the errorretry_delay_secs: (optional int) an optional retry value in seconds (only accepted if status is set to OMQ::StatRetry)severity: (string) a severity code for the error (if not present OMQ::ES_Major is assumed); for possible values see Error Severity Codesstatus: (string) must be one of the following values:status value is provided)"UPDATED-WORKFLOW": the existing workflow-specific error was updated"CREATED-WORKFLOW": a new workflow-specific error definition was created (only possible in case of a race condition where the current error was deleted during this request)"UNCHANGED-WORKFLOW": the new workflow-specific definition is identical to the old definition"UPDATED-GLOBAL": the existing global error was updated"CREATED-GLOBAL": a new global error was created (only possible in case of a race condition where the current error was deleted during this request)"UNCHANGED-GLOBAL": the new global definition is identical to the old definition403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation409 Conflict: ERROR-UPDATE-ERROR: invalid keys or key values provided in the error description hashThis URI path provides actions and information regarding workflow execution instances.
groups: list of interface groups that the workflow belongs to; each list element is a REST Interface Group Hash (may be empty)alerts: a list of alerts raised against the workflow; each list element is a REST Alert Hash (may be empty)log_url: a complete URL to the websocket source for the workflow logcount: number of workflow execution instances stoppedworkflows: a hash keyed by workflow description where the values are the lists of all execution instance IDs stopped for that workflowmsg: a descriptive message about the workflows stoppedargs: (required) one or more workflow names or IDs to stopcount: number of workflow execution instances stoppedworkflows: a hash keyed by workflow description where the values are the lists of all execution instance IDs stopped for that workflowmsg: a descriptive message describing the workflow execution instances that were stoppedThis URI path provides actions and information regarding a particular workflow execution instance.
groups: list of interface groups that the workflow belongs to; each list element is a REST Interface Group Hash (may be empty)alerts: a list of alerts raised against the workflow; each list element is a REST Alert Hash (may be empty)log_url: a complete URL to the websocket source for the workflow logoptions: a hash of options to set against the workflow; if the value of this key is a string, then it is first parsed with Util::parse_to_qore_value(), which should then return a hash400 Bad Request: missing "options" argument or "options" is not a hash (or string parsed to a hash with Util::parse_to_qore_value())409 Conflict: WORKFLOW-OPTION-ERROR: invalid option for workflow or option cannot be overridden at the workflow level403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)"OK" if successful.This URI path provides actions and information about workflow execution instances for a particular workflow.
groups: list of interface groups that the workflow belongs to; each list element is a REST Interface Group Hash (may be empty)alerts: a list of alerts raised against the workflow; each list element is a REST Alert Hash (may be empty)log_url: a complete URL to the websocket source for the workflow logoptions: a hash of options to set against the workflow; if the value of this key is a string, then it is first parsed with Util::parse_to_qore_value(), which should then return a hash400 Bad Request: missing "options" argument or "options" is not a hash (or string parsed to a hash with Util::parse_to_qore_value())409 Conflict: WORKFLOW-OPTION-ERROR: invalid option for workflow or option cannot be overridden at the workflow level403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)stopped: the value is a descriptive string for the workflow"no instances to stop".403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)This REST API path provides actions and information related to Qorus Finite State Machines.
list: optional; parsed with Qore::parse_boolean(); if True then a list of FSM names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings of FSM information is returnedThis REST API path provides actions and information related to a particular Qorus Finite State Machine.
This REST URI path provides actions and information related to Qorus Finite State Machine configuration items
"name": the name of the configuration item"prefix": the prefix of the configuration item"type": the type of the configuration item"desc": the description of the configuration item"default_value": the default value of the configuration item"value": the value of the configuration item"strictly_local": if the configuration item is defined strictly on local level"is_set": True if the value is set otherwise False"config_group": the group of the configuration item"allowed_values": the list of allowed values for the configuration item if defined"level": the level from where the value is obtained (interface level (e.g. "fsm:name1", "fsm:name2") or "global" or "default")"is_templated_string": True if the value is a templated string that can be later expanded"name": the name of the configuration item"prefix": the prefix of the configuration item"type": the type of the configuration item"desc": the description of the configuration item"default_value": (YAML-serialized string) the default value of the configuration item"value": (YAML-serialized string) the value of the configuration item"strictly_local": if the configuration item is defined strictly on local level"is_set": True if the value is set otherwise False"config_group": the group of the configuration item"allowed_values": the list of allowed values for the configuration item if defined (each element is a YAML-serialized string)"level": the level from where the value is obtained (interface level (e.g. "fsm:name1", "fsm:name2") or "global" or "default")"is_templated_string": True if the value is a templated string that can be later expandedThis REST URI path provides actions and information related to a particular configuration item for a particular Qorus Finite State Machine.
Prefixes can be passed within the config item name or as following: /v5/fsms/{name}/config/{name}?prefix={prefix}.
info: a string confirming the delete operationdeleted: True if value has been deletedvalue: deleted value403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation"name": the name of the configuration item"prefix": the prefix of the configuration item"type": the type of the configuration item"desc": the description of the configuration item"default_value": the default value of the configuration item"value": the value of the configuration item"strictly_local": if the configuration item is defined strictly on local level"is_set": True if the value is set otherwise False"config_group": the group of the configuration item"allowed_values": the list of allowed values for the configuration item if defined"level": the level from where the value is obtained (interface level (e.g. "fsm:name1", "fsm:name2") or "global" or "default")"is_templated_string": True if the value is a templated string that can be later expandedvalue: the value of the configuration item; must be compatible with the item's declared type400 Bad Request: returned if the request has no value key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationvalue: (YAML-serialized string) the value of the configuration item; must be compatible with the item's declared type400 Bad Request: returned if the request has no value key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation"name": the name of the configuration item"prefix": the prefix of the configuration item"type": the type of the configuration item"desc": the description of the configuration item"default_value": (YAML-serialized string) the default value of the configuration item"value": (YAML-serialized string) the value of the configuration item"strictly_local": if the configuration item is defined strictly on local level"is_set": True if the value is set otherwise False"config_group": the group of the configuration item"allowed_values": the list of allowed values for the configuration item if defined (each element is a YAML-serialized string)"level": the level from where the value is obtained (interface level (e.g. "fsm:name1", "fsm:name2") or "global" or "default")"is_templated_string": True if the value is a templated string that can be later expandedinfo: a string confirming the delete operationdeleted: True if value has been deletedvalue (YAML-serialized string): deleted value403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationThis REST API path provides actions and information about Qorus functions
list: optional; parsed with Qore::parse_boolean(); if True then a list of function names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings with function names, versions, and IDs is returnedlist nor short options are passed as above):name: the name of the functionversion: the version of the functionfunction_instanceid: the function IDfunction_type: the type of function object; see Step Function Types for possible valuesdescription: the description of the functionauthor: the author of the functioncreated: the date/time the function was createdmodified: the date/time the function was modifiedsource: the source file that the function object was created fromline: the offset in the source file for the source of the function objectThis REST API path provides actions and information about specific functions
This URI path provides actions and information related to interface groups
groups: (required) list of strings or a single string; a comma-separated string will be split into a list; the names of the groups to delete403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation409 Conflict: GROUPS-DELETE-ERROR: missing groups argumentlist: optional; parsed with Qore::parse_boolean(); if True then a list of group names is returnedno_synthetic: optional; parsed with Qore::parse_boolean(); if True then synthetic groups will not be included in the return valueshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings of group names and descriptions is returnedlist or short are present, this API returns a list of REST Interface Group Detail Hash elements according to the arguments.group: (string) required; the name of the groupdesc: (string) required; the description of the groupworkflows: (list of strings or a single string) optional; a comma-separated string will be split into a list; the list of workflow names or IDs to include in the groupservices: (list of strings or a single string) optional; a comma-separated string will be split into a list; the list of user service names or IDs to include in the groupjobs: (list of strings or a single string) optional; a comma-separated string will be split into a list; the list of job names or IDs to include in the groupmappers: (list of strings or a single string) optional; a comma-separated string will be split into a list; the list of mapper names or IDs to include in the groupvmaps: (list of strings or a single string) optional; a comma-separated string will be split into a list the list of value map names or IDs to include in the groupfsms: (list of strings) optional; a comma-separated string will be split into a list the list of Finite State Machine names to include in the grouppipelines: (list of strings) optional; a comma-separated string will be split into a list the list of data pipeline names to include in the groupenabled: (string) this value will be processed by parse_boolean(); the initial enabled flag for the group; if not present defaults to True403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation409 Conflict: WORKFLOW-ERROR: invalid or unknown workflow409 Conflict: SERVICE-ERROR: invalid or unknown service409 Conflict: JOB-ERROR: invalid or unknown job409 Conflict: MAPPER-ERROR: invalid or unknown mapper409 Conflict: VALUE-MAP-ERROR: invalid or unknown value map409 Conflict: FSM-ERROR: invalid or unknown Finite State Machine409 Conflict: PIPELINE-ERROR: invalid or unknown data pipeline409 Conflict: GROUP-ERROR: missing group or desc argumentsgroups: (required) one or more group names to modify; a comma-separated string will be split into a listenabled: (required) parsed with Qore::parse_boolean(); the new enabled status for the group(s)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation409 Conflict: GROUPS-SETSTATUS-ERROR: missing groups or enabled argumentsThis URI path provides actions and information related to a specific interface group
info: a string describing the group deletion action403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: cannot update group "DEFAULT" desc: (string) the new description of the groupworkflows: (list of strings or a single string) the list of workflow names to include in the group; the new list will replace the current list unless the workflow names are preceded by "+" or "-", meaning add or remove a workflow, respectively (in which case all workflow names must be preceded by a "+" or "-")services: (list of strings or a single string) the list of user service names to include in the group; the new list will replace the current list unless the user service names are preceded by "+" or "-", meaning add or remove a service, respectively (in which case all service names must be preceded by a "+" or "-")jobs: (list of strings or a single string) the list of job names to include in the group; the new list will replace the current list unless the job names are preceded by "+" or "-", meaning add or remove a job, respectively (in which case all job names must be preceded by a "+" or "-")mappers: (list of strings or a single string) the list of mapper names to include in the group; the new list will replace the current list unless the mapper names are preceded by "+" or "-", meaning add or remove a mapper, respectively (in which case all mapper names must be preceded by a "+" or "-")vmaps: (list of strings or a single string) the list of value map names to include in the group; the new list will replace the current list unless the value map names are preceded by "+" or "-", meaning add or remove a value map, respectively (in which case all value map names must be preceded by a "+" or "-")enabled: (string) this value will be processed by parse_boolean(); enables or disables the group"OK" upon successful execution403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Conflict: RBAC-UPDATE-GROUP-ERROR: at least one of desc, services, workflows, jobs, mappers, vmaps, or enabled keys must be passed in the second argument hash to update the group403 Forbidden: cannot update group "DEFAULT" "OK" upon successful execution403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: cannot update group "DEFAULT" "OK" upon successful execution403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: cannot update group "DEFAULT" enabled: (required) parsed with Qore::parse_boolean(); the new enabled status for the groupinfo: a string describing the group enabled status change403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation409 Conflict: GROUP-SETSTATUS-ERROR: missing enabled argumentThis REST API path provides actions and information about job results (job instances).
date: optional (parsed as a date); the past cutoff date for the search; only orders with a modified date equal or after this date will be considered; if not present, then defaults to the last 24 hoursdesc: optional (parsed with Qore::parse_boolean(); determines the sort order; if False then results are sorted in ascending order, if True (the default), results are sorted in descending order (newest first)full: optional (parsed with Qore::parse_boolean(); if True then additional keys are included in each result record; see below for detailsids: optional; one or more job IDs to filter the result list; a comma-separated string will be split into a listlimit: optional; limits the number of results returnedoffset: optional; the starting result to return (use when paging for example)sort: optional; a list of columns to sort the output bystatuses: optional; job result (job instance) status value(s); a comma-separated string will be split into a list (see Job Data Status Descriptions for possible values)full option is set, then the following additional keys are included in each hash:errors: a list of hashes of errors and warnings raised by the job; each list element has the following keys:job_errorid: the unique ID for the error instanceseverity: an error severity code (see Error Severity Codes for possible values)error: the error code stringdescription: description for the error (if any)info: additional information about the error (if any)business_error: a boolean flag indicating of the error is a business errorcreated: the date and time the error was raisedaudit: a list of one or more REST Audit Info Hash elements (can be empty)date: optional (parsed as a date); the past cutoff date for the search; only orders with a modified date equal or after this date will be considered; if not present, then defaults to the last 24 hourssqlcache: optional (parsed with Qore::parse_boolean()); if False then no SQL cache will be used for historical info; default Truecombined: if True then all results are combined into one global hash for all queried jobsjobs: one or more job names or IDs to filter the result list; a comma-separated string will be split into a listcombined is set, described above)myjob_1 : hash: (2 members) ERROR : 1 COMPLETE : 3 myjob_2 : hash: (2 members) IN-PROGRESS : 1 COMPLETE : 8
This REST API path provides actions and information about specific job results (job instances).
errors: a list of hashes of errors and warnings raised by the job; each list element has the following keys:job_errorid: the unique ID for the error instanceseverity: an error severity code (see Error Severity Codes for possible values)error: the error code stringdescription: description for the error (if any)info: additional information about the error (if any)business_error: a boolean flag indicating of the error is a business errorcreated: the date and time the error was raisedaudit: a list of one or more REST Audit Info Hash elements (can be empty)This REST API path provides actions and information related to Qorus jobs.
defonly: optional (parsed with Qore::parse_boolean()); if True then no job result information will be included in the return value; default Falsedate: optional (parsed as a date); the past cutoff date for job result (job instances) for the return value; if not present, then defaults to the last 24 hoursjobs: one or more job names or IDs to filter the result list; a comma-separated string will be split into a listlib_source: optional; parsed with Qore::parse_boolean(); if True then the source code for each library object is returned in the REST Job Description Hashlist: optional; parsed with Qore::parse_boolean(); if True then a list of job names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings of job names and descriptions is returnedsqlcache: optional (parsed with Qore::parse_boolean()); if False then no SQL cache will be used for historical info; default True (only used if defonly is omitted or False)status: optional; either "active" or "inactive" to filter jobs based on their active statustags: optional; a hash of tags to match; only workflows matching at least one of the tags will be returned; use tag=value format as the value of this optiontag_case_insensitive: optional; parsed with Qore::parse_boolean(); if True then tag value comparisons are made with case-insensitive comparisonstag_partial_match: optional; parsed with Qore::parse_boolean(); if True then tag value comparisons succeed if the value given as the tag value appears anywhere in the object's tag of the same namelist nor short are used, then this API returns a list of REST Job Description Hash elements; if defonly is not True, then any jobs with job result data within the given time period (as defined by the date option) will be reflected in the following extra keys:IN-PROGRESS: the number of job instances currently in progressCOMPLETE: the number of job instances with a OMQ::StatComplete status during the given time periodERROR: the number of job instances with a OMQ::StatError status during the given time period400 Bad Request: invalid or missing arguments to REST callloggerid: (int) logger idparams: (hash) logger paramslevel: (hash) LoggerLevel"key": logger level string representation"value": logger level int representationname: (string) logger nameadditivity: (bool) logger additivityinterface_table_name: (string) interface table name (jobs/workflows/services). If set means default loggerlevel: required; (int|string) LoggerLevelname: (string) logger nameadditivity: (bool) logger additivity (default True)cloneDefault: (bool) create logger with appenders based on default logger400 Bad Request: invalid or missing arguments to REST call409 Conflict: conflict with the current statelevel: (int|string) LoggerLevelname: logger name to setadditivity: logger additivity to set400 Bad Request: invalid or missing arguments to REST callid: required; (int); id of the appender to be deletedname: (string) the name of the appenderlayoutPattern: (string) the layout for the appenderfilename: (string) the output filenameencoding: (string) the file's output encodingappenderType: required; (string) appender type, case sensitive (see Logger for possible values) (ex. LoggerAppenderFileRotate, LoggerAppenderFile, LoggerAppenderStdOut ...)rotationCount: (int) the number of files in rotation chain, if count is <=0 then no ratation is performed. Only for rotation appendersarchivePattern: (string) pattern to evaluate archive filename400 Bad Request: invalid or missing arguments to REST call409 Conflict: conflict with the current stateid: required; (int); id of the appender to be updatename: (string) the name of the appenderlayoutPattern: (string) the layout for the appenderfilename: (string) the output filenameencoding: (string) the file's output encodingappenderType: required; (string) appender type, case sensitive (see Logger for possible values) (ex. LoggerAppenderFileRotate, LoggerAppenderFile, LoggerAppenderStdOut ...)rotationCount: (int) the number of files in rotation chain, if count is <=0 then no ratation is performed. Only for rotation appendersarchivePattern: (string) pattern to evaluate archive filenameappenderId: (int) appenderIdparams: (hash) possible appender parameters, might be missing if not setname: (string) appender namelayoutPattern: (string) appender layout patternrotation: (int) appender layout patternfilename: (string) appender filenameids: (required) one or more job names or IDs to disable; a comma-separated string will be split into a list409 Conflict: JOB-DISABLE-ERROR: missing ids argumentids: (required) one or more job names or IDs to enable; a comma-separated string will be split into a list409 Conflict: JOB-ENABLE-ERROR: missing ids argumentids: (required) one or more job names or IDs to reset; a comma-separated string will be split into a list403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationids: (required) one or more job names or IDs to run; a comma-separated string will be split into a listarg: the job ID or name (the argument passed as input)run: True means the job was run, False means it was notinfo: an informative string giving a description of the result or an error messagejobid]: the job IDname]: the name of the jobversion]: the version of the jobjob_instanceid]: the job_instanceid of the job executedstatus]: the status of the execution of the job; see Job Data Status Descriptions for possible values403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationThis REST API path provides actions and information related to specific jobs; the name can also be provided in the format name:version.
400 Bad Request: returned if the request has invalid arguments403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationname (string): the name of the jobjobid (int): the job IDdescription (*string): the description of the job (if any)version (string): the version of the jobauthor (*string): the author of the job (if any)sessionid (*int): If the job is currently active and running on a Qorus instance, then this attribute will have a value, otherwise it will not be setremote (bool): the remote state of the job; if True, the job will run remotely in a qjob process; if False, it will run in qorus-coremanual_remote (bool): set if the manual value has been changed manually, in which case the manual setting takes precendence over any new definitions loaded with oloadopen (bool): if the current workflow is open for processing nowrun_skipped (bool): A boolean value telling the system if the job should be run immediately if the last scheduled run was missed due to system downtimeenabled (bool): flag indicating if the job is enabled or not; disabled jobs cannot be activatedcode (string): the source code for the jobclass_based (bool): True means that the job is an extension of the QorusJob class, otherwise it is a function-based jobclass_name (*string): the name of the job class, if anylanguage (string): the programming language that the job's main code is implemented inmonth (*string): the month value in a job cron scheduleday (*string): the day value in a job cron schedulewday (*string): the weekday value in a job cron schedulehour (*string): the hout value in a job cron scheduleminute (*string): the minute value in a job cron scheduleexpiry_date (*date): the expiry date of the job, if anylast_executed (*date): the date-time value the job was last executed, if anylast_executed_job_instanceid (*int): the last job instance ID, if anymanually_updated (bool): flag set if the job schedule has been changed manually, in which case the manual setting takes precendence over any new definitions loaded with oloadcreated (date): the date/time the job was createdmodified (date): the date/time the job was modifiedsource (*string): the complete path of the job source file when loadedline (*int): the line offset of the job source code in the fileconfig_items (*list<ConfigItemDetailInfo>): list of config items attached directly to the jobfsm_triggers (*FsmTriggerSet): a hash keyed by finite state machine name giving triggers for each flownext (*date): the next automatic job execution time time, if anyschedule (*string): the schedule for the job as a stringmappers (*list<MapperInfo>): list of mappers associated with the jobvmaps (*list<VMapInfo>): a list of value maps associated with the joblib (*LibraryInfo): a hash of library information for the jobfunctions (*list<LibraryDetailInfo>): a list of function objects (can be empty)classes (*list<LibraryDetailInfo>): a list of class objects (can be empty)constants (*list<LibraryDetailInfo>): a list of constant objects (can be empty)pipelines (*list<NameInfo>): a list of pipeline objects (can be empty)fsm (*list<NameInfo>): a list of FSM objects (can be empty)tags (*UndefinedHash): any tags for the jobconfig (*ConfigItemSummarySetInfo): a hash of configuration item info keyed by config item namename (string): the name of the configuration itemprefix (*string): the prefix of the configuration itemtype (string): the data type of the configuration itemdesc (string): the description of the configuration itemdefault_value (auto): the default value of the configuration itemvalue (auto): the value of the configuration itemstrictly_local (bool): if the configuration item is defined strictly on local levelis_set (bool): True if the value is set otherwise Falseconfig_group (string): the group of the configuration itemallowed_values (*list<auto>): the list of allowed values for the configuration item if definedlevel (string): the level from where the value is obtained (interface level (e.g. "job:1", "job:2")is_templated_string (bool): True if the value is a templated string that can be later expandedgroups (*list<GroupInfo>): a list of interface groups that the job belongs tooffset (*string): the line offset of the job source code in the filehost (*string): the hostname of the machine where the job was loaded fromuser (*string): the OS user who loaded the jobbase_class_name (*string): the base class name of the job, if anyprocess (*ProcessExecInfo): present when remote is Trueid (string): the unique process ID in the clusternode (string): the node name where the process is runninghost (string): the hostname where the process is runningpid (int): the PID on the hosturls (list<string>): a list of ZeroMQ URLs for the processstatus (int): the process's status codestatus_string (string): the process's status as a stringpriv (int): the amount of private memory of the process in bytesrss (int): the resident size of the process in bytesvsz (int): the virtual size of the process in bytespriv_str (string): a string description of the priv valuepct (int): the percentage of main memory taken up by the process on the nodeCOMPLETE (*int): number of job results with status COMPLETEIN-PROGRESS (*int): number of job results with status IN-PROGRESSERROR (*int): number of job results with status ERRORCRASH (*int): number of job results with status CRASHconnections (*list<ConnectionInfo>): a list of connection objects that this job depends onalerts (*list<AlertInfo>): a list of alerts raised against the jobdb_active (bool): a boolean flag indicating the active status in the databaseactive (bool): the active status in the current Qorus instancemanual_active (bool): set if the active value has been changed manually, in which case the manual setting takes precendence over any new definitions loaded with oloadlog_url (*string): the log URL (if any)options (list<OptionInfoHash>): a list option information hashessched_type (string): the schedule type; one of "cron" (uses a job cron schedule), or "recurring" ( uses a fixed repeat delay)sched_txt (string): a string describing the schedule (ex: "minutes: 0, hours: 0, days: *, months: *, wdays: *")sla (*string): the name of the attached SLA, if any)state (*hash<auto>): any job state datapersistent-state (*hash<auto>): any persistent job state data403 Forbidden: access or authorization errorcode: (string) the source code for the jobmetadata: (hash) the metadata of the job to updateid: (int) the job ID updated400 Bad Request: returned if the request has invalid arguments403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationjobid (int): the workflow IDname (string): the wojobrkflow nameversion (string): the job versioninfo (string): a string providing information about the job update action403 Forbidden: access or authorization error409 Conflict: exception processing the requestjobid (int): the workflow IDname (string): the wojobrkflow nameversion (string): the job versioninfo (string): a string providing information about the job update action403 Forbidden: access or authorization error409 Conflict: exception processing the requeststatus (string): either "OK" or "ERR" code (int): the return code of the kill() command: 0 if successful, non-zero if not403 Forbidden: access or authorization error404 Not Found: if no remote process is running for the job403 Forbidden: access or authorization error409 Conflict: API-CALL-ERROR: cannot reset a disabled jobjob_instanceid (int): the job_instanceidstatus (string): the status of the execution of the job; see Job Data Status Descriptions for possible values403 Forbidden: access or authorization errorschedule (*string): a cron-like string giving the job schedule, see job schedule for information about the format; either this parameter or duration must be present, but not bothduration (*int): a duration in seconds for triggering the job; either this parameter or schedule must be present, but not both; the duration must be less than 10^7.jobid (int): the job IDname (string): the job nameschedule (*string): the new schedule for the jobduration (*int): the new dduration for the jobinfo (string): a descriptive string403 Forbidden: access or authorization erroractive (bool): the new active state of the jobjobid (int): the job IDname (string): the job nameactive (bool): the new active state of the jobinfo (string): a descriptive stringdb_active (bool): the active state in the DB (can differ from active if the job cannot be started for example)403 Forbidden: access or authorization error409 Conflict: JOB-ERROR: cannot set expired jobs to activedate (*date): the new expiry date of the job; if not present any expiry date will be removedjobid (int): the job IDname (string): the job nameexpiry_date (*date): the new expiry date of the jobinfo (string): a descriptive string403 Forbidden: access or authorization erroroptions: a hash of options to set against the job; if the value of this key is a string, then it is first parsed with Util::parse_to_qore_value(), which should then return a hash"OK" upon successful execution400 Bad Request: missing "options" argument or "options" is not a hash (or string parsed to a hash with Util::parse_to_qore_value())403 Forbidden: JOB-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given job (for more information, see Interface Groups)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation409 Conflict: JOB-OPTION-ERROR: invalid option for job or option cannot be overridden at the job leveldata: a hash of new persistent job state data or NOTHING which will clear any data403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: JOB-ACCESS-ERROR: the user does not have the right to access the given job (for more information, see Interface Groups)remote (bool): the new remote state of the jobupdated (bool): if the remote status was updatedremote (bool): the new remote state of the jobinfo (string): a descriptive string403 Forbidden: access or authorization errordata: a hash of new job state data or NOTHING which will clear any data403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: JOB-ACCESS-ERROR: the user does not have the right to access the given job (for more information, see Interface Groups)This REST URI path provides actions and information related to Qorus job configuration items
"name": the name of the configuration item"prefix": the prefix of the configuration item"type": the type of the configuration item"desc": the description of the configuration item"default_value": the default value of the configuration item"value": the value of the configuration item"strictly_local": if the configuration item is defined strictly on local level"is_set": True if the value is set otherwise False"config_group": the group of the configuration item"allowed_values": the list of allowed values for the configuration item if defined"level": the level from where the value is obtained (interface level (e.g. "job:1", "job:2") or "global" or "default")"is_templated_string": True if the value is a templated string that can be later expanded403 Forbidden: JOB-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given job (for more information, see Interface Groups)"name": the name of the configuration item"prefix": the prefix of the configuration item"type": the type of the configuration item"desc": the description of the configuration item"default_value": (YAML-serialized string) the default value of the configuration item"value": (YAML-serialized string) the value of the configuration item"strictly_local": if the configuration item is defined strictly on local level"is_set": True if the value is set otherwise False"config_group": the group of the configuration item"allowed_values": the list of allowed values for the configuration item if defined (each element is a YAML-serialized string)"level": the level from where the value is obtained (interface level (e.g. "job:1", "job:2") or "global" or "default")"is_templated_string": True if the value is a templated string that can be later expanded403 Forbidden: JOB-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given job (for more information, see Interface Groups)This REST URI path provides actions and information related to a particular Qorus job. Prefix can be passed within the config item name or as following: /v3/jobs/{id_or_name}/config/{name}?prefix={prefix}.
info: a string confirming the delete operationdeleted: True if value has been deletedvalue: deleted value403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation"name": the name of the configuration item"prefix": the prefix of the configuration item"type": the type of the configuration item"desc": the description of the configuration item"default_value": the default value of the configuration item"value": the value of the configuration item"strictly_local": if the configuration item is defined strictly on local level"is_set": True if the value is set otherwise False"config_group": the group of the configuration item"allowed_values": the list of allowed values for the configuration item if defined"level": the level from where the value is obtained (interface level (e.g. "job:1", "job:2") or "global" or "default")"is_templated_string": True if the value is a templated string that can be later expanded403 Forbidden: JOB-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given job (for more information, see Interface Groups)value: the value of the configuration item; must be compatible with the item's declared type400 Bad Request: returned if the request has no value key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: JOB-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given service (for more information, see Interface Groups)value: (YAML-serialized string) the value of the configuration item; must be compatible with the item's declared type400 Bad Request: returned if the request has no value key403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: JOB-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given service (for more information, see Interface Groups)"name": the name of the configuration item"prefix": the prefix of the configuration item"type": the type of the configuration item"desc": the description of the configuration item"default_value": (YAML-serialized string) the default value of the configuration item"value": (YAML-serialized string) the value of the configuration item"strictly_local": if the configuration item is defined strictly on local level"is_set": True if the value is set otherwise False"config_group": the group of the configuration item"allowed_values": the list of allowed values for the configuration item if defined (each element is a YAML-serialized string)"level": the level from where the value is obtained (interface level (e.g. "job:1", "job:2") or "global" or "default")"is_templated_string": True if the value is a templated string that can be later expanded403 Forbidden: JOB-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given job (for more information, see Interface Groups)info: a string confirming the delete operationdeleted: True if value has been deletedvalue (YAML-serialized string): deleted value403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationThis REST API path provides actions and information related to the results of specific jobs.
date: optional (parsed as a date); the past cutoff date for the search; only orders with a modified date equal or after this date will be considered; if not present, then defaults to the last 24 hoursdesc: optional (parsed with Qore::parse_boolean(); determines the sort order; if False then results are sorted in ascending order, if True (the default), results are sorted in descending order (newest first)full: optional (parsed with Qore::parse_boolean(); if True then additional keys are included in each result record; see below for detailsids: optional; one or more job instance IDs to filter the result list; a comma-separated string will be split into a listlimit: optional; limits the number of results returnedoffset: optional; the starting result to return (use when paging for example)sort: optional; a list of columns to sort the output bystatuses: optional; job result (job instance) status value(s); a comma-separated string will be split into a list (see Job Data Status Descriptions for possible values)full option is set, then the following additional keys are included in each hash:errors: a list of hashes of errors and warnings raised by the job; each list element has the following keys:job_errorid: the unique ID for the error instanceseverity: an error severity code (see Error Severity Codes for possible values)error: the error code stringdescription: description for the error (if any)info: additional information about the error (if any)business_error: a boolean flag indicating of the error is a business errorcreated: the date and time the error was raisedaudit: a list of one or more REST Audit Info Hash elements (can be empty)date: optional (parsed as a date); the past cutoff date for the search; only orders with a modified date equal or after this date will be considered; if not present, then defaults to the last 24 hourssqlcache: optional (parsed with Qore::parse_boolean()); if False then no SQL cache will be used for historical info; default Truecombined: if True then all results are combined into one global hash for all queried jobscombined is set, described above)myjob_1 : hash: (2 members) ERROR : 1 COMPLETE : 3 myjob_2 : hash: (2 members) IN-PROGRESS : 1 COMPLETE : 8
This REST API path provides the logout action
This REST URI path provides actions and information related to Qorus system logs and websocket log sources
type: one of the following values:"qorus-core": the main system log file"audit": the system audit log file"http": the HTTP log file"mon": the system monitoring log file"alert": the system alert log file"workflow": a workflow log file"service": a service log file"job": a job log file"qdsp": a qdsp process log filelog: the log file path on the host filesystemlog_url: the websocket log URL for the log filename]: (for workflows, services, and jobs) the name of the interfaceversion]: (for workflows, services, and jobs) the version of the interfaceworkflowid]: (for workflows) the ID of the workflowserviceid]: (for services) the ID of the servicejobid]: (for jobs) the ID of the jobservicetype]: (for services) the type of the service ("system" or "user")This URI path provides actions and information related to system mappers
full: optional; parsed with Qore::parse_boolean(); if True then the output hashes will include mapper source informationlist: optional; parsed with Qore::parse_boolean(); if True then a list of mapper names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings with mapper names and brief info is returnedfull option is used, then each hash has the following additional keys:option_source: a hash of the source for the "options" keyfield_source: a hash of the source for the actual mapper logic itself; keys are output field namesids argument from the DBids: (required) a comma-separated string will be split into a list; the mapper names or IDs to reset403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: MAPPER-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given mapper (for more information, see Interface Groups)409 Conflict: MAPPER-ERROR: invalid or unknown mapper"OK" upon successful execution403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: MAPPER-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given mapper (for more information, see Interface Groups)This URI path provides actions and information related to a specific system mapper
option_source: a hash of the source for the "options" keyfield_source: a hash of the source for the actual mapper logic itself; keys are output field names409 Conflict: MAPPER-ERROR: invalid or unknown mapper403 Forbidden: MAPPER-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given mapper (for more information, see Interface Groups)"OK" upon successful execution403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: MAPPER-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given mapper (for more information, see Interface Groups)This REST URI path provides actions and information related to all mapper types
This REST URI path provides actions and information related to a specific mapper type
This REST URI path is the root path for OAuth2 admin functionality
This REST URI path provides actions and information about OAuth2 clients
username (*string): user associated with the clients; can only be specified if the calling user has the USER-CONTROL permission, otherwise the current user is assumedclient_id (string): unique identifier of the clientclient_description (string): the description for the clientusername (string): user associated with the clientpermissions (*list<string>): permissions associated to the client; corresponds to OAuth2 scopescreated (date): record creation timestampmodified (date): record last modification timestamp400 Bad Request: invalid arguments to methodclient_secret value returned cannot be retrieved after this call; it must be stored carefully by the userusername (*string): user associated with the client; can only be specified if the calling user has the USER-CONTROL permission, otherwise the current user is assumedclient_description (string): the description for the OAuth2 clientpermissions (list<string>): list of permissions; corresponds to OAuth2 scopesinserted (OAuth2ClientInsertedInfo): hash with informataion about inserted clientclient_id (string): unique identifier of the clientclient_description (string): the description for the clientclient_secret (string): client secret; this value must be stored as it cannot be retrieved after this callusername (string): user associated with the clientpermissions (*list<string>): permissions associated to the clientcreated (date): record creation timestampmodified (date): record last modification timestamp400 Bad Request: invalid arguments to methodThis REST URI path provides actions and information for system functionality
deleted (string): the client ID deleted404 Not Found: no such clientclient_id (string): unique identifier of the clientclient_description (string): the description for the clientusername (string): user associated with the clientpermissions (*list<string>): permissions associated to the client; corresponds to OAuth2 scopescreated (date): record creation timestampmodified (date): record last modification timestamp404 Not Found: no such clientusername (string): user associated with the clientpermissions (list<string>): list of permissionsupdated (OAuth2ClientInfo): updated client informationclient_id (string): unique identifier of the clientclient_description (string): the description for the clientusername (string): user associated with the clientpermissions (*list<string>): permissions associated to the client; corresponds to OAuth2 scopescreated (date): record creation timestampmodified (date): record last modification timestamp404 Not Found: no such client, invalid arguments to APIclient_secret value returned cannot be retrieved after this call; it must be stored carefully by the userclient_id (string): the client ID of the OAuth2 clientclient_secret (string): the new client secret for the OAuth2 client; this value must be stored as it cannot be retrieved after this call404 Not Found: no such clientThis REST URI path provides OAuth2 authorization code
type (string): either token (access token) or code (authorization code) giving the type of responseclient_id (string): identification of client for which the token/code is generatedredirect_uri (*string): if the client sent a redirect_uri with the authorization code request, it mustcode (string): access token or authorization code valuetype (string): type of code (either "authorization code" or "access token")404 Not Found: invalid arguments to APIThis REST URI path provides actions and information about supported options for various Qorus objects
block: a hash of supported finite state machine block types, each block type key is then assigned to a hash of options.mapper: a hash of supported mapper optionspipeline: a hash of supported pipeline optionsremote: a hash of supported remote connection schemes and supported options per schemesystem: a hash of supported system options that can be overridden in all interfacesThis REST URI path provides actions and information about supported file location schemes in Qorus
list: optional; parsed with Qore::parse_boolean(); if True then a list of supported file location handlers is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of supported file location handlers is returnedThis REST URI path provides actions and information about supported options for Qorus connection objects
list: optional; parsed with Qore::parse_boolean(); if True then a list of supported connection schemes is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of supported connection schemes is returnedThis URI path provides information and actions related to workflow order data.
date: an alternate key for modified desc: return in descending orderids: an alternate key for workflow_instanceid key: an alternate key for keyname keyname: the name of a search key to be used with the keyvalue value(s)keyvalue: the value(s) of workflow order search key(s) to use (optionally used in conjunction with keyname)limit: max number of rows to return, if not given, then the value of the "row-limit" option is used (default: 100)maxmodified: maximum modified datemaxstarted: maximum start dateminstarted: minimum start datemodified: minimum modified date; if this key is not sent with the request, and no keyvaue, keyname or workflow_instanceid keys are sent, then a value one week before the time of the request is assumedoffset: row offsetsort: columns for sorting the resultsstatus: status value(s) (see Workflow, Segment, and Step Status Descriptions for possible values)statuses: an alternate key for status wfid: an alternate key for workflowid workflowid: one or more workflow IDsworkflow_instanceid: workflow_instanceid values(s)name: the name of the workflowversion: the version of the workflowworkflow_instanceid: the workflow order instance IDworkflowid: the workflow IDworkflowstatus: the status of the workflow order instance (see Workflow, Segment, and Step Status Descriptions for possible values)status_sessionid: the application session ID that owns the workflow order instance data or 0 if the data is now owned by any application sessionstarted: the start date/time of the workflow order instancecompleted: the completed date/time for the workflow order instancemodified: the last modified date/time of the workflow order instanceparent_workflow_instanceid: the parent workflow order ID if presentsynchronous: if 1, indicates that the order is being executed synchronouslybusiness_error: a boolean flag indicating if the workflow order has an error status due to a business erroroperator_lock: a string giving the username of the user with an operator lock on the ordernote_count: the number of notes stored against the orderwarning_count: the number of warnings raised against the ordererror_count: the number of errors raised against the ordercustom_status: a custom status for the orderpriority: the priority of the workflow orderscheduled: the future scheduled date for the workflow order (if any)custom_status_desc: a description for the custom status (if any)actions: a list of possible actions on the workflowids: (required) one or more workflow instance IDs to block; a comma-separated string will be split into a listworkflow_status: the status of the workflow order"BLOCK-WORKFLOW-ERROR": invalid status, foreign session id, missing original status, unblock operation already in progress"WORKFLOW-ACCESS-ERROR": the user does not have the right to access the given workflow (for more information, see Interface Groups)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationworkflow_status: the status of the workflow order409 Conflict: CANCEL-WORKFLOW-ERROR: invalid status, foreign session id, missing original status, uncancel operation already in progress403 Forbidden: WORKFLOW-ACCESS-ERROR: Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationorderby: one or more field names for sorting the outputerror: the error text to search (can also include '' characters for use with the LIKE operator; in this case only 1 value can be given)description: the description text to search (can also include '' characters for use with the LIKE operator; in this case only 1 value can be given)info: the info text to search (can also include '' characters for use with the LIKE operator; in this case only 1 value can be givenstepid: limit the search to one or more stepidsseverity: limit the search to one or more severity valuesname: limit the search to one or more step namesversion: limit the search to one or more step versionsretry: limit the search to errors with or without the retry flagbusiness_error: limit the search to errors with or without the business_error flagworkflow_instanceid: limit the search to one or more workflow_instanceidserror_instanceid: limit the search to one or more error_instanceidsmindate: give the lower date range for the error searchmaxdate: give the upper date range for the error searchworkflowid: limit the search to one or more workflowidsworkflowstatus: limit the search to workflow instances with the given status value(s)limit: the maximum number of errors to returnoffset: the starting error to return (use when paging for example)name: the name of the workflowversion: the version of the workflowworkflow_instanceid: the workflow instance IDworkflowid: the workflow IDstepid: the step ID where the error occurredstepname: the name of the step where the error occurredstepversion: the version of the step where the error occurredind: the array step index number where the error occurredworkflowstatus: current status of the workflow (see Workflow, Segment, and Step Status Descriptions for possible values)started: the date and time when the workflow order started processingcompleted: the date and time when the workflow order was completedparent_workflow_instanceid: any parent workflow instance IDcustom_status: the custom status of the workflow order, if anypriority: the priority of the workflow orderscheduled: any scheduled date for the workflow ordererror_instanceid: the error instance IDerror: the error code stringdescription: a description for the error (if any)info: additional information about the error (if any)severity: an error severity code (see Error Severity Codes for possible values)created: the date and time the error was raisedretry: the retry count of the errorbusiness_error: a boolean flag indicating of the error is a business errorcustom_status_desc: a descriptive string for the custom status (if any)mindate: (required) minimum datemaxdate: maximum datewfids: optional workflow IDsseconds: if True then the performance values will be returned as arbitrary-precision numeric values representing seconds, otherwise they will be returned as relative date/time valuesglobal: if True then all workflows will be combined into an overall processing report, if False then each workflow gets a separate line in the output"hourly": hourly grouping"daily": daily grouping"monthly": monthly grouping"yearly": yearly groupingworkflowid: the workflow IDname: the workflow nameversion: the workflow versioncount: the number of workflow orders in the periodminstarted: the minimum workflow order start datemaxcompleted: the maximum workflow order completion date (if any)minduration: the minimum total elapsed order processing time for workflow orders in the period (starting from workflow order creation)avgduration: the average total elapsed order processing time for workflow orders in the period (starting from workflow order creation)maxduration: the maximum total elapsed order processing time for workflow orders in the period (starting from workflow order creation)minprocessing: the minimum order processing time for workflow orders in the period (starting from when then order was first processed)avgprocessing: the average order processing time for workflow orders in the period (starting from when then order was first processed)maxprocessing: the maximum order processing time for workflow orders in the period (starting from when then order was first processed)409 Conflict: ARGUMENT-ERROR: missing mindate skey: (optional) the sensitive data key type; if passed, then svalue must be includedsvalue: (optional) the sensitive data key value; if passed then skey must be includedforce: (optional) allows sensitive data to be deleted for workflow orders with statuses other than OMQ::StatComplete or OMQ::StatCanceledmaxmodified: (optional) maximum modified date of the workflow ordermaxstarted: (optional) maximum start date of the workflow orderminstarted: (optional) minimum start date of the workflow ordermodified: (optional) minimum modified date of the workflow orderstatus: (optional) workflow order status value(s)workflow_instanceid: (optional) workflow_instanceid values(s)workflowid: (optional) workflowid values(s)workflowname: (optional) all accessible versions of the given workflow namename: the name of the workflowversion: the version of the workflowworkflow_instanceid: the workflow order instance IDworkflowid: the workflow IDworkflowstatus: the status of the workflow order instancestatus_sessionid: the application session ID that owns the workflow order instance data or 0 if the data is now owned by any application sessionstarted: the start date/time of the workflow order instancecompleted: the completed date/time for the workflow order instancemodified: the last modified date/time of the workflow order instanceparent_workflow_instanceid: the parent workflow_instanceid if the workflow is a child workflow ordersynchronous: the synchronous flag for the workflow order instancebusiness_error: the business error flag for the workflow order instancearchive: the archive flag for the workflow order instance (presented only if it goes from archive datasource)operator_lock: the username of the user owning the lock on the workflow order instance datanote_count: the number of notes attached to the workflow order instancewarning_count: the warning count of the workflow order instanceerror_count: the error count of the workflow order instancecustom_status: any custom status for the workflow order instancepriority: the priority of the workflow order instancescheduled: the scheduled date for the workflow order instancearchive: if retrieved from the archive datasourceskey: the sensitive data key typesvalue: the sensitive data value; if the svalue key is given in the request, then it's returned decoded, otherwise the encoded version is returned'sensitive_data: the sensitive data hash for the given key and value403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation409 Conflict: SENSITIVE-DATA-ERROR: the request to search for sensitive data arrived over a non-encrypted network connection or skey included without svalue or svalue included without skey 409 Conflict: INVALID-WORKFLOW: the name given in the workflowname parameter does not correspond to a known workflow409 Conflict: ORDER-STATUS-ERROR: a status other than OMQ::StatComplete or OMQ::StatCanceled was passed and the force option was not given and the workflow_instanceid option was usedORDER-STATUS-ERROR is only thrown if the force option is not True and the workflow_instanceid option is used, otherwise ineligible orders are ignoredids: (required) one or more workflow instance IDs to retry; a comma-separated string will be split into a liststeps_updated: (deprecated) always 0 in this version of Qorussegments_updated: the number of segments updatedworkflow_updated: always True in this version of Qorusworkflow_status: always OMQ::StatRetry in this version of Qoruscached: True if the workflow data is currently cached"STATUS-ERROR": workflow data does not have OMQ::StatError, OMQ::StatAsyncWaiting, or OMQ::StatRetry status"SESSION-ERROR": cannot change status for workflow data managed by another Qorus instance (foreign session ID)"RETRY-ERROR": invalid workflow instance ID"WORKFLOW-ACCESS-ERROR": the user does not have the right to access the given workflow (for more information, see Interface Groups)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationskey: (required) the sensitive data key typesvalue: (required) the sensitive data key valuedesc: (optional) return in descending ordermaxmodified: (optional) maximum modified date of the workflow ordermaxstarted: (optional) maximum start date of the workflow orderminstarted: (optional) minimum start date of the workflow ordermodified: (optional) minimum modified date of the workflow orderlimit: (optional) max number of rows to return, if not given, then the value of the "row-limit" option is used (default: 100)offset: (optional) row offsetsort: (optional) columns for sorting the resultsstatus: (optional) workflow order status value(s)workflow_instanceid: (optional) workflow_instanceid values(s)workflowid: (optional) workflowid values(s)workflowname: (optional) all accessible versions of the given workflow namename: the name of the workflowversion: the version of the workflowworkflow_instanceid: the workflow order instance IDworkflowid: the workflow IDworkflowstatus: the status of the workflow order instancestatus_sessionid: the application session ID that owns the workflow order instance data or 0 if the data is now owned by any application sessionstarted: the start date/time of the workflow order instancecompleted: the completed date/time for the workflow order instancemodified: the last modified date/time of the workflow order instanceparent_workflow_instanceid: the parent workflow_instanceid if the workflow is a child workflow ordersynchronous: the synchronous flag for the workflow order instancebusiness_error: the business error flag for the workflow order instancearchive: the archive flag for the workflow order instance (presented only if it goes from archive datasource)operator_lock: the username of the user owning the lock on the workflow order instance datanote_count: the number of notes attached to the workflow order instancewarning_count: the warning count of the workflow order instanceerror_count: the error count of the workflow order instancecustom_status: any custom status for the workflow order instancepriority: the priority of the workflow order instancescheduled: the scheduled date for the workflow order instancearchive: if retrieved from the archive datasourceskey: the sensitive data key typesvalue: the sensitive data valuesensitive_data: the sensitive data hash for the given key and value403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation409 Conflict: SENSITIVE-DATA-ERROR: the request to search for sensitive data arrived over a non-encrypted network connection409 Conflict: INVALID-WORKFLOW: the name given in the workflowname parameter does not correspond to a known workflowworkflow_status: the status of the workflow order"BLOCK-WORKFLOW-ERROR": invalid status, foreign session id, missing original status, block operation already in progress"WORKFLOW-ACCESS-ERROR": Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationworkflow_status: the status of the workflow order"CANCEL-WORKFLOW-ERROR": invalid status, foreign session id, missing original status, cancel operation already in progress"WORKFLOW-ACCESS-ERROR": Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)400 Bad Request: all uncancel operations failed403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation200 OK response is returnedThis REST URI path provides actions and information about specific workflow orders.
name (string): the name of the workflowversion (string): the version of the workflowauthor (*string): the author of the workflowpatch (*string): the workflow patch string (if any)workflow_instanceid (int): the workflow order instance IDworkflowid (int): the ID of the workflowworkflowstatus (string): the status of the workflow order (see Workflow, Segment, and Step Status Descriptions for possible values)status_sessionid (int): the ID of the Qorus application session managing the workflow order data or 0 if noneparent_workflow_instanceid (*int): the workflow order instance ID of the parent order for this workflow if anysubworkflow (*bool): indicates if the parent_workflow_instanceid is the parent workflow order in a subworkflow relationshipsynchronous (bool): indicates if the order is being executed synchronouslyarchive (*bool): indicates if the order has been archivedbusiness_error (bool): indicates if the workflow order has an error status due to a business errorworkflowstatus_orig (*string): if the order status is OMQ::StatBlocked or OMQ::StatCanceled, this value will reflect the original status of the workflow order (see Workflow, Segment, and Step Status Descriptions for possible values)custom_status (*string): a custom status for the orderscheduled (*date): the scheduled datepriority (int): the priority of the workflow orderstarted (date): the date/time the order was createdcompleted (*date): the date/time order processing completedmodified (date): the last modified date/time for the orderoperator_lock (*string): a string giving the username of the user with an operator lock on the ordernote_count (int): the number of notes stored against the orderdeprecated (bool): a boolean value indicating if the workflow is deprecated or not; deprecated workflows are hidden by default in the UIautostart (int): the integer autostart value for the workflowmanual_autostart (bool): a boolean flag set if the autostart value has been changed manually, in which case the manual setting takes precendence over any new definitions loaded with oloadmax_instances (*int): a value limiting the maximum number of execution instances that can run at onceexternal_order_instanceid (*string): a unique external key for the orderstaticdata (*UndefinedHash): a hash of workflow order static datadynamicdata (*UndefinedHash): a hash of workflow order dynamic data (if any)sensitive_data (*SensitiveDataSetInfo): any sensitive data information for the workflow; this information is only present when retrieving the data over a secure (encrypted) connection; the keys are sensitive data key types, values are hashes keyed by sensitive data valueshas_sensitive_data (bool): indicates if the order has sensitive datastepdata (*list<StepDataInfo>): a list of step data informationkeys (*OrderKeySet): a hash of workflow order keys and valueswarning_count (int): the number of warnings raised against the ordererror_count (int): the number of errors raised against the orderretry_count (int): the number of times the order was subject to a RETRY status due to a technical errorStepInstances (list<StepInstanceInfo>): a list of step hashes giving information about the execution status of workflow stepsErrorInstances (*list<ErrorInstanceInfo>): a list of hashes giving information about errors and warnings raised against the orderHierarchyInfo (OrderHierarchySetInfo): a hash of workflow order information; the keys are workflow order instance IDs for all workflow orders linked to each other through parent-child relationships in the hierarchy of the current workflow ordername (string): the name of the workflowversion (string): the version of the workflowworkflow_instanceid (int): the workflow order instance IDworkflowid (int): the ID of the workflowworkflowstatus (string): the status of the workflow order (see Workflow, Segment, and Step Status Descriptions for possible values)status_sessionid (int): the ID of the Qorus application session managing the workflow order data or 0 if noneparent_workflow_instanceid (*int): the workflow order instance ID of the parent order for this workflow if anysubworkflow (*int): if 1, indicates that the parent_workflow_instanceid is the parent workflow order in a subworkflow relationshipsynchronous (int): if 1, indicates that the order is being executed synchronouslyretries (*int): the number of retries executed on the ordernote_count (int): the number of notes stored against the orderbusiness_error (bool): indicates if the workflow order has an error status due to a business errorworkflowstatus_orig (*string): if the order status is OMQ::StatBlocked or OMQ::StatCanceled, this value will reflect the original status of the workflow order (see Workflow, Segment, and Step Status Descriptions for possible values)custom_status (*string): a custom status for the orderscheduled (*date): the scheduled datepriority (int): the priority of the workflow orderstarted (date): the date/time the order was createdcompleted (*date): the date/time order processing completedmodified (date): the last modified date/time for the orderoperator_lock (*string): a string giving the username of the user with an operator lock on the orderpatch (*string): the workflow patch string (if any)author (*string): the author of the workflowdescription (*string): an optional description of the workflowremote (int): the remote status of the workflowmanual_remote (int): if the remote status has been manually changedworkflow_modules (*list<string>): a list of workflow modulesopen (bool): if the current workflow is open for processing nowautostart (int): the autostart valuemanual_autostart (bool): a boolean flag set if the autostart value has been changed manually, in which case the manual setting takes precendence over any new definitions loaded with oloadmax_instances (*int): a value limiting the maximum number of execution instances that can run at onceenabled (bool): if the worklfow is currently enabled for executionsla_threshold (int): the nubmne of seconds that workflow orders should receive a final statushas_detach (bool): if the workflow has detach logiccode (*string): workflow code, if anylanguage (string): the programming language for the workflow codelanguage_info (*UndefinedHash): any language-specific information for the wokflow codeclass_name (*string): the workflow class's name, if anystaticdata_type_path (*string): the type path name for the workflow's static data, if anyerrorfunction_instanceid (*int): the error function instance ID, if anyattach_func_instanceid (*int): the attach function instance ID, if anydetach_func_instanceid (*int): the deatch function instance ID, if anyonetimeinit_func_instanceid (*int): the one time init function instance ID, if anyerrhandler_func_instanceid (*int): the error handler function instance ID, if anyloggerid (*int): the logger ID, if anydeprecated (bool): the deprecated flagcreated (date): the creation datecustom_status_desc (*string): the custom status description, if anyhierarchy_level (int): the level in the workflow order hierarchyerror_count (int): number of errorswarning_count (int): number of warningsAuditEvents (*list<UndefinedHash>): a list of audit information hashesLastModified (date): the last modified date/time of the workflow orderstaticdata_type_path (*string): the type path name for the workflow's static data, if anyactions (*list<string>): a list of possible actions on the workflownotes (*list<NoteInfo>): a list of notes saved against the orderworkflow_status (string): the status of the order after updating403 Forbidden: access or authorization error409 Conflict: exception processing requestnote: (required) a string note that gives the reason for breaking the operator lock"OK" upon successful executionstepid (int): the step ID of the stepind (int): the step instance index value; use 0 for non-array stepsnote (string): a note to be added to the order on why the lock was broken"OK" 400 Bad Request: invalid arguments403 Forbidden: access or authorization error404 Not Found: the given stepid and ind values do not exist in the workflow order or the step is not an asynchronous step with the user-interaction API enabledworkflow_status (string): the status of the order after updating403 Forbidden: access or authorization error409 Conflict: exception processing requestnewdata (*hash<auto>): the new dynamic data for the current workflow order400 Bad Request: invalid or missing argument403 Forbidden: access or authorization erroroptions: (hash) an optional hash of option names and values; if any options are not valid for the workflow, then an exception is raised and the synchronous workflow execution instance is not startedworkflow_instanceid: the workflow instance ID of the orderstatus: the status of the workflowdynamicdata: the dynamic data of the workflow order instance409 Conflict: SHUTDOWN-IN-PROGRESS: cannot start new workflows because the system is shutting down403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)orderby: one or more field names for sorting the outputerror: the error text to search (can also include '' characters for use with the LIKE operator; in this case only 1 value can be given)description: the description text to search (can also include '' characters for use with the LIKE operator; in this case only 1 value can be given)info: the info text to search (can also include '' characters for use with the LIKE operator; in this case only 1 value can be givenstepid: limit the search to one or more stepidsseverity: limit the search to one or more severity valuesname: limit the search to one or more step namesversion: limit the search to one or more step versionsretry: limit the search to errors with or without the retry flagbusiness_error: limit the search to errors with or without the business_error flagerror_instanceid: mit the search to one or more error_instanceidsmindate: give the lower date range for the error searchmaxdate: give the upper date range for the error searchlimit: the maximum number of errors to returnoffset: the starting error to return (use when paging for example)name: the name of the workflowversion: the version of the workflowworkflow_instanceid: the workflow instance IDworkflowid: the workflow IDstepid: the step ID where the error occurredstepname: the name of the step where the error occurredstepversion: the version of the step where the error occurredind: the array step index number where the error occurredworkflowstatus: current status of the workflow (see Workflow, Segment, and Step Status Descriptions for possible values)started: the date and time when the workflow order started processingcompleted: the date and time when the workflow order was completedparent_workflow_instanceid: any parent workflow instance IDcustom_status: the custom status of the workflow order, if anypriority: the priority of the workflow orderscheduled: any scheduled date for the workflow ordererror_instanceid: the error instance IDerror: the error code stringdescription: a description for the error (if any)info: additional information about the error (if any)severity: an error severity code (see Error Severity Codes for possible values)created: the date and time the error was raisedretry: the retry count of the errorbusiness_error: a boolean flag indicating of the error is a business errorcustom_status_desc: a descriptive string for the custom status (if any)note: (required) a string note that gives the reason for setting the operator lock"OK" upon successful executionstepid (*int): the ID of the step to acquire user interaction data from; either this or stepname is requiredstepname (*string): the name of the step to acquire user interaction data from; either this or stepid is requiredworkflow_instanceid (int): the workflow order instance IDstepid (int): the step ID of the stepind (int): the step instance index numberqueuekey (string): the queue key IDqueueid (int): the ID of the async queuequeuename (string): the name of the async queuedata (*UndefinedHash): any step data already present400 Bad Request: missing or invalid arguments403 Forbidden: access or authorization error404 Not Found: no data available on the queue to locklimit: the maximum number of notes to return; if omitted then all notes are returned403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)note (string): the note to create on the order403 Forbidden: access or authorization errorstepid (int): the step ID of the stepind (int): the step instance index value; use 0 for non-array steps"OK" 400 Bad Request: invalid arguments403 Forbidden: access or authorization error, lock held by another user404 Not Found: the given stepid and ind values do not exist in the workflow order or the step is not an asynchronous step with the user-interaction API enableddate: (optional) parsed as a date; this is the new scheduled date to set; if not present, then any scheduled date will be removed"OK" upon successful execution409 Conflict: SESSION-ERROR: cannot reschedule workflow data owned by a foreign session409 Conflict: WORKFLOW-STATUS-ERROR: only workflows with status OMQ::StatReady or OMQ::StatScheduled or blocked or canceled workflows with original status OMQ::StatReady or OMQ::StatScheduled can be rescheduled409 Conflict: RESCHEDULE-ERROR: reschedule failed because workflow order data started processing while the request was being processed403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)steps_updated: (deprecated) always 0 in this version of Qorussegments_updated: the number of segments updatedworkflow_updated: always True in this version of Qorusworkflow_status: always OMQ::StatRetry in this version of Qoruscached: True if the workflow data is currently cached409 Conflict: STATUS-ERROR: workflow data does not have either OMQ::StatError, OMQ::StatAsyncWaiting, or OMQ::StatRetry status409 Conflict: SESSION-ERROR: cannot change status for workflow data managed by another Qorus instance (foreign session ID)409 Conflict: RETRY-ERROR: invalid workflow instance ID403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)skey (string): the sensitive data key typesvalue (string): the sensitive data key valuealiases (*list<string>): zero or more string aliases for the sensitive datadata (*UndefinedHash): the sensitive data hash itself; if omitted then sensitive data is removed for the given skey and svalue valuesmeta (*SensitiveMetaInfo): a hash of metadata for the sensitive dataPURPOSE (auto): free-form information about the purpose of the sensitive dataCATEGORIES (auto): free-form information about the categories of sensitive dataRECIPIENTS (auto): free-form information about the recipients or recipient catories of sensitive dataSTORAGE (auto): free-form information about the storage time or rules for sensitive data"OK" 400 Bad Request: invalid arguments or request made over a non-encrypted connection403 Forbidden: access or authorization errorsteps_updated: number of steps updatedsegments_updated: number of segments updatedworkflow_status: always OMQ::StatErrorold_status: the old workflow data statusqueued_detached_segments: number of detached segment events queuedqueued_subworkflows: number of subworkflow events queuedqueued_async_messages: number of async events queuedqueued_sync_events: number of workflow synchronization events queuedqueued_async_retries: number of async events queuedqueued_retries: number of retry events queuedqueued_fixed_retries: number of retry events with a fixed retry time queued403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)priority: the new order priority from 0 - 999; priority 0 is the highest; 999 is the lowest"OK" upon successful execution409 Conflict: SESSION-ERROR: cannot reschedule workflow data owned by a foreign session409 Conflict: WORKFLOW-STATUS-ERROR workflows with status OMQ::StatComplete cannot have their priority changed403 Forbidden: AUTHORIZATION-ERROR this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: WORKFLOW-ACCESS-ERROR this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)stepid: (required) the step ID to skipind: (optional) one or more step array index values to skip (ranges accepted; ex: "1,3,5-7"); if not present defaults to 0noretry: (optional) parsed with Qore::parse_boolean(); if True then no retry will be executed409 Conflict: SKIP-STEP-ERROR: step is a subworkflow step; step has not been executed in the given workflow order instance; the given workflow instance ID does not exist409 Conflict: STEP-STATUS-ERROR: step status does not allow it to be skipped (ex: IN-PROGRESS, COMPLETE)409 Conflict: SESSION-ERROR: workflow order instance belongs to another Qorus session403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)noretry argument is passed as True.newdata (hash<auto>): the new static data for the current workflow order; must be a non-empty400 Bad Request: invalid or missing argument403 Forbidden: access or authorization errorstepid (int): required: the step ID of the stepind (int): required: the step instance index value; use 0 for non-array stepsnewdata (*UndefinedHash): required: the new dynamic step data for the current workflow order and step; can also be NOTHING which will remove all step data from the current step"OK" 400 Bad Request: invalid arguments403 Forbidden: access or authorization error409 Conflict: cannot lock order for updating, order has COMPLETE status403 Forbidden: access or authorization error404 Not Found: the given stepid and ind values do not exist in the workflow orderworkflow_status (string): the status of the order after updating403 Forbidden: access or authorization error409 Conflict: exception processing requestworkflow_status (string): the status of the order after updating403 Forbidden: access or authorization error409 Conflict: exception processing requestnote: (optional) a string note that gives the reason for removing the operator lock; if not passed, a default note will be added"OK" upon successful executionnewdata: (hash) data to be merged with the existing dynamic data for the current workflow order"OK" upon successful execution403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationpath: (string) the path to the data to be updatedvalue: (auto) any value to be updated at the location provided by path "OK" upon successful execution403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationorderkeys (OrderKeySet): the order keys to replace for the current workflow ordertruncate (*bool): truncate any key values automatically to the length of the column (4000 characters)400 Bad Request: invalid orderkeys argument403 Forbidden: access or authorization error403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)newdata: (YAML-serialized string) the new dynamic data for the current workflow order as a YAML-serialized string; can also be deserialized to NOTHING which will remove all dynamic data from the order"OK" upon successful execution403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation409 Conflict: DYNAMIC-DATA-ERROR: this error is returned if the newdata argument is not a string409 Conflict: YAML-PARSER-ERROR: this error is returned if the YAML string cannot be deserializedskey: (string) the sensitive data key typesvalue: (string) the sensitive data key valuedata: (YAML-serialized string) the new sensitive data for the current workflow order; can also be NOTHING which will remove all sensitive data from the order for the given sensitive data key and valuealiases: (string or list of strings; optional) zero or more aliases for the sensitive data corresponding to the given sensitive data key and valuemeta: (hash; optional) a hash of metadata for the sensitive data with the following recommended keys (recommended keys are not enforced by the API itself):PURPOSE]: free-form information about the purpose of the sensitive dataCATEGORIES]: free-form information about the categories of sensitive dataRECIPIENTS]: free-form information about the recipients or recipient catories of sensitive dataSTORAGE]: free-form information about the storage time or rules for sensitive data"OK" upon successful execution403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation409 Conflict: SENSITIVE-DATA-ERROR: invalid arguments; cannot update sensitive data over a non-encrypted network connection409 Conflict: YAML-PARSER-ERROR: this error is returned if the YAML string cannot be deserializedskey: (string) the sensitive data key typesvalue: (string) the sensitive data key valuealiases]: (list of strings) zero or more string aliases for the sensitive datadata: (YAML-serialized string) the sensitive data hash itself serialized as a YAML string for potential editingmeta]: (hash) a hash of metadata for the sensitive data with the following recommended keys (recommended keys are not enforced by the API itself):PURPOSE]: free-form information about the purpose of the sensitive dataCATEGORIES]: free-form information about the categories of sensitive dataRECIPIENTS]: free-form information about the recipients or recipient catories of sensitive dataSTORAGE]: free-form information about the storage time or rules for sensitive data403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown when Role Based Access Control is enabled and the user does not have the right to access the given workflow (for more information, see Interface Groups)403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation409 Conflict: SENSITIVE-DATA-ERROR: invalid arguments; cannot retrieve sensitive data over a non-encrypted network connection