Appearance
aria.tool-attach ​
Add a workflow to a hosted service's surface, with an optional localized name.
Offer one workflow, under the name the tenant chose.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-aria |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
slug | string | Yes | — | — |
workflow_type | string | Yes | — | Canonical workflow type |
alias | string | No | — | The name the model is shown |
title | string | No | — | — |
description | string | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
service | json | No | — | — |
tools | list | No | — | The service's tool rows after the change |
failure_reason | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | json | No | — | — |
failed_layer | integer | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failed_at | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
attached | SUCCESS | The workflow joined the service's surface | tools |
failed | FAILURE | The action was refused or failed | failure_reason |
Business Errors ​
| Code | Message Template |
|---|---|
ARIA_SERVICE_NOT_FOUND | No such service in this organization |
ARIA_ABOVE_CEILING | No hosted service may offer that workflow |
ARIA_REFUSED | The action was refused |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "aria.tool-attach",
"initial_data": {
"slug": "value",
"workflow_type": "value"
}
}