PPA: Inputs & Outputs
Summary
Each plugin uses a set of dictionaries to store data.
These are used by plugin actions as both inputs and outputs.
This page will cover:
- The dictionaries used in this plugin
- The information each dictionary contains
Info
See User Interface, Events, & Task for each action's inputs & outputs.
Dictionary Types
ApprovalRequest
-
Generated by the create_approval_request action
-
The
approve_url
&reject_url
values should be sent to one or more request approvers
All ApprovalRequest Keys
approve_url: A unique URL for approving the request.
reject_url: A unique URL for rejecting the request.
secret: The secret associated with the approval hook.
ApprovalResponse
- Contains the output from wait_approval_response
All ApprovalResponse Keys
approved: Indicates whether the request was approved (either true
or false
)
responder: The name of the PPA user who responded to the request.
reason: The reason for the response (optional).
Attachment
- Contains email attachment details
All Attachment Keys
name: The name of the file on the task workspace (including the extension).
PayloadKey
- Describes a key to get from the task payload
All PayloadKey Keys
name: The name of the key in the payload.
default_value: An optional default value to use if the key is missing from the payload.
TimeStamp
- Contains submitted date picker information
All TimeStamp Keys
day: The selected day.
month: The selected month.
year: The selected year.
hour: The selected hour.
minute: The selected minute.
second: The submitted second.
timezone: The chosen timezone.
timestamp: The supplied date, time, & UTC offset in ISO-8601 format (yyyy-mm-ddThh:mm:ss+hh:mm
).
UploadedFile
- Contains data about a file uploaded using input_file
All UploadedFile Keys
data: File contents.
filename: Original filename.
size: Size of the file in bytes.
type: Content type (if the browser was able to detect it).
Vault
- Contains information about a Vault configured in PPA
All Vault Keys
name: The name of the Vault.
url: The Vault address.
driver: The type of Vault.
expires_at: The date the Vault access token will expire (if applicable).
Example
1 2 3 4 |
|
WaitHook
-
Contains the output from create_wait_hook
-
Primarily used to supply parameters to wait
All WaitHook Keys
url: A unique URL assigned to trigger the waithook.
secret: The secret associated with the url
.
WaitHookResponse
- Contains the output from wait
All WaitHookResponse Keys
username: The name of the PPA user who responded to the waithook.
values: A dictionary containing the URL parameters from the WaitHook URL responded to.
reason: The reason for the response (optional).