PPA API: Inventory
Summary
This module contains actions for viewing images in the PPA Inventory page.
PPA Version
The actions in this module require PPA v2.7.x or newer.
Actions
ppa_api.inventory.
display
Display images in a table.
The table will have the following columns:
- Name
- Description
- Author
- Updated At
- Deployed
Minimum Plugin Version: 3.0.0
Input
-
text: the title of the table
-
images: any number of Images to display in the table
Output
Nothing is outputted by this action.
Example
1 2 3 4 5 6 7 |
|
ppa_api.inventory.
get_all
Get all versions of each inventory image visible to the current user.
Minimum Plugin Version: 2.0.0
Input
This action takes no inputs.
Output
A list of Images.
Example
1 2 |
|
ppa_api.inventory.
get_all_by_name
Get all versions of an image with the supplied name.
The image must be visible to the current user.
Minimum Plugin Version: 2.0.0
Input
This action takes no inputs.
Output
Either a list of Images or null
.
Example
1 2 3 |
|
ppa_api.inventory.
get_all_undeployed
Get all undeployed inventory images visible to the current user.
Minimum Plugin Version: 2.0.0
Input
This action takes no inputs.
Output
A list of Images.
Example
1 2 |
|
ppa_api.inventory.
get_by_id
Get the inventory image with the supplied ID.
Minimum Plugin Version: 4.1.0
Input
- image_id: the ID of the image
Output
A single Image.
Example
1 2 3 |
|
ppa_api.inventory.
get_deployed
Get all deployed inventory images visible to the current user.
Minimum Plugin Version: 2.0.0
Input
This action takes no inputs.
Output
A list of Images.
Example
1 2 |
|
ppa_api.inventory.
get_latest
Get the latest version of each inventory image visible to the current user.
Minimum Plugin Version: 2.0.0
Input
This action takes no inputs.
Output
A list of Imagess.
Example
1 2 |
|
ppa_api.inventory.
get_latest_by_name
Get the latest version of an image with the supplied name.
The image must be visible to the current user.
Minimum Plugin Version: 2.0.0
Input
This action takes no inputs.
Output
Either a single Image or null
.
Example
1 2 3 |
|
ppa_api.inventory.
get_latest_undeployed
Get the latest version of each undeployed inventory image visible to the current user.
Minimum Plugin Version: 2.0.0
Input
This action takes no inputs.
Output
A list of Images.
Example
1 2 |
|
ppa_api.inventory.
select
Display images in a table, & prompt the task operator to make a selection.
The table will have the following columns:
- Name
- Description
- Author
- Updated At
- Deployed
Minimum Plugin Version: 3.0.0
Input
-
text: the title of the table
-
images: any number of Images to display in the table
-
minimum: the minimum number of acceptable selections
-
maximum: the maximum number of acceptable selections
Output
A Selection containing:
Tip
- If neither a minimum or maximum is provided, the task operator will be able to submit 0 selections.
- If minimum or maximum are provided, the operation will repeat until the task operator makes a valid number of selections.
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 |
|
ppa_api.inventory.
select_one
Display images in a table, & prompt the task operator to select one.
The table will have the following columns:
- Name
- Description
- Author
- Updated At
- Deployed
Minimum Plugin Version: 3.0.0
Input
-
text: the title of the table
-
images: any number of Images to display in the table
Output
A single Images.
Example
1 2 3 4 5 6 7 8 |
|