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::get_workflow_info(3) User Contributed Perl Documentation OpenXPKI::Server::API2::Plugin::Workflow::get_workflow_info(3)

OpenXPKI::Server::API2::Plugin::Workflow::get_workflow_info

Querys workflow engine and workflow config for the given workflow and returns a HashRef with informations:

    {
        workflow => {
            type        => ...,
            id          => ...,
            state       => ...,
            label       => ...,
            description => ...,
            last_update => ...,
            proc_state  => ...,
            count_try   => ...,
            wake_up_at  => ...,
            reap_at     => ...,
            archive_at  => ...,
            context     => { ... },
            attribute   => { ... },   # only if "with_attributes => 1"
        },

        # only if "with_ui_info => 1":
        handles  => [ ... ],
        activity => { ... },
        state => {
            button => { ... },
            option => [ ... ],
            output => [ ... ],
        },
    }

Parameters

  • "id" Int - ID of the workflow to query
  • "with_attributes" Bool - set to 1 to also return workflow attributes. Default: 0
  • "activity" Str - only return informations about this workflow action. Default: all actions available in the current state.

    Note: you have to prepend the workflow prefix to the action separated by an underscore.

  • "with_ui_info" Bool - set to 1 to get the extra UI informations about workflow actions and state

Changes compared to API v1:

  • parameter "TYPE" was removed (use API command get_workflow_base_info instead to get workflow info by type).
  • parameter "WORKFLOW" was removed (old API spec and code did not match and it was only used in two places).
  • parameter "ATTRIBUTE" was renamed to "with_attributes".
  • parameter "UIINFO" was removed (previously unused).
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.