API Version Workflow

This section provides information about functions, conditions, and variables for the API version workflow, as well as initial actions and reserved actions.

Table of Contents

  1. API Version Workflow: Initial Actions
  2. API Version Workflow: Reserved Actions (none)
  3. API Version Workflow: Functions
  4. API Version Workflow: Conditions (none)
  5. API Version Workflow: Variable Resolvers

API Version Workflow: Initial Actions

The following initial actions are valid for Akana API Platform workflows relating to APIs/API versions:

@Create

Starts the workflow, for a new API version.

For more information, see Workflow Initial Actions.

Back to top

API Version Workflow: Reserved Actions

There are no reserved actions currently defined for API version workflows.

Back to top

API Version Workflow: Functions

The following functions are available for the API version workflow:

exportAPIVersion

Used to control workflow actions associated with export of the specified version of the specified API.

Parameters

None.

Examples/Notes/Additional Information

The example below uses this function to export the API version.

<action id="100" name="Export-WF">
  <restrict-to>
    <conditions type="AND">
      <condition type="authorizeByAtmosphereRole">
<arg name="role">ApiAdmin</arg>
      </condition>
    </conditions>
  </restrict-to>
  <results>
    <unconditional-result old-status="Ready" status="Ready" step="100" owner="${caller}" />
  </results>
  <post-functions>
    <function type="exportAPIVersion"/>
  </post-functions>
</action>

exportAPIAllVersions

Exports all versions of the specified API.

Parameters

None.

Examples/Notes/Additional Information

The example below uses this function to export all versions of the API.

<action id="101" name="Export-All-Versions-WF">
  <restrict-to>
    <conditions type="AND">
      <condition type="authorizeByAtmosphereRole">
<arg name="role">ApiAdmin</arg>
      </condition>
    </conditions>
  </restrict-to>
  <results>
    <unconditional-result old-status="Ready" status="Ready" step="100" owner="${caller}" />
  </results>
  <post-functions>
    <function type="exportAPIAllVersions"/>
  </post-functions>
</action>

Back to top

API Version Workflow: Conditions

There are no conditions for the API version workflow.

Back to top

API Version Workflow: Variable Resolvers

The API version workflow governs the API Version object. There is one variable available for the API version workflow:

${api.dn}

The unique ID for the API that the API version is associated with (APIID).

Back to top