 |
Qorus Integration Engine®
5.0.12_git
|
|
Qorus Integration Engine®
5.0.12_git
|
This URI path always provides access to the latest REST API; in this case it is identical to /api/v5
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 value of the key in the given queuedata data to post in the queue entry; this data will be passed to the back end function for evaluation| 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 |
This 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 objectThis REST API path provides actions and information about specific class objects
This 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 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 URI path provides access to data provider functionality
types giving type and base_type information to compare and returns a list of the results of each comparison.types: a hash of hashes with the following keys:base_type: required; a hash describing the base type as per above; type hashes have the following keys:type: (required, string) one of connection, datasource, factory, remote, or type name: (required, string) the name of the type, connection, factory, etcpath: (optional, string) the path to the final objectsubtype: (optional, string) the subtype for type = connection options: (optional, hash) create option for type = factory type: required; a hash describing a type; keys as abovetypes argument where the values are boolean values of the results of the type comparisons:True: type is compatible with the base_type; i.e. a variable of type base_type can be assigned a value corresponding to type False: type is not compatible with the base_type; i.e. a variable of type base_type cannot be assigned a value corresponding to type 400 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 and a type arguments and returns a boolean value:True: type is compatible with the base_type; i.e. a variable of type base_type can be assigned a value corresponding to type False: type is not compatible with the base_type; i.e. a variable of type base_type cannot be assigned a value corresponding to type base_type: required; a hash describing the base type as per above; type hashes have the following keys:type: (required, string) one of connection, datasource, factory, remote, or type name: (required, string) the name of the type, connection, factory, etcpath: (optional, string) the path to the final objectsubtype: (optional, string) the subtype for type = connection options: (optional, hash) create option for type = factory type: required; a hash describing a type; keys as above400 Bad Request: missing or invalid "base_type" or "type" arguments404 Not Found: the given type, factory, connection, etc cannot be foundThis 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 access to data factory information
list: 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
This 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 operationrecord: (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 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 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 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 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 mappertype 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 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.
state: a hash of job state data (if any)persistent-state: a hash of persistent job state data (if any)403 Forbidden: JOB-ACCESS-ERROR: the user does not have the right to access the given job (for more information, see Interface Groups)name: the job nameversion: the job versionjobid: the job IDinfo: info about the job disable 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: JOB-ACCESS-ERROR: the user does not have the right to access the given job (for more information, see Interface Groups)name: the job nameversion: the job versionjobid: the job IDinfo: info about the job enable 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: JOB-ACCESS-ERROR: the user does not have the right to access the given job (for more information, see Interface Groups)"OK", "ERR" if notkill() command: 0 if successful, non-zero if not404 Not Found: this response is returned if no process is running for the current workflow403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationstarted jobid 7 "myjob1" after 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: JOB-ACCESS-ERROR: the user does not have the right to access the given job (for more information, see Interface Groups)409 Conflict: API-CALL-ERROR: cannot reset a disabled jobjob_instanceid: the job_instanceidstatus: 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 operation403 Forbidden: JOB-ACCESS-ERROR: the user does not have the right to access the given job (for more information, see Interface Groups)schedule: 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: 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: the job IDname: the job nameschedule]: (if used as the argument) the new job scheduleduration]: (if used as the argument) the new job durationinfo: a string giving a description of the result of the 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 operation403 Forbidden: JOB-ACCESS-ERROR: the user does not have the right to access the given job (for more information, see Interface Groups)409 Conflict: JOB-SCHEDULE-ERROR: neither schedule nor duration parameters given409 Conflict: CRON-ERROR: cron schedule cannot be parsed or 0 second (or non-integer) duration givenactive: (required) parsed with Qore::parse_boolean(); the active state of the jobjobid: the job IDname: the job nameactive: the new active state of the jobinfo: a descriptive string; ex: jobid 7 "myjob1" is already active and runningdb_active: the active state in the DB (can differ from active if the job cannot be started for example)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: JOB-ACCESS-ERROR: the user does not have the right to access the given job (for more information, see Interface Groups)409 Conflict: JOB-ERROR: cannot set expired jobs to activedate: (optional) parsed as a date; the expiry date of the job; if not present any expiry date will be removedjobid: the job IDname: the job nameexpiry_date: the new expiry date for the jobinfo: a descriptive string; ex: jobid 7 "myjob1", expiry date: null, updated expiry date for running 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 operation403 Forbidden: JOB-ACCESS-ERROR: the user does not have the right to access the given job (for more information, see Interface Groups)options: 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: (required) parsed with Qore::parse_boolean(); a boolean value giving the new remote value for the job403 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 operationdata: 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 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 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: the name of the workflowversion: the version of the workflowauthor: the author of the workflowworkflow_instanceid: the workflow order instance IDworkflowid: the ID of the workflowworkflowstatus: the status of the workflow order (see Workflow, Segment, and Step Status Descriptions for possible values)status_sessionid: the ID of the Qorus application session managing the workflow order data or 0 if noneparent_workflow_instanceid: the workflow order instance ID of the parent order for this workflow or NULL if nonesubworkflow: if 1, indicates that the parent_workflow_instanceid is the parent workflow order in a subworkflow relationshipsynchronous: if 1, indicates that the order is being executed synchronouslyerrors: the number of errors raised against the orderbusiness_error: a boolean flag indicating if the workflow order has an error status due to a business errorworkflowstatus_orig: 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: a custom status for the orderscheduled: the scheduled datepriority: the priority of the workflow orderstarted: the date/time the order was createdcompleted: the date/time order processing completedmodified: the last modified date/time for the orderoperator_lock: a string giving the username of the user with an operator lock on the ordernote_count: the number of notes stored against the orderdeprecated: a boolean value indicating if the workflow is deprecated or not; deprecated workflows are by default not displayed in the UIautostart: the integer autostart value for the workflowmanual_autostart: a booelan 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: a value limiting the maximum number of execution instances that can run at onceexternal_order_instanceid: a unique external key for the orderstaticdata: a hash of workflow order static datadynamicdata: a hash of workflow order dynamic data (if any)stepdata: a list of step data information with the following keys:name: the step nameversion: the step versionstepid: the step IDsteptype: the step typearraytype: the step array typedata: list of hashes of the dynamic step data per step indexkeys: a hash of workflow order keys and valueswarning_count: the number of warnings raised against the ordererror_count: the number of errors raised against the orderretry_count: the number of times the order was subject to a RETRY status due to a technical errorStepInstances: a list of step hashes giving information about the execution status of workflow steps; each element is a hash with the following keys:workflow_instanceid: stepid: the ID of the stepind: the step array index starting with 0stepname: the name of the stepstepversion: the version of the stepsteptype: type of the stepstepstatus: the current execution status of the step (see Workflow, Segment, and Step Status Descriptions for possible values)retries: the number of retries executed on the stepskip: a boolean value indicating if the step logic was skippedcustom_status: a custom status for the stepstarted: the date/time the step was first executedcompleted: the date/time step processing completedfunction_instanceid: the function ID of the primary step functionsubworkflow_instanceid: the workflow order ID of any subworkflow order instance (for bound subworkflow steps only)business_error: a boolean flag indicating if the step has an error status due to a business errorErrorInstances: a list of hashes giving information about errors and warnings raised against the order; each element is a hash with the following keys:error_instanceid: a unique ID for the errorworkflow_instanceid: the workflow order instance IDstepid: the stepid where the error was raisedind: the step array index starting with 0 where the error was raisedseverity: the severity of the error (see Error Severity Codes for possible values)retry: 1 if the error caused a retryerror: the string error code for the errordescription: an optional description of the errorinfo: an optional string providing additional information about the errorbusiness_error: a boolean flag indicating if the error is a business errorcreated: the date/time the error was createdHierarchyInfo: 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 order; the values are order information hashes similar to the top-level of the return value of this APIAuditEvents: a list of audit information hashesLastModified: the last modified date/time of the workflow orderactions: a list of possible actions on the workflownotes: a list of notes saved against the order; each element is a REST Order Note Hashworkflow_status: the status of the workflow order409 Conflict: BLOCK-WORKFLOW-ERROR: invalid status, foreign session id, missing original status, unblock operation already in progress403 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)note: (required) a string note that gives the reason for breaking the operator lock"OK" upon successful executionstepid: (int) required: the step ID of the stepind: (int) required: the step instance index value; use 0 for non-array stepsnote: (string) required: a note to be added to the order on why the lock was broken"OK" upon successful execution400 Bad Request: invalid arguments passed to the call403 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 operation403 Forbidden: if the step is locked by another user404 Not Found: the given stepid does not correspond to an asynchronous step with the user-interaction API enabled or does not existworkflow_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: 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)newdata: (hash) the new dynamic data for the current workflow order; can also be 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 operationoptions: (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 execution404 Not Found error if no such data is availablestepid: (int) the ID of the step to acquire user interaction data fromstepname: (string) the name of the step to acquire user interaction data fromstepid (int): the step ID of the stepind (int): the step instance index numberqueueid (int): the ID of the async queuequeuename (string): the name of the async queuedata (*hash): any step data already present400 Bad Request: returned if there is an error with the arguments to the call403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation404 Not Found: this response is returned if no data is available to lock on the queuelimit: 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: the note to create on 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 operationstepid: (int) required: the step ID of the stepind: (int) required: the step instance index value; use 0 for non-array steps"OK" upon successful execution400 Bad Request: invalid arguments passed to the call403 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 operation403 Forbidden: if the step is locked by another user404 Not Found: the given stepid does not correspond to an asynchronous step with the user-interaction API enabled or does not existdate: (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 valuedata: (hash) 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 connectionsteps_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: the new static data for the current workflow order; must be a non-empty hash"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: ORDER-STATIC-DATA-ERROR: the new static data hash cannot be empty409 Conflict errorstepid: (int) required: the step ID of the stepind: (int) required: the step instance index value; use 0 for non-array stepsnewdata: (hash) 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" upon successful execution400 Bad Request: invalid arguments passed to the call403 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 operation404 Not Found: the given stepid and ind do not exist in the current workflow order409 Conflict: REPLACE-STEP-DATA-ERROR: if the workflow order is owned by another Qorus instance, the step data is locked by another user, or the order is COMPLETEstepid: (int) required: the step ID of the stepind: (int) required: the step instance index value; use 0 for non-array steps403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown if 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)404 Not Found: the given stepid and ind values do not exist in the workflow orderworkflow_status: the status of the workflow order409 Conflict: BLOCK-WORKFLOW-ERROR: invalid status, foreign session id, missing original status, unblock operation already in progress403 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)workflow_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: 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)note: (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 executionorderkeys: (hash) the order keys to replace for the current workflow order403 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: ORDER-KEYS-ERROR: the orderkeys argument was missing or not a hash409 Conflict: INVALID-WORKFLOW-KEY: an order key was given that is not valid for the workflow409 Conflict: DUPLICATE-KEY-VALUE: the same value may not appear more than once for any given key403 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 connectionnewdata: (YAML-serialized string) the new static data for the current workflow order as a YAML-serialized string; must be deserialized to a non-empty hash"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: STATIC-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 deserialized403 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: (int) required: the step ID of the stepind: (int) required: the step instance index value; use 0 for non-array stepsnewdata: (YAML-serialized string) required: the new dynamic step data for the current workflow order and step; can also be deserialized to NOTHING which will remove all step data from the current step"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 operation400 Bad Request: returned if the newdata argument is not a string or cannot be parsed as valid YAML404 Not Found: the given stepid and ind values do not exist in the workflow orderstepid: (int) required: the step ID of the stepind: (int) required: the step instance index value; use 0 for non-array steps"null") will be returned.403 Forbidden: WORKFLOW-ACCESS-ERROR: this is exception is thrown if 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)404 Not Found: the given stepid and ind values do not exist in the workflow orderThis REST URI path provides actions and information about specific workflow orders' Asynchronous Queue Objects
stepid the stepid to query. Optional, defaults to 0int the array index offset of the step to query (0 for non-array steps). Optional.The queue info hash has the following keys:
workflow_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_Received| GET-INFO-ERROR | invalid workflow_instanceid |
| 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 |
corrected attribute to True This will effective cause an asynchronous step to be skipped without the back end function being run at all; the step will be processed to OMQ::StatComplete as soon as the corrected queue entry is delivered to workflow execution instance processing this order. See Asynchronous Queue Objects
stepid the stepid to updateind the array index offset of the step to update (0 for non-array steps)| QUEUE-CORRECT-DATA-ERROR | invalid workflow_instanceid or stepid |
| INVALID-WORKFLOW-DATA | no queue data for the given step |
| INVALID-STATUS | queue entry does not have status OMQ::QS_Waiting |
| ALREADY-CORRECTED | queue entry has already been corrected |
| 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 |
This REST URI path provides information about workflow static data types
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 REST URI path provides actions and information related to RBAC permissions
list: optional; parsed with Qore::parse_boolean(); if True then a list of permission names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings with permission names and brief info is returnedname: (required string) the name of the new user permissiondesc: (required string) the description for the new user permission"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 operationThis REST URI path provides actions and information related to a specific RBAC permission
"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 operation"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 operationThis REST API path provides actions and information related to Qorus Data pipelines.
list: optional; parsed with Qore::parse_boolean(); if True then a list of data pipeline names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings of data pipeline information is returnedThis REST API path provides actions and information related to a particular Qorus Data pipeline.
This REST URI path provides actions and information related to Qorus Data pipeline 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. "pipeline:name1", "pipeline: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. "pipeline:name1", "pipeline: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 Data pipeline.
Prefixes can be passed within the config item name or as following: /v5/pipelines/{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. "pipeline:name1", "pipeline: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. "pipeline:name1", "pipeline: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 URI path implements token-based user authentication.
instance-key: Qorus instance identifieromq-version: Qorus executable versionomq-build: Qorus executable git hashqore-version: Qore library versionomq-schema: Qorus system schema infoomq-schema keyThis URI path implements token-based user authentication.
user: the usernamepass: the user's passwordtoken: the token to be used for the sessionThis REST URI path provides actions and information about Qorus releases
component: the component name to search for (implies with_files = True and with_components = True)component_maxdate: the upper date range for the release search for component (implies with_files = True and with_components = True)component_mindate: the lower date range for the release search for component (implies with_files = True and with_components = True)file_maxdate: give the upper date range for the release search for files (implies with_files = True)file_mindate: give the lower date range for the release search for files (implies with_files = True)file_name: the file name to search for; note that this is used with the SQL like operator (implies with_files = True)limit: the maximum number of releases to returnmaxdate: give the upper date range for the release searchmindate: give the lower date range for the release searchoffset: the starting release to return (use when paging for example)with_components: if True then file components are inname: the name of the releasedescription: the description of the releasecreated: the date/time the release was createdmodified: the date/time the release was last modifiedThis REST URI path provides actions and information about a specific Qorus release
name: the name of the releasedescription: the description of the releasecreated: the date/time the release was createdmodified: the date/time the release was last modifiedfiles: a list of file components of the release; each list element is a hash with the following keys:name: the full file pathtype: the type of filehash_type: the type of cryptographic hash for the filehash: the cryptographic hash value of the filecreated: the date/time the file entry was created with the releasemodified: the last modified date/time of the file entrycomponents: a list of object components created from the file; each list element is a hash with the following keys:component: the name of the componentversion: the version of the componentid: the ID of the component (ex: if type = "FUNCTION", then id is a function ID)content_id: the component content IDhash_type: the type of cryptographic hash for the filehash: the cryptographic hash value of the filecreated: the date/time the file entry was created with the releasemodified: the last modified date/time of the file entryThis REST URI path provides actions and information about remote Qorus, user and datasource connections
"datasources": for the /api/remote/datasources"qorus": for the /api/remote/qorus"user": for the /api/remote/user"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 usedThis REST URI path provides actions and information related to Qorus system datasources
list: optional; parsed with Qore::parse_boolean(); if True then a list of datasource names is returnedrtime: optional; 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 datasource names and brief info is returnedwith_passwords: parsed with Qore::parse_boolean(); if True then the pass key is returned in the REST Datasource Connection Hash elements403 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 argument requires permission OMQ::QR_DATASOURCE_CONTROL or OMQ::QR_READ_DATASOURCEname: (required string) the name of the datasource connectiondesc: (required string) the description for the new connectionurl: (required string) the connection string for the new connection. See Qore::SQL::parse_datasource()options: (optional hash) a hash of options for the connection; also accepts "opts" as an alias for this option"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 operation409 Conflict: DATASOURCE-CONNECTION-ERROR: missing or invalid name, desc, url, options arguments - or name and Datasource Hash members409 Conflict: CONNECTION-ERROR: connection already exists; unknown scheme in URLlevel: (int|string) LoggerLevelname: logger name to setadditivity: logger additivity to set400 Bad Request: invalid or missing arguments to REST calllevel: 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 state400 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/qdsp). If set means default loggerid: 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 filenamename: (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 deletedappenderId: (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 filenameinfo: a string indicating that no action was taken; this API no longer has any function403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationinfo: a string confirming the reload 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 operationThis REST URI path provides actions and information related to a specific Qorus system datasource
info: a string confirming the delete 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 operation409 Conflict: DATASOURCE-ERROR: this exception is thrown if the given datasource does not exist or is a system datasourcertime: optional; 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" with_password: parsed with Qore::parse_boolean(); if True then the pass key is returned in the REST Datasource Connection Hash return 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 operationwith_password argument requires permission OMQ::QR_DATASOURCE_CONTROL or OMQ::QR_READ_DATASOURCEdesc: (required string) the description for the new connectionurl: (required string) the connection string for the new connection. See Qore::SQL::parse_datasource()options: (optional hash) a hash of options for the connection; also accepts "opts" as an alias for this optioninfo: a string confirming the update 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 operation409 Conflict: DATASOURCE-ERROR: this exception is thrown if the call tries to modify a locked system datasource or invalid options are passed"min" and "max" datasource options must be present to be used; if only one is present, it is ignoredinfo: a string confirming the disable operation409 Conflict: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationinfo: a string confirming the enable operation409 Conflict: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationok: the status of the pingname: the name of the connectiondesc: the description of the connectionurl: the URL for the connectionopts: a hash of options for the connection (if any)time: the elapsed time for the pinginfo: "OK" if the ping was successful or an error message if notresult: a string representation of the time in seconds (ex: "0.25s")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 operation"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 operationThis URI path provides access to a data provider created from a datasource
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 operationrecord: (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 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 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 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 mapperThis REST URI path provides actions and information related to Qorus remote connections
list: optional; parsed with Qore::parse_boolean(); if True then a list of connection names is returnedmonitored: optional; parsed with Qore::parse_boolean(); if True then only monitored connections are returnedremote: optional; parsed with Qore::parse_boolean(); if True then no loopback connections are returned; default if not present: Falseshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings with connection names and brief info is returned403 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 connectiondesc: (required string) the description for the new connectionurl: (required string) the URL for the new connectionoptions: (optional hash) a hash of options for the connection; also accepts "opts" as an alias for this optioninfo: 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: REMOTE-CONNECTION-ERROR: missing or invalid name, desc, url, or options arguments409 Conflict: CONNECTION-ERROR: connection already exists; unknown scheme in URLinfo: a string confirming the reload 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 operationThis REST URI path provides actions and information related to a specific remote connection
info: a string confirming the delete operation409 Conflict: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationwith_password: (optional bool) include the password in the "url" and "url_hash" 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 operationdesc: (optional string) a new description for the connectionurl: (optional string) a new URL for the connectionoptions: (optional hash) new options for the connection; also accepts "opts" as an alias for this optioninfo: a string describing the connection update403 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: REMOTE-CONNECTION-ERROR: invalid or unparsable "options" keyinfo: a string confirming the enable operation409 Conflict: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationinfo: a string confirming the enable operation409 Conflict: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationinfo: a string confirming the enable operation409 Conflict: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationinfo: a string confirming the enable operation409 Conflict: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationok: the status of the pingname: the name of the connectiondesc: the description of the connectionurl: the URL for the connectionopts: a hash of options for the connection (if any)time: the elapsed time for the pinginfo: "OK" if the ping was successful or an error message if notresult: a string representation of the time in seconds (ex: "0.25s")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 operationThis URI path provides access to a data provider created from a remote 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 operationrecord: (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 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 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 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 mapperThis REST URI path provides actions and information related to Qorus user connections
list: optional; parsed with Qore::parse_boolean(); if True then a list of connection names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings with connection names and brief info is returned403 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 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 user 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: USER-CONNECTION-ERROR: missing or invalid name, desc, url, or options arguments409 Conflict: CONNECTION-ERROR: connection already exists; unknown scheme in URLinfo: a string confirming the reload 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 operationThis REST URI path provides actions and information related to a specific user connection
info: a string confirming the delete 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 operationwith_password: (optional bool) include the password in the "url" and "url_hash" 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 operationdesc: (optional string) a new description for the connectionurl: (optional string) a new URL for the connectionoptions: (optional hash) new options for the connection; also accepts "opts" as an alias for this optiontags: (optional hash) new tags for the connectioninfo: a string describing the connection update403 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: USER-CONNECTION-ERROR: invalid or unparsable "options" keyopts is accepted as an alias for options info: a string confirming the enable 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 operationinfo: a string confirming the enable 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 operationinfo: a string confirming the enable 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 operationinfo: a string confirming the enable 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 operationok: the status of the pingname: the name of the connectiondesc: the description of the connectionurl: the URL for the connectionopts: a hash of options for the connection (if any)time: the elapsed time for the pinginfo: "OK" if the ping was successful or an error message if notresult: a string representation of the time in seconds (ex: "0.25s")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 operationThis URI path provides access to a data provider created from a user 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 operationrecord: (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 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 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 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 mapperThis REST URI path provides actions and information related to Qorus roles
list: optional; parsed with Qore::parse_boolean(); if True then a list of role names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings of role names and descriptions is returned403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationrole: (required) the name of the role to adddesc: (required) the description of the roleperms: (optional) a comma-separated string will be split into a list; a single permission or a list of permissions to add to the role; note that users must have at least the OMQ::QR_LOGIN permission to connect to the servergroups: (optional) a comma-separated string will be split into a list; a single group or a list of groups to add to the roleinfo: a string describing the role clone 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 operation409 Conflict: ROLE-ERROR: missing or invalid role or desc arguments409 Conflict: RBAC-ADD-ROLE-ERROR: invalid role (role already exists)permissions is accepted as an alias for perms for backwards compatibilityThis REST URI path provides actions and information related to a specific role
info: a string describing the role 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: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationdesc: (string) role descriptionperms: (list of strings) a comma-separated string will be split into a list; the new list will replace the current list unless the permission names are preceded by "+" or "-", meaning add or remove a permission, respectively (in which case all permissions must be preceded by a "+" or "-")groups: (list of strings) a comma-separated string will be split into a list; the new list will replace the current list unless the group names are preceded by "+" or "-", meaning add or remove a group, respectively (in which case all group names must be preceded by a "+" or "-")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: RBAC-UPDATE-ROLE-ERROR: no valid keys in hash, invalid permission, invalid grouppermissions is accepted as an alias for perms for backwards compatibilitytarget: (required) the name of the new cloned roledesc: (required) the description of the new cloned roleinfo: a string describing the role clone 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 operation409 Conflict: ROLE-ERROR: missing or invalid target or desc arguments409 Conflict: RBAC-ADD-ROLE-ERROR: invalid role (target already exists)This REST URI path provides actions and information related to Qorus services; the name can also be provided in the format name:version.
status: one of:"running": for only running services (loaded with at least one active thread)"loaded": all loaded services (also running services)"unloaded": only services not loadedlist: optional; parsed with Qore::parse_boolean(); if True then a list of service names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings with service names and descriptions 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 nametype: the type of the service; one of:"system": for system services"user": for user servicesname: the service nameversion: the service versionpatch: the service patch string (if any)desc: the service descriptionauthor: the author of the service (if any)serviceid: the service IDparse_options: a list of symbolic parse options for the service program container (if any)status: the status of the service; one of:"loaded": loaded but not running"running": loaded and running with at least one service thread"unloaded": not loadedlog: the complete path to the service log filethreads: the number of active threads in the serviceautostart: boolean value indicating if the service should be autostarted or notmanual_autostart: booelan flag set if the autostart value has been changed manually, in which case the manual setting takes precendence over any new definitions loaded with oloadloaded: date/time the service was loadedmethods: a list of hashes for each service method; each hash element has the following keys:name: the name of the methoddesc: a description of the methodresources: a REST Service Resource Hash (if any)resource_files: a list of hashes giving service resource file information (if any); each list element has the following keys:type: the type code for the service resourcename: the name of the service resourceoptions: a hash of options set on the servicegroups: a list of interface groups that the service belongs to; each list element is a REST Interface Group Hash (may be empty)alerts: a list of alerts raised against the service; each list element is a REST Alert Hash (may be empty)lib: a REST Library Object Hashlog_url: a complete URL to the websocket source for the service logenabled: a boolean flag indicating if the service is enabled or not; disabled services cannot be loadedconnections: a list of connection objects that this service depends on; each list element is a REST Connection Dependency Hash (may be empty)tags: any tags associated with the service400 Bad Request: returned if the request has invalid argumentslevel: 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 stateloggerid: (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 logger400 Bad Request: invalid or missing arguments to REST calllevel: (int|string) LoggerLevelname: logger name to setadditivity: logger additivity to set400 Bad Request: invalid or missing arguments to REST callappenderId: (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 filenameid: 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 filenameids: (required) one or more service names or IDs to disable; a comma-separated string will be split into a listarg: the service ID or namedisabled: True or Falseserviceid]: the service IDtype]: the type of the service; one of:"system": for system services"user": for user servicesname]: the service nameversion]: the service versioninfo: info about the service enable action or a reason why the request failed; possible failure reasons:"SERVICE-ERROR": unknown service, service not accessible409 Conflict: SERVICE-DISABLE-ERROR: missing ids argumentids: (required) one or more service names or IDs to enable; a comma-separated string will be split into a listarg: the service ID or nameenabled: True or Falseserviceid]: the service IDtype]: the type of the service; one of:"system": for system services"user": for user servicesname]: the service nameversion]: the service versioninfo: info about the service enable action or a reason why the request failed; possible failure reasons:"SERVICE-ERROR": unknown service, service not accessible409 Conflict: SERVICE-ENABLE-ERROR: missing ids argumentids: (required) one or more service names or IDs to start; a comma-separated string will be split into a listarg: the service ID or name (argument for the load operation)loaded: a boolean giving the result of the operationalready_loaded]: (only present if loaded is True) True if the service was already loaded before this call, False if loaded with this callserviceid]: the service IDtype]: the type of the service; one of:"system": for system services"user": for user servicesname]: the name of the serviceversion]: the version of the serviceinfo: information abouit the operation; if the operation failed, a formatted error string will appear here; possible failure reasons:"SERVICE-ERROR": the given service cannot be loaded (does not exist, error initializing the service)"SERVICE-ACCESS-ERROR": the user does not have the right to access the given service (for more information, see Interface Groups, only possible if Role Based Access Control is enabled)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: SERVICE-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)ids: (required) one or more service names or IDs to reload; a comma-separated string will be split into a listload: (optional) will be evaluated with Qore::parse_boolean(); if True then services not already loaded will be loaded with this call; default @ref False, meaning that services not already loaded will not be loaded by this callarg: the service ID or name (argument for the load operation)loaded]: True if the service was already loaded before this call, False if loaded with this callreset]: True if the service was (re)loadedserviceid]: the service IDtype]: the type of the service; one of:"system": for system services"user": for user servicesname]: the name of the serviceversion]: the version of the serviceinfo: information abouit the operation; if the operation failed, a formatted error string will appear here; possible failure reasons:"SERVICE-ERROR": the given service cannot be loaded (does not exist, error initializing the service)"SERVICE-ACCESS-ERROR": the user does not have the right to access the given service (for more information, see Interface Groups, only possible if Role Based Access Control is enabled)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: SERVICE-RESET-ERROR: missing ids argumenttype: the type of service reset; one of:"system": for system services"user": for user servicesname: name of the 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 operationtype: the type of service reset; always "system" for this callname: name of the 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 operationtype: the type of service reset; always "user" for this callname: name of the 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 operationids: (required) one or more service names or IDs to unload; a comma-separated string will be split into a listarg: the service ID or name (argument for the unload operation)loaded]: True if the service was already loaded, False if notunloaded]: True if the service was unloaded, False if notserviceid]: the service IDtype]: the type of the service; one of:"system": for system services"user": for user servicesname]: the name of the serviceversion]: the version of the serviceinfo: information abouit the operation; if the operation failed, a formatted error string will appear here; possible failure reasons:"SERVICE-ERROR": the given service cannot be loaded (does not exist, error initializing the service)"SERVICE-ACCESS-ERROR": the user does not have the right to access the given service (for more information, see Interface Groups, only possible if Role Based Access Control is enabled)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: SERVICE-UNLOAD-ERROR: missing ids argumentThis REST URI path provides actions and information related to Qorus services.
lib_source: (optional) parsed with Qore::parse_boolean(); if True, then the source code for all library objects is returnedmethod_source: (optional) parsed with Qore::parse_boolean(); if True, then the source code for all methods is returned in the body key in each REST Service Method Hashserviceid: the service IDtype: the type of the service; one of:"system": for system services"user": for user servicesname: the name of the serviceversion: the version of the servicedescription: the description of the service (if any)author: the author of the service (if any)parse_options: a list of symbolic parse options for the service program containerautostart: a boolean value indicating if the service should be autostarted or notmanual_autostart: a booelan flag set if the autostart value has been changed manually, in which case the manual setting takes precendence over any new definitions loaded with oloadremote: a boolean value indicating if the service is run as an external process or notenabled: a boolean flag indicating if the service is enabled or not; disabled services cannot be loadedcreated: the date/time the service was createdmodified: the date/time the service was last modifiedmappers: a list of mappers associated with the service (can be NOTHING); each mapper element is a REST Mapper Hashvmaps: a list of value maps associated with the service (can be NOTHING); each value map element is a REST Value Map Hashlatest: a boolean flag indicating if the current contextual service is the latest service of its type and namemethods: a list of REST Service Method Hash elementsgroups: a list of interface groups that the service belongs to; each list element is a REST Interface Group Hash (may be empty)resource_files: a list of resource file hashes (if any); each list element is a hash with the following keys:name: the name of the resourcetype: the type code for the resourcestatus: the status of the service; one of:"loaded": loaded but not running"running": loaded and running with at least one service thread"unloaded": not loadedthreads: the number of threads running in the serviceresources: a REST Service Resource Hashlog_url: a complete URL to the websocket source for the service logoptions: a hash of options set on the serviceconnections: a list of connection objects that this service depends on; each list element is a REST Connection Dependency Hash (may be empty)alerts: a list of alerts raised against the service; each list element is a REST Alert Hash (may be empty)state: a hash of saved service state data (if any); see svc_save_state_data() for more infoautostart: changes the autostart value (see PUT /api/services/{id_or_name}?action=setAutostart)reset: reloads the service (see PUT /api/services/{id_or_name}?action=reset)status: performs the actions listed below depending on the value of the status argument as follows:"loaded": performs a load (see PUT /api/services/{id_or_name}?action=load)"stopped": unloads the service (see PUT /api/services/{id_or_name}?action=unload)enabled: performs the actions listed below depending on the value of the enabled argument as follows:400 Bad Request: invalid or missing arguments to REST calltype: the service type one of:"system": for system services"user": for user servicesname: the service nameversion: the service versionserviceid: the service IDinfo: info about the service disable 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: SERVICE-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)type: the service type one of:"system": for system services"user": for user servicesname: the service nameversion: the service versionserviceid: the service IDinfo: info about the service enable 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: SERVICE-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)"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: SERVICE-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)409 Conflict: SERVICE-ERROR: the given service cannot be loaded (error initializing the service)"OK", "ERR" if notkill() command: 0 if successful, non-zero if not404 Not Found: this response is returned if no process is running for the current 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 operation"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: SERVICE-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)409 Conflict: SERVICE-ERROR: the given service cannot be loaded (error initializing the service)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: SERVICE-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)autostart: (required) the autostart status for the service (parsed with parse_boolean())"OK" upon successful execution400 Bad Request: missing "autostart" hash argument403 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: SERVICE-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)options: a hash of options to set against the service; 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: SERVICE-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)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: SERVICE-OPTION-ERROR: invalid option for service or option cannot be overridden at the service levelremote: (required) parsed with Qore::parse_boolean(); a boolean value giving the new remote value for the service403 Forbidden: SERVICE-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)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: SERVICE-SETREMOTE-ERROR: missing remote argument; cannot update the remote value to True on system servicesdata: a hash of new service 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: SERVICE-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)"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: SERVICE-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)409 Conflict: SERVICE-ERROR: the given service cannot be loaded (error initializing the service)Unloads the current service from the system. If the service is running, it is first stopped. Additionally, any outstanding method calls must return before the service can be unloaded.
"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: SERVICE-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)409 Conflict: SERVICE-NOT-LOADED: this exception is thrown when the service is not loadedPOST stream for the named stream if the service implements that stream.stream: (required) the name of the stream to openDELETE stream for the named stream if the service implements that stream.stream: (required) the name of the stream to openPUT stream for the named stream if the service implements that stream.stream: (required) the name of the stream to openGET stream for the named stream if the service implements that stream.stream: (required) the name of the stream to openUnloads the current service from the system. If the service is running, it is first stopped. Additionally, any outstanding method calls must return before the service can be unloaded.
"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: SERVICE-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)409 Conflict: SERVICE-NOT-LOADED: this exception is thrown when the service is not loadedThis REST URI path provides actions and information for system functionality
Updates authentication labels associated wth the service
"default": default Qorus authentication is used"permissive": all requests are accepted with no authentication necessaryThis REST URI path provides actions and information related to Qorus service 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. "step:1", "workflow:1") or "global" or "default")"is_templated_string": True if the value is a templated string that can be later expanded403 Forbidden: SERVICE-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. "step:1", "workflow:1") 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 Qorus. Prefix can be passed within the config item name or as following: /v3/services/{id_or_name}/config/{name}?prefix={prefix}. service configuration item
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. "service:1", "service:2") or "global" or "default")"is_templated_string": True if the value is a templated string that can be later expanded403 Forbidden: SERVICE-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: 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: SERVICE-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 item400 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: SERVICE-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": (serialized YAML string) the default value of the configuration item"value": (serialized YAML string) the current 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": (serialized YAML string) the list of allowed values for the configuration item if defined"level": the level from where the value is obtained (interface level (e.g. "service:1", "service:2") or "global" or "default")"is_templated_string": True if the value is a templated string that can be later expanded403 Forbidden: SERVICE-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)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 URI path provides actions and information related to Qorus service methods for a given service.
403 Forbidden: SERVICE-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)This REST URI path provides information about service resource files.
This REST URI path provides information about a particular service resource file.
This REST path provides actions and information about service methods
service_status: the status of the service; one of:"loaded": loaded but not running"running": loaded and running with at least one service thread"unloaded": not loadedserviceid: the ID of the serviceservice_name: the name of the serviceservice_type: the type of the service; one of:"system": for system services"user": for user servicesparse_args]: any string here will be parsed with Util::parse_to_qore_value() and used as the method arguments; parse_args takes precedence over args args]: any arguments passed here will be used directly as the method 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 operation409 Conflict: SERVICE-ERROR: invalid method call; missing method nameThis REST URI path provides actions and information about Qorus SLAs
list: optional; parsed with Qore::parse_boolean(); if True then a list of workflow names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings of workflow names and descriptions is returnedname (string; required): the unique name of the SLAunits (string; required): describes the meaning of SLA event values (allowed values: "seconds" and "other"; default: "seconds")description (string; required): the description of the SLA409 Conflict: SLA-ERROR: missing required argument; the given SLA name already exists403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationdesc: return the results in descending ordererr: the error string of unsucessful SLA events; can be a list of strings or a string with "%" characters for SQL like matchingerrdesc: the error description string of unsucessful SLA events; can be a list of strings or a string with "%" characters for SQL like matchingname: the name of the SLA; can be a list of names or a string with "%" characters for SQL like matchinglimit: max number of rows to return, if not given, then the value of the "row-limit" option is used (default: 100)mindate: minimum SLA event timestamp (inclusive, meaning ">=" comparisons used)maxdate: maximum SLA event timestamp (exclusive, meaning "<" comparisons used)offset: row offsetproducer: the producer string of SLA events; can be a list of strings or a string with "%" characters for SQL like matchingslaid: the SLA ID, can be a list of IDssort: columns for sorting the resultssuccess: filter for sucessful calls (1) or errored calls (0)err: the error string of unsucessful SLA events; can be a list of strings or a string with "%" characters for SQL like matchingerrdesc: the error description string of unsucessful SLA events; can be a list of strings or a string with "%" characters for SQL like matchinggrouping: (optional) possible values for reporting performance statistics:"hourly": hourly grouping"daily": daily grouping"monthly": monthly grouping"yearly": yearly groupingname: the name of the SLA; can be a list of names or a string with "%" characters for SQL like matchingmaxdate: maximum SLA event timestamp (exclusive, meaning "<" comparisons used)mindate: minimum SLA event timestamp (inclusive, meaning ">=" comparisons used)producer: the producer string of SLA events; can be a list of strings or a string with "%" characters for SQL like matchingslaid: the SLA ID, can be a list of IDssuccess: filter for sucessful calls (1) or errored calls (0)This REST URI path provides actions and information about a particular Qorus SLA
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 operationdesc: return the results in descending ordererr: the error string of unsucessful SLA events; can be a list of strings or a string with "%" characters for SQL like matchingerrdesc: the error description string of unsucessful SLA events; can be a list of strings or a string with "%" characters for SQL like matchinglimit: max number of rows to return, if not given, then the value of the "row-limit" option is used (default: 100)mindate: minimum SLA event timestamp (inclusive, meaning ">=" comparisons used)maxdate: maximum SLA event timestamp (exclusive, meaning "<" comparisons used)offset: row offsetproducer: the producer string of SLA events; can be a list of strings or a string with "%" characters for SQL like matchingsort: columns for sorting the resultserr: the error string of unsucessful SLA events; can be a list of strings or a string with "%" characters for SQL like matchingerrdesc: the error description string of unsucessful SLA events; can be a list of strings or a string with "%" characters for SQL like matchinggrouping: (optional) possible values for reporting performance statistics:"hourly": hourly grouping"daily": daily grouping"monthly": monthly grouping"yearly": yearly groupingmaxdate: maximum SLA event timestamp (exclusive, meaning "<" comparisons used)mindate: minimum SLA event timestamp (inclusive, meaning ">=" comparisons used)producer: the producer string of SLA events; can be a list of strings or a string with "%" characters for SQL like matchingsuccess: filter for sucessful calls (1) or errored calls (0)job (string): the name of the 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 operationservice (string): the name of the user servicemethod (string): the name of the service method403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationjob (string): the name of the jobjob (string): the name of the jobslaid (int): the SLA ID set on the given 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 operationservice (string): the name of the user servicemethod (string): the name of the service methodservice (string): the name of the user servicemethod (string): the name of the service methodslaid (int): the SLA ID set on the given user service method403 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 specific workflow steps
list: optional; parsed with Qore::parse_boolean(); if True then a list of step names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings with step names, versions, and stepids is returnedlist nor short options are passed as above).This REST API path provides actions and information about specific workflow steps
Returns a hash of information about the current step.
functions: if the step is a class step with step functions, this element is returned as a list of REST Function Hash elements with the following additional key:type: a string specifying the role the function fulfils for the step; one of:"primary": the primary step function"validation": the validation function"array": the array function"async-end": the back end functionclass: if the step is a new-style step implemented by a single class, then this element is returned as a REST Class Hashdesc: the step descriptionconfig: a hash of step configuration item information keyed by configuration item and with hash values with the following keys:"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"strictly_local": if the configuration item is defined strictly on local level"config_group": the group of the configuration item"allowed_values": the list of allowed values for the configuration item if definedThis REST URI path provides actions and information related to Qorus step 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"strictly_local": if the configuration item is defined strictly on local level"config_group": the group of the configuration item"allowed_values": the list of allowed values for the configuration item if defined Note: to obtain values the workflows/{id_or_name}/stepinfo/{id_or_name}/config REST API should be used"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"strictly_local": if the configuration item is defined strictly on local level"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) Note: to obtain value the workflows/{id_or_name}/stepinfo/{id_or_name}/config REST API should be usedThis REST URI path provides actions and information related to a particular Qorus. Prefix can be passed within the config item name or as following: /v3/steps/{id_or_name}/config/{name}?prefix={prefix}. step configuration item
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"strictly_local": if the configuration item is defined strictly on local level"config_group": the group of the configuration item"allowed_values": the list of allowed values for the configuration item if defined Note: to obtain value the workflows/{id_or_name}/stepinfo/{id_or_name}/config REST API should be usedvalue: 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 item400 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"strictly_local": if the configuration item is defined strictly on local level"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) Note: to obtain value the workflows/{id_or_name}/stepinfo/{id_or_name}/config REST API should be usedinfo: 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 URI path provides actions and information about workflow synchronization events
list: optional; parsed with Qore::parse_boolean(); if True then a list of workflow synchronization event names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings with workflow synchronization event names and brief info is returneddesc: parsed with Qore::parse_boolean(); if True, return in descending ordereventkey: the event key valueeventname: the event type nameid: one or more event type IDslimit: max number of rows to returnmaxmodified: if present, parsed as a date; maximum modified datemodified: if present, parsed as a date; minimum modified dateoffset: row offsetposted: the event posted status (True or False)sort: a comma-separated string will be split into a list;columns for sorting the resultsThis REST URI path provides actions and information about workflow synchronization event types
desc: parsed with Qore::parse_boolean(); if True, return in descending ordereventkey: the event key valueeventname: the event type namelimit: max number of rows to returnmaxmodified: if present, parsed as a date; maximum modified datemodified: if present, parsed as a date; minimum modified dateoffset: row offsetposted: the event posted status (True or False)sort: a comma-separated string will be split into a list;columns for sorting the resultseventkey: (required) the workflow synchronization event 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 operation409 Conflict: POST-ERROR: missing eventkey argumentThis REST URI path provides actions and information about a particular workflow synchronization event key
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 operationThis REST URI path provides actions and information for system functionality
instance-key: (string) the system instance keysession-id: (int) the application session idomq-version: (string) the version of the serverqore-version: (string) the version of the underlying qore library usedmodules: (hash) a hash of module info as returned by Qore::get_module_hash()datamodel-version: (string) the version of the datamodel expected by the serveromq-schema: (string) "user@dbname" string for the system "omq" datasourceomq-driver: (string) driver name for the system "omq" datasourceomq-db-version: (string) database server version for the system "omq" datasourceomquser-schema: (string) "user@dbname" string for the "omquser" datasourceomquser-driver: (string) driver name for the "omquser" datasourceomquser-db-version: (string) database server version for the "omquser" datasourcestarttime: (date) date and time the server was startedhostname: (string) hostname where the server is runningpid: (int) PID of the server processthreads: (int) count of currently active threadsschema-properties: (hash) hash of actual schema properties (identical to system property domain "omq")omq_dir: (string) the application directory or "LSB" for Linux Standard Base filesystem integrationcluster_info: a hash keyed by node name with values as hashes as follows:node_priv: (int) total private memory user by the cluster per nodenode_priv_str: (string) total private memory user by the cluster per node as a stringnode_ram: (int) total RAM on the nodenode_ram_str: (string) total RAM on the node as a stringnode_ram_in_use: (int) in use RAM on the nodenode_ram_str: (string) in use RAM on the node as a stringnode_cpu_count: (int) the number of CPUs on the nodenode_load_pct: (float) the average load on the machine over the last minutemem_history: a list of hashes giving up to 10 historical memory changes on the node with the following keys in each hash:timestamp: the timestamp of the changeage: (float) the age in fractional seconds of the timestampnode_priv: (int) total RAM user by the cluster per nodenode_priv_str: (string) total RAM user by the cluster per node as a stringnode_ram_in_use: (int) in use RAM on the nodenode_ram_str: (string) in use RAM on the node as a stringnode_cpu_count: (int) the number of CPUs on the nodenode_load_pct: (float) the average load on the machine over the last minuteproc_count: (int) the number of processes running on the nodeproc_history: a list of hashes giving up to 10 historical process count changes on the node with the following keys in each hash:timestamp: (date) the timestamp of the changeage: (float) the age in fractional seconds of the timestampcount: (int) the number of processes at that timeprocesses: (hash) a hash keyed by cluster process name where values are process info hashesorder_stats: (list) a list of workflow order processing statistics; list values are OrderSummaryOutputInfo hashes with combined statistics for all workflowsauth_label_values: (list<string>) a list of supported values for service auth labelslogfile: (string) path to system log filehttp_logfile: (string) path to system HTTP server log filemonitoring_logfile: (string) path to system monitoring log filealert_logfile: (string) path to system alert log filecache_size: (int) the current size of the workflow order data cacheshutting_down: (bool) a flag if the system is shutting downbuild-type: (string) the type of build of the server ("Production" or "Debug")runtime-properties: (hash) a hash of runtime propertiesalert-summary: (hash) a hash with the following keys:transient: (int) number of transient alertsongoing: (int) number of ongoing alertsdebug: system debugging flag (when True then more information is provided with exceptions)health: a string color code for the health of the system with the following values:"GREEN": good health"YELLOW": warning"RED": problemssystem_log_url: a URL to the websocket source for the main system logaudit_log_url: a URL to the websocket source for the audit loghttp_log_url: a URL to the websocket source for the HTTP server logmon_log_url: a URL to the websocket source for the monitoring logalert_log_url: a URL to the websocket source for the alert loglimits: a hash of system limit information with the following keys:nofile: the maximum number of descriptors available to qorus processesnproc: the maximum number of threads in a single Qorus process400 Bad Request: invalid or missing arguments to REST calllevel: (int|string) LoggerLevelname: logger name to setadditivity: logger additivity to set400 Bad Request: invalid or missing arguments to REST calllevel: 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 stateloggerid: (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) system (audit, alert, monitoring, http, qorus-core, qorus-master, qdsp) type.id: required; (int); id of the appender to be deletedid: 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 filenamename: (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 stateiface_kind: the type of interface (workflow, service, or job)name: the name of the interfaceversion: the version of the interfaceid: the ID of the interfacelabel: a string in the format: name:version "OK" "OK" upon successful execution"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 operationtimeout: (optional) a timeout in seconds; the currently running system will be killed if it does not shut down within this time period; if not given, the default timeout is 2 minutes (120 seconds)"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 operation"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 operationflag: (optional) parsed with Qore::parse_boolean(); if True then system debugging is enabled, if False, then it is disabled; default value if not present: Truesystem-debugging: the system debugging setting as a boolean value"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 operation409 Conflict: SHUTDOWN-ALREADY-IN-PROGRESS: system shutdown is already in progress"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 operationstream: (optional) the name of the stream to return; can be:"DataStream": returns a short output DataStream of lists of hashes"EchoDataStream": returns an input/output DataStream where the input is immediately returned as outputstream: (optional) the name of the stream to return; can be:"DataStream": returns a short output DataStream of lists of hashes"EchoDataStream": returns an input/output DataStream where the input is immediately returned as outputstream: (optional) the name of the stream to return; can be:"DataStream": returns a short output DataStream of lists of hashestoken: (required) the token stringThis URI path provides ability to customize the Qorus alert logger
400 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 additivityappenders: (list of hashes) list of appender hashesinterface_table_name: (string) system (audit, alert, monitoring, http, qorus-core, qorus-master, qdsp) type. 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 callThis REST URI path provides actions and information related to system alerts
remote: (optional) the name of a remote Qorus connection to retrieve alerts for and add to the return valuesummary: (optional) parsed with Qore::parse_boolean(); if True the return value is a hash with the following keys:"cutoff": the transient cut off date used"transient": the count of transient alerts"ongoing": the count of ongoing alertscutoff: (optional) parsed as a date; the cutoff date/time for transient alerts (only used when summary is True); transient events after this point in time are not considered in the summarized resultsummary option is passed (see above for details)This REST URI path provides actions and information related to ongoing system alerts
remote: (optional) the name of a remote Qorus connection to retrieve ongoing alerts for and add to the return valueThis REST URI path provides actions and information related to transient system alerts
remote: (optional) the name of a remote Qorus connection to retrieve transient alerts for and add to the return valuemax: (optional) the maximum number of local alerts to return; defaults to 50 if not givenThis REST URI path provides actions and information about the system RPC API
method: (required) the string method name to call; if no "." characters are found in the method name, then it is prefixed with "omq.system."; if the method starts with "system." or "user.", then "omq." is prefixed to the method; if the method starts with "group." or "job.", then "omq.system." is prefixed to the method nameparse_args]: any string here will be parsed with Util::parse_to_qore_value() and used as the method arguments; parse_args takes precedence over args args]: any arguments passed here will be used directly as the method arguments409 Conflict: API-ERROR: missing or invalid "method" keyThis URI path provides ability to customize the Qorus audit logger
400 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 additivityappenders: (list of hashes) list of appender hashesinterface_table_name: (string) system (audit, alert, monitoring, http, qorus-core, qorus-master, qdsp) type. 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 callThis REST URI path provides information about authentication labels
authlabelid: (string) key for the hash value assigned a value of a list of hashes with the following keys:authlabelid: (string) unique identifier of the labelserviceid: (int) the service ID againvalue: (string) the value of the authentication labelservicename: (string) the name of the serviceThis REST URI path provides actions and information related to Qorus configuration item values on the global level
config-items: list of hashes describing config item values, each hash has the following keys:name: name of the config itemprefix: prefix of the config item (optional)level: level of the config item 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 operation400 Bad Request: returned if the request has no config-items key"name": the name of the configuration item"prefix": the prefix of the configuration item"type": the type of the configuration item"value": the value of the configuration item"is_set": True if the value is set otherwise False"allowed_values": the list of allowed values for the configuration item if defined"is_templated_string": True if the value is a templated string that can be later expandedname: the name of the configuration itemprefix: the prefix of the configuration item (optional)value: the value of the configuration item; must be compatible with the item's declared type403 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: QR_SERVER_CONTROL: 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)400 Bad Request: returned if the request has no value or name keysconfig-items: list of hashes describing config item values, each hash has the following keys:name: name of the config itemprefix: prefix of the config item (optional)interface-type: interface type (job, service, step, workflow, global)interface-name: name of the interface (required if interface type is not global)interface-version: version of the interface (required if interface type is not global)value: value of the config item403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation400 Bad Request: returned if the request has no config-items keyname: the name of the configuration itemprefix: the prefix of the configuration item (optional)value: (YAML-serialized string) the value of the configuration item400 Bad Request: returned if the request has no value or name 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 operationconfig-items: list of hashes describing config item values, each hash has the following keys:name: name of the config itemprefix: prefix of the config item (optional)interface-type: interface type (job, service, step, workflow, global)interface-name: name of the interface (required if interface type is not global)interface-version: version of the interface (required if interface type is not global)value: value of the config item (YAML-serialized string)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 operation400 Bad Request: returned if the request has no config-items key"name": the name of the configuration item"prefix": the prefix of the configuration item"type": the type of the configuration item"value": (YAML-serialized string) the value of the configuration item"is_set": True if the value is set otherwise False"allowed_values": the list of allowed values for the configuration item if defined (each element is a YAML-serialized string)"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 specific Qorus global configuration item. Prefix can be passed within the config item name or as following: /v3/system/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"value": the value of the configuration item"is_set": True if the value is set otherwise False"allowed_values": the list of allowed values for the configuration item if defined"is_templated_string": True if the value is a templated string that can be later expandedvalue (required): 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 operation409 Conflict: CONFIG-ITEM-ERROR: this exception is thrown if an invalid type is given for the given configuration itemvalue (YAML-serialized string): the value of the configuration item400 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"value": (YAML-serialized string) the value of the configuration item"is_set": True if the value is set otherwise False"allowed_values": the list of allowed values for the configuration item if defined (each element is a YAML-serialized string)"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 URI path provides actions and information about system health
transient: the number of transient alertsongoing: the number of ongoing alertshealth: a string color code for the health of the system with the following values:"GREEN": good health"YELLOW": warning"RED": problemsinstance-key: the instance key for the systemremote: a list of health information for remotely-monitored Qorus instances with the same keys as this hash (minus "remote")hash: (5 members) transient : 0 ongoing : 123 health : "RED" instance-key : "quark-1" remote : <EMPTY LIST>
This URI path provides ability to customize the Qorus http logger
400 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 additivityappenders: (list of hashes) list of appender hashesinterface_table_name: (string) system (audit, alert, monitoring, http, qorus-core, qorus-master, qdsp) type. 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 callThis REST URI path provides actions and information related to Qorus HTTP listeners
list: optional; parsed with Qore::parse_boolean(); if True then a list of listener names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings of listener names and descriptions is returnedThis REST URI path provides actions and information related to a specific HTTP listener
"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 operationflag: (optional) if present, parsed with Qore::parse_boolean(); if True then verbose logging is enabled for the current listener, if False, then it is disabled; default value if not present True"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 operationoption argument passedoption: (required) an integer product of Listener Log Options combined with binary or"OK" upon successful execution400 Bad Request: missing "option" argument403 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 ability to customize Qorus system logger appenders
id: required; (int); id of the appender to be deletedid: (string) id of appender to getappenderId: (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 filenamename: (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, LoggerAppender File, 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 filenameReturns all system loggers
loggerid: (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 loggerThis REST URI path provides actions and information related to the system metadata cache.
workflows: a list of workflow IDs to reload in the metadata cache and resetservices: a list of service IDs to reload in the metadata cache and to resetjobs: a list of job IDs to reload in the metadata cache and to resetmappers: a list of mapper IDs to reload in the metadata cachevmaps: a list of value map IDs to reload in the metadata cachefunctions: a list of functions IDs to reload in the metadata cacheclasses: a list of class IDs to reload in the metadata cacheconstants: a list of constant IDs to reload in the metadata cachequeues: a list of queue IDs to reload in the metadata cacheevents: a list of event IDs to reload in the metadata cachesteps: a list of step IDs to reload in the metadata cacheconfig_values: a list of config item names to reload in the metadata cachetypes: a list of type paths to reload in the metadata cacheworkflows: the number of workflows updated in the metadata cacheservices: the number of services updated in the metadata cachejobs: the number of jobs updated in the metadata cachemappers: the number of mappers updated in the metadata cachevmaps: the number of value maps updated in the metadata cachefunctions: the number of functions updated in the metadata cacheclasses: the number of classes updated in the metadata cacheconstants: the number of constants updated in the metadata cachequeues: the number of queues updated in the metadata cacheevents: the number of events updated in the metadata cachesteps: the number of steps updated in the metadata cacheconfig_values: the number of configuration item values updated in the metadata cacheworkflow_reset: a hash of workflow reset info; see the return value of PUT /api/workflows?action=reset for a description of this hashservice_reset: a hash of service reset info; see the return value of PUT /api/services?action=reset for a description of this hashjob_reset: a hash of job reset info; see the return value of PUT /api/jobs?action=reset for a description of this hashtypes: the number of types in the metadata cache409 Conflict: METADATA-RELOAD-ERROR: unknown metadata keys passedworkflows: requires OMQ::QR_WORKFLOW_CONTROL, OMQ::QR_WORKFLOW_EXEC_CONTROL, or OMQ::QR_RESET_WORKFLOWservices: requires OMQ::QR_SERVICE_CONTROL or OMQ::QR_RESET_SERVICEjobs: requires OMQ::QR_JOB_CONTROL or OMQ::QR_RESET_JOBmappers: requires OMQ::QR_MAPPER_CONTROL or OMQ::QR_RELOAD_MAPPERvmaps: requires OMQ::QR_VALUE_MAP_CONTROL or OMQ::QR_RELOAD_VALUE_MAPtypes: requires OMQ::QR_TYPE_CACHE_CONTROL or OMQ::QR_TYPE_CACHE_RELOADREST metadata URI path
409 Conflict: CLASS-ERROR: class does not existREST metadata URI path
409 Conflict: CLASS-ERROR: class does not existREST metadata URI path
REST metadata URI path
REST metadata URI path
409 Conflict: CONSTANT-ERROR: constant does not existREST metadata URI path
409 Conflict: CONSTANT-ERROR: constant does not existREST metadata URI path
REST metadata URI path
REST metadata URI path
REST metadata URI path
REST metadata URI path
409 Conflict: FUNCTION-ERROR: function cannot be foundREST metadata URI path
409 Conflict: FUNCTION-ERROR: function cannot be foundREST metadata URI path
REST metadata URI path
with_deprecated (bool): include deprecated workflows in return list (default: do not include)REST metadata URI path
REST metadata URI path
409 Conflict: JOB-ERROR: job does not existREST metadata URI path
409 Conflict: JOB-ERROR: job does not existREST metadata URI path
REST metadata URI path
REST metadata URI path
409 Conflict: JOB-ERROR: job does not existREST metadata URI path
REST metadata URI path
name: the name of the classversion: the version of the classpatch: the patch string for the classdescription: the description of the classcreated: the date/time the class was createdmodified: the date/time the class was last modifiedREST metadata URI path
name: the name of the constantversion: the version of the constantpatch: the patch string for the constantdescription: the description of the constantcreated: the date/time the constant was createdmodified: the date/time the constant was last modifiedREST metadata URI path
name: the name of the eventdesc: the description of the eventREST metadata URI path
409 Conflict: OMQMAP-LOOKUPFUNC-ERROR: this error will be thrown if the function ID passed is not a valid function IDREST metadata URI path
jobid: the job id (always same as the argument)name: the name of the jobversion: the version of the jobdescription: the description of the jobactive: a boolean flag indicating if the job is active or not; active jobs will be running unless they are a member of a disabled groupcreated: the date/time the job was createdmodified: the date/time the job was last modifiedREST metadata URI path
name: the name of the mapperversion: the version of the mapperpatch: the patch string for the mapperdescription: the description of the mapperauthor: the author of the mappertype: the type or class of the mapperfields: the source of the mapper field description hashoptions: the mapper's option hashcreated: the date/time the mapper was createdmodified: the date/time the mapper was last modifiedREST metadata URI path
name: the name of the queueserviceid: the service associated with the queueREST metadata URI path
type: either "system" or "user" name: the name of the serviceversion: the version of the servicepatch: the patch string for the servicedescription: the description of the servicecreated: the creation date/time of the servicemodified: the date/time the service was last modifiedautostart: boolean value for autostart statusmanual_autostart: boolean value for the manual_autostart flagREST metadata URI path
type: either "system" or "user" name: the name of the serviceversion: the version of the servicepatch: the patch string for the servicedescription: the description of the servicecreated: the creation date/time of the servicemodified: the date/time the service was last modifiedautostart: boolean value for autostart statusmanual_autostart: boolean value for the manual_autostart flagREST metadata URI path
name: the name of the SLAtype: the type of the SLAdescription: the description of the SLAREST metadata URI path
verbose: if True then more information is returnedREST metadata URI path
ids: one or more stepids to lookupverbose: if True then more information is returnedREST metadata URI path
name: the name of the value mapversion: the version of the value mappatch: the patch string for the value mapdescription: the description of the value mapauthor: the author of the value maptype: the type or class of the value mapcreated: the date/time the value map was createdmodified: the date/time the value map was last modifiedREST metadata URI path
verbose: if True then additional step and function information is included in the return valueREST metadata URI path
409 Conflict: MAPPER-ERROR: mapper does not existREST metadata URI path
409 Conflict: MAPPER-ERROR: mapper does not existREST metadata URI path
REST metadata URI path
REST metadata URI path
REST metadata URI path
REST metadata URI path
REST metadata URI path
See also PUT /api/v3/system/metadata?action=reload
workflows: a list of workflow IDs to reload in the metadata cache and resetservices: a list of service IDs to reload in the metadata cache and to resetjobs: a list of job IDs to reload in the metadata cache and to resetmappers: a list of mapper IDs to reload in the metadata cachevmaps: a list of value map IDs to reload in the metadata cachefunctions: a list of functions IDs to reload in the metadata cacheclasses: a list of class IDs to reload in the metadata cacheconstants: a list of constant IDs to reload in the metadata cachequeues: a list of queue IDs to reload in the metadata cacheevents: a list of event IDs to reload in the metadata cachesteps: a list of step IDs to reload in the metadata cacheconfig_values: a list of config item names to reload their values in the metadata cacheworkflows: the number of workflows updated in the metadata cacheservices: the number of services updated in the metadata cachejobs: the number of jobs updated in the metadata cachemappers: the number of mappers updated in the metadata cachevmaps: the number of value maps updated in the metadata cachefunctions: the number of functions updated in the metadata cacheclasses: the number of classes updated in the metadata cacheconstants: the number of constants updated in the metadata cachequeues: the number of queues updated in the metadata cacheevents: the number of events updated in the metadata cachesteps: the number of steps updated in the metadata cacheconfig_values: the number of configuration item values updated in the metadata cacheworkflow_reset: a hash of workflow reset info; see the return value of PUT /api/workflows?action=reset for a description of this hashservice_reset: a hash of service reset info; see the return value of PUT /api/services?action=reset for a description of this hashjob_reset: a hash of job reset info; see the return value of PUT /api/jobs?action=reset for a description of this hash409 Conflict: METADATA-RELOAD-ERROR: unknown metadata keys passedworkflows: requires OMQ::QR_WORKFLOW_CONTROL, OMQ::QR_WORKFLOW_EXEC_CONTROL, or OMQ::QR_RESET_WORKFLOWservices: requires OMQ::QR_SERVICE_CONTROL or OMQ::QR_RESET_SERVICEjobs: requires OMQ::QR_JOB_CONTROL or OMQ::QR_RESET_JOBmappers: requires OMQ::QR_MAPPER_CONTROL or OMQ::QR_RELOAD_MAPPERvmaps: requires OMQ::QR_VALUE_MAP_CONTROL or OMQ::QR_RELOAD_VALUE_MAPobject_type can be one of following PUT calls:
REST metadata URI path
lvcreated: the creation date/time of the latest version of the classlastversion: the version string of the latest versionREST metadata URI path
REST metadata URI path
lvcreated: the creation date/time of the latest version of the constantlastversion: the version string of the latest version REST metadata URI path
REST metadata URI path
workflow_event_typeid: the id of the eventdesc: the description of the eventREST metadata URI path
lvcreated: the creation date/time of the latest version of the functionlastversion: the version string of the latest versionREST metadata URI path
REST metadata URI path
jobid: the job idname: the name of the job (always same as the argument)version: the version of the jobdescription: the description of the jobactive: a boolean flag indicating if the job is active or not; active jobs will be running unless they are a member of a disabled groupcreated: the date/time the job was createdmodified: the date/time the job was last modifiedREST metadata URI path
REST metadata URI path
REST metadata URI path
queueid: the queueid of the queueserviceid: the service associated with the queueREST metadata URI path
lvcreated: the creation date/time of the latest version of the servicelastversion: the version string of the latest versionREST metadata URI path
REST metadata URI path
slaid: the ID of the SLAtype: the type of the SLAdescription: the description of the SLAREST metadata URI path
name: the name of the steplvcreated: the creation date/time of the latest version of the steplastversion: the version string of the latest versionREST metadata URI path
REST metadata URI path
REST metadata URI path
REST metadata URI path
REST metadata URI path
REST metadata URI path
409 Conflict: SERVICE-ERROR: service does not existREST metadata URI path
409 Conflict: SERVICE-ERROR: service does not existREST metadata URI path
REST metadata URI path
REST metadata URI path
REST metadata URI path
REST metadata URI path
REST metadata URI path
409 Conflict: STEP-ERROR: step cannot be foundREST metadata URI path
409 Conflict: STEP-ERROR: step cannot be foundREST metadata URI path
REST metadata URI path
REST metadata URI path
REST metadata URI path
409 Conflict: VALUE-MAP-ERROR: value map does not existREST metadata URI path
409 Conflict: VALUE-MAP-ERROR: value map does not existREST metadata URI path
REST metadata URI path
REST metadata URI path
REST metadata URI path
REST metadata URI path
REST metadata URI path
409 Conflict: WORKFLOW-ERROR: workflow does not existREST metadata URI path
409 Conflict: WORKFLOW-ERROR: workflow does not existREST metadata URI path
This REST URI path provides information related to the system metadata maps and lookups.
This set of API calls provides a thread-safe cache for internal Qorus data. The underlying functionality provided by this service has been moved into the Qorus server to avoid race conditions and dependencies with the service infrastructure. Qorus internally and Qorus system services no longer use this service for metadata lookups, but rather use internal functionality directly.
This URI path provides ability to customize the Qorus monitoring logger
400 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 additivityappenders: (list of hashes) list of appender hashesinterface_table_name: (string) system (audit, alert, monitoring, http, qorus-core, qorus-master, qdsp) type. 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 callThis REST URI path provides actions and information related to system options; see System Options for more information
hash: optional (parsed with Qore::parse_boolean()); if True then the return type is a hash keyed by option name instead of a listhash argument is not set; each element in the list is a REST System Option Hash"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 operationoptions: a hash of options; 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())409 Conflict: OPTION-ERROR: one or more options given was invalid or could not be setThis REST URI path provides actions and information related to specific system options; see System Options for more information
value: (required) the new value for the option"OK" upon successful execution400 Bad Request: missing "value" argument409 Conflict: OPTION-ERROR: there was an error setting the optionThis REST URI path provides actions and information related to system processes
This REST URI path provides actions and information related to a specific system process
"OK", "ERR" if notkill() command: 0 if successful, non-zero if not403 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 related to a system properties.
domain: (optional) a system property domain to retrieve values forkey: (optional) a system property key in the given domain; if key is given then domain must also be passeddomain value is passeddomain value is passed and the domain exists, otherwise NOTHINGdomain and key values are passed and the property exists"qorus_properties" tag are only informational and are not used when importing. The "omq" domain is not exported."omq" domain.{qorus_properties: {domain1: {key1: "value", key2: "value"},
^attributes^: {instance: "quark-1", schema-version: "3.1.0",
schema-compatibility: "3.1.0", schema-load-compatibility: "3.1.0"}}}domains: (optional) a list of domains to import; a comma-separated string will be split into a list"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 operation409 Conflict: PROP-ERROR: serialized value exceeds 4000 bytes (column limit)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 operationprops: (required) must be a hash keyed by domain assigned to key-value property hashes; any "omq" domain is ignored403 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: PROP-ERROR: serialized value exceeds 4000 bytes (column limit) or invalid type assigned to domain keydomain: (required) a string giving the system property domain for the key-value pairkey: (required) a string giving the property key value in the given domainparse_args]: any string here will be parsed with Util::parse_to_qore_value() and used as the property value; parse_args takes precedence over args args]: arguments passed here will be used directly as the system property value"INSERT": the property was created"UPDATE": the property was updated"DELETE": the property was deleted (existing key, no value passed)"IGNORED": if a non-existent key should be deleted403 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: UPDATE-ERROR: changes attempted in the "omq" domain409 Conflict: SYSTEM-PROPERTY-ERROR: the given key already exists in the given property domain409 Conflict: PROP-ERROR: serialized value exceeds 4000 bytes (column limit)arg: (required) must be a hash in the format domain.key.value for updating, inserting, or deleting"INSERT", "UPDATE", "DELETE" and "IGNORED" keys with integer values corresponding to the number of operations performed (deleting a non-existent key or domain causes a "IGNORED" value to be returned).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: UPDATE-ERROR: changes attempted in the "omq" domain409 Conflict: PROP-ERROR: serialized value exceeds 4000 bytes (column limit)This REST URI path provides actions and information related to a specific system property domain.
"DELETE" (and "IGNORED" keys in case of a race condition with a competing delete operation on the same system property domain) with integer values corresponding to the number of operations performed.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: UPDATE-ERROR: changes attempted in the "omq" domainkey: (optional) one or more property values in the domain to return; if the string is a comma-separated list, it will be interpreted as a list of keyskey argument as above)arg: (required) a hash giving all key-value pairs for the new system property domain"INSERT" (and "UPDATE" in case of a race condition with a parallel request writing to the same system property domain) keys with integer values corresponding to the number of operations performed403 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: UPDATE-ERROR: changes attempted in the "omq" domain409 Conflict: SYSTEM-PROPERTY-ERROR: the given key already exists in the given property domain409 Conflict: PROP-ERROR: serialized value exceeds 4000 bytes (column limit)key: (required) a string giving the property key value in the current domainparse_args]: any string here will be parsed with Util::parse_to_qore_value() and used as the property value; parse_args takes precedence over args args]: arguments passed here will be used directly as the system property value"INSERT": the property was created"UPDATE": the property was updated"DELETE": the property was deleted (existing key, no value passed)"IGNORED": if a non-existent key should be deleted403 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: UPDATE-ERROR: changes attempted in the "omq" domain409 Conflict: PROP-ERROR: serialized value exceeds 4000 bytes (column limit)arg: (required) a key-value hash for updating, inserting, or deleting system properties in the current domain"INSERT", "UPDATE", "DELETE" and "IGNORED" keys with integer values corresponding to the number of operations performed (deleting a non-existent key or domain causes a "IGNORED" value to be returned).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: UPDATE-ERROR: changes attempted in the "omq" domain409 Conflict: PROP-ERROR: serialized value exceeds 4000 bytes (column limit)This REST URI path provides actions and information related to a specific system property key.
"DELETE": the property was deleted"IGNORED": if a non-existent key should be deleted (only possible with this API with a race condition where the property was deleted in another thread during this request)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: UPDATE-ERROR: changes attempted in the "omq" domainparse_args]: any string here will be parsed with Util::parse_to_qore_value() and used as the property value; parse_args takes precedence over arg arg]: the argument passed here will be used directly as the system property value"INSERT": the property was created"UPDATE": the property was updated (only possible with this API with a race condition where the property was created in another thread during this request)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: UPDATE-ERROR: changes attempted in the "omq" domain409 Conflict: SYSTEM-PROPERTY-ERROR: the given key already exists in the given property domain409 Conflict: PROP-ERROR: serialized value exceeds 4000 bytes (column limit)parse_args]: any string here will be parsed with Util::parse_to_qore_value() and used as the property value; parse_args takes precedence over args args]: arguments passed here will be used directly as the system property value"INSERT": the property was created (only possible with this API with a race condition where the property was deleted in another thread during this request)"UPDATE": the property was updated"DELETE": the property was deleted (existing key, no value passed)"IGNORED": if a non-existent key should be deleted (only possible with this API with a race condition where the property was deleted in another thread during this request)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: UPDATE-ERROR: changes attempted in the "omq" domain409 Conflict: PROP-ERROR: serialized value exceeds 4000 bytes (column limit)This URI path provides ability to customize the qorus-core: Qorus Core Cluster Process process logger
400 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 additivityappenders: (list of hashes) list of appender hashesinterface_table_name: (string) system (audit, alert, monitoring, http, qorus-core, qorus-master, qdsp) type. 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 callThis URI path provides ability to customize the qorus: Qorus Cluster Master Process process logger
400 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 additivityappenders: (list of hashes) list of appender hashesinterface_table_name: (string) system (audit, alert, monitoring, http, qorus-core, qorus-master, qdsp) type. 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 callloaded: the date/time Role Based Access Control information was loadedusers: the number of users cachedroles: the number of roles cachedpermissions: a list of REST Permission Hash elementsenabled: True if Role Based Access Control is enabledgroups: the number of interface groups cachedproviders: a hash of providers keyed by descriptive name; values are hashes with the following keys:loaded: the date/time the provider was loadedstorage: a boolean value indicating whether the provides supports user-defined storage or not"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 operationThis REST URI path provides actions and information related to Qorus application sessions
ended_maxdate: (optional) give the upper date range for the session end dateended_mindate: (optional) give the lower date range for the session end datehostname: (optional) the hostname to search forid: (optional) the session IDkey: (optional) the instance key namelimit: (optional) the maximum number of sessions to returnlist: (optional) parsed with Qore::parse_boolean(); if True then a list of session names is returnedshort: (optional) parsed with Qore::parse_boolean(); if True then a list of short strings of session names and descriptions is returnedstarted_maxdate: (optional) give the upper date range for the session start datestarted_mindate: (optional) give the lower date range for the session start dateoffset: (optional) the starting release to return (use when paging for example)status: (optional) one or more session status valuesurl: (optional) the HTTP URL for the instanceversion: (optional) the Qorus version stringlist and short are not used, then this API returns list of hashes for sessions matched; each hash has the following keys:id: the session IDkey: the instance key for the sessionstatus: status of the sessionhostname: the hostname hosting the Qorus process running the sessionurl: the primary URL for the application sessionversion: the Qorus version for the sessionstarted: the date/time the session startedended: the date/time the session endedThis REST API path provides actions and information related to the system SQL cache
system: returns information about system objects as well (in the "omq" datasource)count: the number of times accessedcreated: the date/time the object was cacheddatasource: (optional) a string giving the datasource to clear all objects forname: (optional) the name of the object to clear; if this argument is given, then datasource must also be given"OK" upon successful executionThis REST URI path provides actions and information related to the system UI
This REST URI path provides actions and information related to system UI extensions
This REST URI path provides actions and information related to a specific system UI extension
This REST URI path provides actions and information about user HTTP services.
title: the title of the HTTP serviceurl: the full URL to the serviceservice: the name of the serviceversion: the version of the serviceserviceid: the service IDThis URI path provides ability to customize Qorus system logger configurations
400 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 additivityappenders: (list of hashes) list of appender hashesinterface_table_name: (string) system (audit, alert, monitoring, http, qorus-core, qorus-master, qdsp) type. 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 callThis REST URI path provides actions and information related to Qorus users
list: optional; parsed with Qore::parse_boolean(); if True then a list of user names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings of user names and descriptions is returned403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operationusername: (required) the username to addpass: (required) the password for the username: (required) the name of the userroles: (optional) a single role or a list of roles to add to the user; note that the user must have at least the OMQ::QR_LOGIN permission to connect to the server403 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: RBAC-ADD-USER-ERROR: invalid user, invalid role, invalid groupuser is also accepted as an alias for username desc is also accepted as an alias for name This REST URI path provides actions and information related to a particular user
info: a string describing the user 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 operationpass: (string) passwordname: (string) user descriptionstorage: (hash) updated key-value pairs for server-side user storage; set a key to NOTHING to delete the keyroles: (list of strings) a comma-separated string will be split into a list; the new list will replace the current list unless the role names are preceded by "+" or "-", meaning add or remove a role, respectively (in which case all role names must be preceded by a "+" or "-"); to remove all roles for a user, send an empty list here403 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: RBAC-UPDATE-USER-ERROR: invalid user, no valid keys in hash, invalid roleThis URI path provides actions and information related to Qorus value maps
list: optional; parsed with Qore::parse_boolean(); if True then a list of value map names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings with value map names and brief info is returned403 Forbidden: VALUEMAP-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 value map (for more information, see Interface Groups)ids: (required) a comma-separated string will be split into a list; the value map names or IDs to reset"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: VALUEMAP-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 value map (for more information, see Interface Groups)409 Conflict: VALUE-MAP-ERROR: invalid or unknown value map"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 operationThis URI path provides actions and information related to a specific value map
403 Forbidden: VALUEMAP-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 value map (for more information, see Interface Groups)403 Forbidden: VALUEMAP-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 value map (for more information, see Interface Groups)key: (required) the value map key to look up403 Forbidden: VALUEMAP-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 value map (for more information, see Interface Groups)409 Conflict: VALUEMAP-LOOKUP-ERROR: missing key argument key"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: VALUEMAP-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 value map (for more information, see Interface Groups)key: (required) the value map key to create or updatevalue: (optional) the value to set; if not present, then the given key will be deletedenabled: (optional) parsed with Qore::parse_boolean(); if True then the key is immediately usable; if not present the default is False"DELETED": the key was deleted"IGNORED": the key to be deleted did not exist"CREATED": the key-value pair was created"UPDATED": the key-value pair was updated403 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: VALUEMAP-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 value map (for more information, see Interface Groups)This URI path provides actions and information related to a specific value map value
403 Forbidden: VALUEMAP-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 value map (for more information, see Interface Groups)This URI path allows workflows to be queried and for actions on multiple workflows to be performed; this is the URI path parent of workflow-specific actions as well.
deprecated: optional; parsed with Qore::parse_boolean(); if False then no deprecated workflows will be returned; default Truelist: optional; parsed with Qore::parse_boolean(); if True then a list of workflow names is returnedshort: optional; parsed with Qore::parse_boolean(); if True then a list of short strings of workflow names and descriptions is returneddate: optional; parsed as a date; the minimum date for historical workflow order overview information; if omitted then defaults to the past 24 hourssqlcache: optional; parsed with Qore::parse_boolean(); if False then no SQL cache will be used for historical info; default Truetags: 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 nameids: (required) one or more workflow names or IDs to modify; a comma-separated string will be split into a listarg: the workflow ID or nameupdated: True or Falseautostart: the new autostart value for the workflowworkflowid]: the workflow IDname]: the workflow nameversion]: the workflow versioninfo: info about the workflow update action or a reason why the request failedstopped]: the number of execution instances stopped409 Conflict: WORKFLOW-SETAUTOSTART-ERROR: missing ids argument; autostart value cannot be negativelevel: (int|string) LoggerLevelname: logger name to setadditivity: logger additivity to set400 Bad Request: invalid or missing arguments to REST call400 Bad Request: invalid or missing arguments to REST calllevel: 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 stateloggerid: (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 loggerappenderId: (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 filenameid: 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 filenameids: (required) one or more workflow names or IDs to disable; a comma-separated string will be split into a listcount: number of workflow execution instances disableddetails: a list of hashes providing details of the individual workflow disable actions with the following keys
409 Conflict: WORKFLOW-DISABLE-ERROR: missing ids argumentids: (required) one or more workflow names or IDs to enable; a comma-separated string will be split into a list409 Conflict: WORKFLOW-ENABLE-ERROR: missing ids argument409 Conflict: SHUTDOWN-IN-PROGRESS: disabled workflows cannot be enabled while the system is shutting downids: (required) one or more workflow names or IDs to modify; a comma-separated string will be split into a listarg: the workflow ID or nameupdated: True or Falseautostart: the new autostart value for the workflowworkflowid]: the workflow IDname]: the workflow nameversion]: the workflow versioninfo: info about the workflow update action or a reason why the request failedstarted]: the number of execution instances started409 Conflict: WORKFLOW-SETAUTOSTART-ERROR: missing ids argument; cannot set a positive autostart value on a workflow with the deprecated flag setorderby: 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: 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 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 ids: (required) one or more workflow names or IDs to reset; a comma-separated string will be split into a listcount: number of workflow execution instances disableddetails: a list of hashes providing details of the individual workflow reset actions with the following keys
409 Conflict: WORKFLOW-RESET-ERROR: missing ids argumentname: the name of the workflow that was resetversion: the version of the workflow that was resetworkflowid: the workflow ID of the workflow that was resetcount: the number of workflow execution instances affectedids: (required) one or more workflow names or IDs to modify; a comma-separated string will be split into a listautostart: (required) an integer value giving the new autostart value for the workflow(s)started 409 Conflict: WORKFLOW-SETAUTOSTART-ERROR: missing ids or autostart argument; autostart value is negative; cannot set a positive autostart value on a workflow with the deprecated flag setids: (required) one or more workflow names or IDs to modify; a comma-separated string will be split into a listdeprecated: (required) a value (processed with Qore::parse_boolean()) indicating whether or not the workflows should have their deprecated flag set (True) or removed (False)arg: the workflow ID or nameupdated: True or Falseworkflowid]: the workflow IDname]: the workflow nameversion]: the workflow versionstopped]: a hash keyed by workflow description where the values are the lists of all execution instance IDs stopped for that workflowinfo: info about the workflow update action or a reason why the request failed409 Conflict: WORKFLOW-SETDEPRECATED-ERROR: missing ids or deprecated argument409 Conflict: SHUTDOWN-IN-PROGRESS: disabled workflows cannot be enabled while the system is shutting downids: (required) one or more workflow names or IDs to start; a comma-separated string will be split into a list409 Conflict: WORKFLOW-START-ERROR: missing ids argument409 Conflict: SHUTDOWN-IN-PROGRESS: workflows cannot be started while the system is shutting downids: (required) one or more workflow names or IDs to stop; a comma-separated string will be split into a listcount: 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 workflowdetails: a list of hashes providing details of the individual workflow stop actions with the following keys
409 Conflict: WORKFLOW-STOP-ERROR: missing ids argumentcount: 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 stoppedThis REST URI path provides actions and information about a particular workflow.
To ensure that a given workflow order is only created once for a given unique key value, make sure your workflow defines order keys, and use one of the following options to guarantee uniqueness of the order:
global_unique_key workflow_specific_unique_key workflow_unique_key external_order_instanceid]: (string) the external order instance ID for the workflow data; either this key or staticdata is requireddynamicdata]: (hash) the initial dynamic data for the orderglobal_unique_key]: (optional hash) a hash giving one or more unique order keys for the order (across all workflows regardless of workflowid, name, or version); if this key already exists for any order in the system, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order keyorderkeys]: (hash) a hash of order keys for the orderparent_workflow_instanceid]: (int) a loosely-coupled workflow that will be marked as the parent of this workflowpriority]: (int) the order priority (default OMQ::DefaultOrderPriority) from 0 - 999; priority 0 is the highest; 999 is the lowestscheduled]: (date) the earliest date and time the order can be processed; if this date is given as a future date/time value and a OMQ::StatReady status is given, then the initial status of the workflow order data instance will be automatically changed to OMQ::StatScheduled instead of OMQ::StatReadysensitive_data]: (hash) a hash of sensitive data information for the workflow; this key can only be used when submitting the data over a secure (encrypted) connection; the keys are sensitive data key types, values are hashes keyed by sensitive data values, and the hash values have the following keys:aliases]: (list of strings) zero or more string aliases for the sensitive datadata: (hash) the sensitive data hash itselfmeta]: (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 datastaticdata]: (hash) the static data for the order; either this key or external_order_instanceid is requiredstatus]: (string) the initial order status (default OMQ::StatReady); must be either OMQ::StatReady or OMQ::StatBlockedworkflow_specific_unique_key]: (optional string) a hash giving one or more unique order keys for the particular workflowid (which matches a unique name and workflow version); if this key already exists for an order with the target workflowid, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order keyworkflow_unique_key]: (optional string) a hash giving one or more unique order keys for the particular workflow by name only (across all workflows with the same name regardless of version); if this key already exists for a workflow order with the same name, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order keyworkflow_instanceid the workflow instance ID of the workflow order instance ID created403 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: a workflow order was submitted with sensitive data over a non-encrypted network connection409 Conflict: SUBMIT-ORDER-ERROR: invalid status value409 Conflict: ORDER-DATA-ERROR: missing either external_order_instanceid or staticdata, unknown workflow; invalid keys or sensitive data format409 Conflict: DUPLICATE-ORDER-KEY: the given unique key already exists in the defined scope409 Conflict: WORKFLOW-KEY-ERROR: invalid workflow key givenglobal_unique_key, workflow_specific_unique_key, and workflow_unique_key options can be used to ensure that given workflow order data is only created once; note that any archiving schema is also searched when checking for duplicate keys. These options may be combined, but it's recommended to use no more than one key for uniqueness.403 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: WORKFLOW-SETAUTOSTART-ERROR: autostart value cannot be negative; cannot change the autostart value on a workflow with the deprecated flag setname: the workflow nameversion: the workflow versionworkflowid: the workflow IDinfo: info about the workflow disable action403 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 operationname: the workflow nameversion: the workflow versionworkflowid: the workflow IDinfo: info about the workflow enable 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 operation409 Conflict: SHUTDOWN-IN-PROGRESS: disabled workflows cannot be enabled while the system is shutting down403 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)To ensure that a given workflow order is only created once for a given unique key value, make sure your workflow defines order keys, and use one of the following options to guarantee uniqueness of the order:
global_unique_key workflow_specific_unique_key workflow_unique_key external_order_instanceid]: (string) the external order instance ID for the workflow data; either this key or staticdata is requireddynamicdata]: (hash) the initial dynamic data for the orderglobal_unique_key]: (optional hash) a hash giving one or more unique order keys for the order (across all workflows regardless of workflowid, name, or version); if this key already exists for any order in the system, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order keyorderkeys]: (hash) a hash of order keys for the orderparent_workflow_instanceid]: (int) a loosely-coupled workflow that will be marked as the parent of this workflowpriority]: (int) the order priority (default OMQ::DefaultOrderPriority) from 0 - 999; priority 0 is the highest; 999 is the lowestsensitive_data]: (hash) a hash of sensitive data information for the workflow; this key can only be used when submitting the data over a secure (encrypted) connection; the keys are sensitive data key types, values are hashes keyed by sensitive data values, and the hash values have the following keys:aliases]: (list of strings) zero or more string aliases for the sensitive datadata: (hash) the sensitive data hash itselfmeta]: (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 datastaticdata]: (hash) the static data for the order; either this key or external_order_instanceid is requiredworkflow_specific_unique_key]: (optional string) a hash giving one or more unique order keys for the particular workflowid (which matches a unique name and workflow version); if this key already exists on an order with the target workflowid, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order keyworkflow_unique_key]: (optional string) a hash giving one or more unique order keys for the particular workflow by name only (across all workflows with the same name regardless of version); if this key already exists for a workflow order with the same name, then the order creation will fail with a DUPLICATE-ORDER-KEY error; the hash key must be a valid order key, and the value is the unique key value; this value will also be created as an order keyworkflow_instanceid: the workflow instance ID of the orderstatus: the status of the workflow orderdynamicdata: the dynamic data of the workflow order instance403 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: SHUTDOWN-IN-PROGRESS: cannot start new workflows because the system is shutting down409 Conflict: SENSITIVE-DATA-ERROR: a workflow order was submitted with sensitive data over a non-encrypted network connection409 Conflict: ORDER-DATA-ERROR: missing either external_order_instanceid or staticdata, unknown workflow; invalid keys or sensitive data format409 Conflict: DUPLICATE-ORDER-KEY: the given unique key already exists in the defined scope409 Conflict: WORKFLOW-KEY-ERROR: invalid workflow key givenSynchronous workflow order processing only completes when the workflow order reaches a COMPLETE or ERROR status unless the system or the workflow execution instance is manually stopped while the order is being processed, in which case other statuses can be returned (ex: CANCELED).
staticdata]: the static data for the order; either this key or external_order_instanceid is requiredexternal_order_instanceid]: the external order instance ID for the workflow data; either this key or staticdata is requireddynamicdata]: the initial dynamic data for the orderorderkeys]: a hash of order keys for the orderpriority]: the order priority (default OMQ::DefaultOrderPriority) from 0 - 999; priority 0 is the highest; 999 is the lowestparent_workflow_instanceid]: a loosely-coupled workflow that will be marked as the parent of this workflowoptions]: (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 (int): the order ID of the order being executed sychronouslyexecid (int): the synchronous workflow execution instance ID403 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: SHUTDOWN-IN-PROGRESS: cannot start new workflows because the system is shutting down403 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: WORKFLOW-SETAUTOSTART-ERROR: cannot set a positive autostart value on a workflow with the deprecated flag set"OK", "ERR" if notkill() command: 0 if successful, non-zero if not404 Not Found: this response is returned if no process is running for the current workflow403 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: 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 searchworkflowstatus: 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)404 Not Found error if no such data is availablestepid: (int) the ID of the step to acquire user interaction data fromstepname: (string) the name of the step to acquire user interaction data fromstepid (int): the step ID of the stepind (int): the step instance index numberqueueid (int): the ID of the async queuequeuename (string): the name of the async queuedata (*hash): any step data already present400 Bad Request: returned if there is an error with the arguments to the call403 Forbidden: AUTHORIZATION-ERROR: this exception is thrown when Role Based Access Control is enabled and the user does not have sufficient privileges for the operation404 Not Found: this response is returned if no data is available to lock on the queue"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 operationautostart: (required) an integer value giving the new autostart value for the workflow(s)403 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: WORKFLOW-SETAUTOSTART-ERROR: missing autostart argument; autostart value is negative; cannot set a positive autostart value on a workflow with the deprecated flag setdeprecated: (required) a value (processed with Qore::parse_boolean()) indicating whether or not the workflow should have its deprecated flag set (True) or removed (False)403 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: WORKFLOW-SETDEPRECATED-ERROR: missing deprecated argument409 Conflict: SHUTDOWN-IN-PROGRESS: disabled workflows cannot be enabled while the system is shutting downoptions: 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 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: 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: WORKFLOW-OPTION-ERROR: invalid option for workflow or option cannot be overridden at the workflow levelremote: (required) parsed with Qore::parse_boolean(); a boolean value giving the new remote value for the workflow403 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: WORKFLOW-SETREMOTE-ERROR: missing remote argument; cannot update the remote value on a workflow with the deprecated flag setsla: (required) a value giving the new SLA timeout value as an integer in seconds for the workflow403 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: WORKFLOW-SETSLA-ERROR: missing or invalid sla argument; cannot update the remote value on a workflow with the deprecated flag setcount: (optional) the number of execution instances to start; defaults to 1mode: (optional) the workflow execution instance mode; defaults to OMQ::WM_Normal (also may be OMQ::WM_Recovery)name: the workflow nameversion: the workflow versionids: the execution IDs startedexec: a list of execution instance hashes running for this workflow403 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: SHUTDOWN-IN-PROGRESS: cannot start new workflows because the system is shutting down"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 operationThis REST URI path provides actions and information related to Qorus workflow configuration item values
"name": the name of the configuration item"prefix": the prefix of the configuration item"type": the type of the configuration item"value": the current value of the configuration item on this level"is_set": True if the value is set otherwise False"allowed_values": the list of allowed values for the configuration item if defined"is_templated_string": True if the value is a templated string that can be later expanded403 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)name: the name of the configuration itemvalue: 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: 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)"name": the name of the configuration item"prefix": the prefix of the configuration item"type": the type of the configuration item"value": (YAML-serialized string) the current value of the configuration item on this level"is_set": True if the value is set otherwise False"allowed_values": the list of allowed values for the configuration item if defined (each element is a YAML-serialized string)"is_templated_string": True if the value is a templated string that can be later expandedname: the name of the configuration itemvalue: (YAML-serialized string) the value of the configuration item400 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: 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 URI path provides actions and information related to a particular Qorus. Prefix can be passed within the config item name or as following: /v3/workflows/{id_or_name}/config/{name}?prefix={prefix}. workflow configuration item
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"value": the value of the configuration item"is_set": True if the value is set otherwise False"allowed_values": the list of allowed values for the configuration item if defined"is_templated_string": True if the value is a templated string that can be later expanded403 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)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: 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)value: (YAML-serialized string) the value of the configuration item400 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: 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)"name": the name of the configuration item"prefix": the prefix of the configuration item"type": the type of the configuration item"value": (YAML-serialized string) the value of the configuration item"is_set": True if the value is set otherwise False"allowed_values": the list of allowed values for the configuration item if defined (each element is a YAML-serialized string)"is_templated_string": True if the value is a templated string that can be later expanded403 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)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 URI path provides actions and information about workflow order data instance 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 operationdescription: (string) the new description of the errorseverity: (string) a severity code for the error (if not present OMQ::ES_Major is assumed); for possible values see Error Severity Codesretry_flag: (bool) parsed with Qore::parse_boolean(); a retry flag value (if not present then False is assumed)business_flag: (bool) parsed with Qore::parse_boolean(); a boolean business flag value (if not present then False is assumed)retry_delay_secs: (optional int) an optional retry value in seconds (only used if retry_flag is also True)"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 REST URI path provides actions and information about workflow execution instances for a particular workflow.
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 logThis REST URI path provides actions and information about workflow orders for the current workflow.
date: an alternate key for modified desc: return in descending orderids: an alternate key for workflow_instanceid 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 dateoffset: 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 workflow_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 orderretry_count: the number of times the order was subject to a RETRY status due to a technical errorcustom_status: a custom status for the orderpriority: the priority of the workflow orderscheduled: the future scheduled date of the workflow order (if any)custom_status_desc: a description for the custom status (if any)actions: a list of possible actions on the workfloworderby: 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: 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 searchworkflowid: limit the search to one or more workflowidsworkflowstatus: limit the search to workflow instances with the given status value(s) (see Workflow, Segment, and Step Status Descriptions for possible values)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 order (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)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 TrueTOTAL: the total number of orders matchedmindate: (required) minimum datemaxdate: maximum dateseconds: 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 This REST URI path provides actions and information about a particular workflow order of a given workflow type
name: the name of the workflowversion: the version of the workflowauthor: the author of the workflowworkflow_instanceid: the workflow order instance IDworkflowid: the ID of the workflowworkflowstatus: the status of the workflow order (see Workflow, Segment, and Step Status Descriptions for possible values)status_sessionid: the ID of the Qorus application session managing the workflow order data or 0 if noneparent_workflow_instanceid: the workflow order instance ID of the parent order for this workflow or NULL if nonesubworkflow: if 1, indicates that the parent_workflow_instanceid is the parent workflow order in a subworkflow relationshipsynchronous: if 1, indicates that the order is being executed synchronouslyerrors: the number of errors raised against the orderbusiness_error: a boolean flag indicating if the workflow order has an error status due to a business errorworkflowstatus_orig: 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: a custom status for the orderscheduled: the scheduled datepriority: the priority of the workflow orderstarted: the date/time the order was createdcompleted: the date/time order processing completedmodified: the last modified date/time for the orderoperator_lock: a string giving the username of the user with an operator lock on the ordernote_count: the number of notes stored against the orderdeprecated: a boolean value indicating if the workflow is deprecated or not; deprecated workflows are by default not displayed in the UIautostart: the integer autostart value for the workflowmanual_autostart: a booelan 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: a value limiting the maximum number of execution instances that can run at onceexternal_order_instanceid: a unique external key for the orderstaticdata: a hash of workflow order static datadynamicdata: a hash of workflow order dynamic data (if any)keys: a hash of workflow order keys and valueswarning_count: the number of warnings raised against the ordererror_count: the number of errors raised against the orderStepInstances: a list of step hashes giving information about the execution status of workflow steps; each element is a hash with the following keys:workflow_instanceid: stepid: the ID of the stepind: the step array index starting with 0stepname: the name of the stepstepversion: the version of the stepsteptype: type of the stepstepstatus: the current execution status of the step (see Workflow, Segment, and Step Status Descriptions for possible values)retries: the number of retries executed on the stepskip: a boolean value indicating if the step logic was skippedcustom_status: a custom status for the stepstarted: the date/time the step was first executedcompleted: the date/time step processing completedfunction_instanceid: the function ID of the primary step functionsubworkflow_instanceid: the workflow order ID of any subworkflow order instance (for bound subworkflow steps only)business_error: a boolean flag indicating if the step has an error status due to a business errorErrorInstances: a list of hashes giving information about errors and warnings raised against the order; each element is a hash with the following keys:error_instanceid: a unique ID for the errorworkflow_instanceid: the workflow order instance IDstepid: the stepid where the error was raisedind: the step array index starting with 0 where the error was raisedseverity: the severity of the error (see Error Severity Codes for possible values)retry: 1 if the error caused a retryerror: the string error code for the errordescription: an optional description of the errorinfo: an optional string providing additional information about the errorbusiness_error: a boolean flag indicating if the error is a business errorcreated: the date/time the error was createdHierarchyInfo: 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 order; the values are order information hashes similar to the top-level of the return value of this APIAuditEvents: a list of audit information hashesLastModified: the last modified date/time of the workflow orderactions: a list of possible actions on the workflownotes: a list of notes saved against the order; each element is a REST Order Note Hashworkflow_status: the status of the workflow order409 Conflict: BLOCK-WORKFLOW-ERROR: invalid status, foreign session id, missing original status, unblock operation already in progress403 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)note: (required) a string note that gives the reason for breaking the operator lock"OK" upon successful executionworkflow_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: 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)newdata: (hash) the new dynamic data for the current workflow order; can also be 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 operationoptions: (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 executionlimit: 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: the note to create on 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 operationdate: (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)steps_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: the new static data for the current workflow order; must be a non-empty hash"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: ORDER-STATIC-DATA-ERROR: the new static data hash cannot be emptyworkflow_status: the status of the workflow order409 Conflict: BLOCK-WORKFLOW-ERROR: invalid status, foreign session id, missing original status, unblock operation already in progress403 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)workflow_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: 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)note: (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 executionorderkeys: (hash) the order keys to replace for the current workflow order403 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: ORDER-KEYS-ERROR: the orderkeys argument was missing or not a hash409 Conflict: INVALID-WORKFLOW-KEY: an order key was given that is not valid for the workflow409 Conflict: DUPLICATE-KEY-VALUE: the same value may not appear more than once for any given keyThis REST URI path provides information about workflow static data types
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 REST URI path provides information about steps in a workflow.
This REST URI path provides information about a particular step in a workflow.
This REST URI path provides actions and information related to Qorus step configuration items in the context of a particular workflow
"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"level": the level from where the value is obtained (interface level (e.g. "step:1", "workflow:1") or "global" or "default")"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"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. "step:1", "workflow:1") 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 Qorus. Prefix can be passed within the config item name or as following: /v3/workflows/{id_or_name}/stepinfo/{id_or_name}/config/{name}?prefix={prefix}. step configuration item in the context of a particular workflow
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. "step:1", "workflow:2") 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 item400 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": (serialized YAML string) the default value of the configuration item"value": (serialized YAML string) the current 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": (serialized YAML string) the list of allowed values for the configuration item if defined"level": the level from where the value is obtained (interface level (e.g. "step:1", "workflow:2") 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 URI path provides ability to customize Qorus interface logger configurations
400 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 callThis URI path provides ability to customize Qorus inerface logger appenders
id: required; (int); id of the appender to be deletedappenderId: (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 filenamename: (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 filename