Pims
Tool for the pims API.
- Base URL:
https://demo.pims.io/api/v1 - Auth:
bearer(pass your key via theapiKeyinput)
Operations
fetchallcategories— GET /categories — Find all categoriesfetchonecategory— GET /categories/{category_id} — Get one category by IDfetchallchannels— GET /channels — Find all channelsfetchonechannel— GET /channels/{channel_id} — Get one channel by IDfetchallevents— GET /events — Find all eventsfetchoneevent— GET /events/{event_id} — Get one event by ID
Inputs
apiKey— your pims API keyoperation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: fetchallcategories
apiKey: <your key>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
apiKey |
string | yes | — | DEPRECATED — bind an API Key credential to the task with credentialName instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change. |
operation |
string | yes | — | One of: fetchallcategories, fetchonecategory, fetchallchannels, fetchonechannel, fetchallevents, fetchoneevent |
category_id |
string | no | — | Path parameter category_id (required by some operations). |
channel_id |
string | no | — | Path parameter channel_id (required by some operations). |
event_id |
string | no | — | Path parameter event_id (required by some operations). |
query |
string | no | — | Optional query params as a JSON object string, e.g. {"limit": 10}. |