What a project's automations can use (tenant:forge:read)
GET /api/forge/v1/projects/{key}/automations/catalog
Module: Forge · operationId: getForgeAutomationCatalog · Tag: Automations · Auth: access token (Authorization: Bearer <accessToken>)
Requires tenant:forge:read and a project the caller sees. The catalogue of the builder – the shape of flows' catalogue, cut down to what runs immediately – forge's item events with their payload schemas, the actions with an immediate implementation, the node and trigger kinds of the inline profile, the expression namespaces and functions, the limits, and per action the parameters the builder prefills (defaults).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
key |
path | string | yes | Project key (e.g. APP) |
Responses
- 200 The catalogue (
application/json) - 404 Error (
application/json)
Fields of the 200 answer:
defaults(object, required): Per action key, the parameters the builder prefills when the action is added: the ones that address the item the event is aboutfunctions(array of string, required): The functions of the expression languagekinds(array of object, required): The node kinds that run immediately, with their default ports and fieldsfields(array of AutomationField, required): Fields the inspector editspath(string, required): Dotted below the node or triggertype(string, required): Editor type of the fieldoptions(array of string): Allowed values of a choice fieldwhen(object): The field applies only while the sibling field has one of the valuesequals(array of string): Values of the sibling field for which this field appliesfield(string): The sibling field
name(string, required): Node kindports(array of string, required): Default output ports of the kindretry(boolean, required): Always false – an immediate automation is not retried
limits(object, required): Limits of immediate automationsmaxDepth(integer, required): How deep automations start each othermaxNodes(integer, required): The most nodes of an immediate automationmaxPerEvent(integer, required): The most automations one event starts
modules(array of object, required): forge's flows manifest, cut down to the actions with an immediate implementation:nodes(key, labels, parameter and output schemas) andevents(type, labels, payload schema)events(array of object): The events a trigger can listen tomodule(string): Module of the manifestnodes(array of object): The actions with an immediate implementationrevision(string): Revision of the manifestversion(integer): Manifest format version
namespaces(array of string, required): The names expressions readprofile(string, required): The validation profile: alwaysinline(runs immediately) (one ofinline)retryFields(array of AutomationField, required): Always emptypath(string, required): Dotted below the node or triggertype(string, required): Editor type of the fieldoptions(array of string): Allowed values of a choice fieldwhen(object): The field applies only while the sibling field has one of the valuesequals(array of string): Values of the sibling field for which this field appliesfield(string): The sibling field
triggers(array of object, required): The trigger kinds a definition may use here (forge - event only; nothing starts an automation by hand) with their fieldsfields(array of AutomationField, required): Fields the inspector editspath(string, required): Dotted below the node or triggertype(string, required): Editor type of the fieldoptions(array of string): Allowed values of a choice fieldwhen(object): The field applies only while the sibling field has one of the valuesequals(array of string): Values of the sibling field for which this field appliesfield(string): The sibling field
name(string, required): Trigger kind
Example 200 answer:
{
"defaults": {
"forge.item.add_label": {
"key": "{{ trigger.data.projectKey }}",
"number": "{{ trigger.data.number }}"
},
"forge.item.transition": {
"key": "{{ trigger.data.projectKey }}",
"number": "{{ trigger.data.number }}"
}
},
"functions": [
"len",
"any",
"all",
"hasPrefix",
"hasSuffix",
"lower",
"upper",
"now"
],
"kinds": [
{
"fields": [
{
"path": "condition",
"type": "condition"
}
],
"name": "if",
"ports": [
"true",
"false",
"error"
],
"retry": false
},
{
"fields": [
{
"path": "action",
"type": "action"
},
{
"path": "params",
"type": "params"
}
],
"name": "action",
"ports": [
"main",
"error"
],
"retry": false
}
],
"limits": {
"maxDepth": 4,
"maxNodes": 25,
"maxPerEvent": 20
},
"modules": [
{
"events": [
{
"label": {
"de": "Element angelegt",
"en": "Item created"
},
"type": "forge.item.created"
},
{
"label": {
"de": "Alle Unteraufgaben erledigt",
"en": "All children done"
},
"type": "forge.item.children_done"
}
],
"module": "forge",
"nodes": [
{
"access": "write",
"key": "forge.item.transition",
"label": {
"de": "Status wechseln",
"en": "Change status"
}
},
{
"access": "write",
"key": "forge.item.add_label",
"label": {
"de": "Label hinzufügen",
"en": "Add label"
}
},
{
"access": "write",
"key": "forge.item.assign",
"label": {
"de": "Zuständige Person hinzufügen",
"en": "Add assignee"
}
},
{
"access": "write",
"key": "forge.comment.add",
"label": {
"de": "Kommentar hinzufügen",
"en": "Add comment"
}
}
],
"revision": "3f9c2a17",
"version": 1
}
],
"namespaces": [
"trigger",
"nodes",
"vars",
"error",
"run"
],
"profile": "inline",
"retryFields": [],
"triggers": [
{
"fields": [
{
"path": "event",
"type": "event"
},
{
"path": "filter",
"type": "condition"
},
{
"path": "includeAutomated",
"type": "boolean"
}
],
"name": "event"
}
]
}
Example request
curl -X GET 'https://api.mbcom.cloud/api/forge/v1/projects/string/automations/catalog' \
-H "Authorization: Bearer $ACCESS_TOKEN"