GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
OpenXPKI::Server::API2::Plugin::Workflow::search_workflow_instances(3) User Contributed Perl Documentation OpenXPKI::Server::API2::Plugin::Workflow::search_workflow_instances(3)

OpenXPKI::Server::API2::Plugin::Workflow::search_workflow_instances

Searches workflow instances using the given parameters and returns an ArrayRef of HashRefs:

    {
        'pki_realm' => 'alpha',
        'workflow_id' => '74751',
        'workflow_last_update' => '2018-02-10 00:58:36',
        'workflow_proc_state' => 'finished',
        'workflow_state' => 'SUCCESS',
        'workflow_type' => 'wf_type_1',
        'workflow_wakeup_at' => '0'
    }

The default sort order is by workflow id with the highest id as first element ("order => workflow_id, reverse => 1").

If order is set, reverse is 0.

Parameters

  • "check_acl" Bool - set to 1 to only return workflow that the current user is allowed to access. Default: 0
  • "pki_realm" Str - PKI realm
  • "tenant" Str

    Search for workflows of the given tenant, fallback to the primary tenant if not given, unfiltered search if set to the emtpy string. Mandatory if tenant mode is active.

  • "id" ArrayRef - list of workflow IDs
  • "type" ArrayRef|Str - type
  • "state" ArrayRef|HashRef|Str - filter workflows by state. To filter on a single state pass its name as string, you can prefix the string with an exclamation mark to search for "is not $state". Mutliple state names can be passed as array of strings. The command will also accept a hash or array of hashes with complex SQL statements as defined by SQL::Abstract.
  • "proc_state" ArrayRef|HashRef|Str - filter workflows by processing state, accepts the same syntax as state.
  • "attribute" HashRef - key is attribute name, value is passed "as is" as where statement on value, see documentation of SQL::Abstract.

    Legacy: ArrayRef - attribute values (legacy search syntax)

  • "last_update_after" Str - filter workflows by last_update only worflows young enough are returned, date handled by OpenXPKI::Datetime detect
  • "last_update_before" Str - filter workflows by last_update, only worflows old enough are returned, date handled by OpenXPKI::Datetime detect
  • "limit" Int - limit results
  • "start" Int - offset results by this (allows for paging)
  • "order" Str - column name to order by.
  • "reverse" Bool - 0 for ascending order, 1 for descending (default: ascending)
  • "return_attributes" ArrayRef - add the given attributes as columns to the result set. Each attribute is added as extra column using the attribute name as key.

Searches workflow instances using the given parameters and returns the number of workflows found.

See "search_workflow_instances" for available parameters. Note that for compatibility with search_workflow_instances the following parameters are accepted but ignored: "return_attributes", "start", "limit", "order", "reverse".

2022-05-14 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.