AWF Module Resources
Resources for configuration and management of Aidbox Workflows.
AidboxTask
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxTask | |||
allowedRetryCount | 0..1 | integer | Maximum number of retries allowed for this task. |
concurrencyLimit | 0..1 | number | Maximum number of concurrent tasks allowed. |
concurrencyPath | 0..* | keyword | |
definition | 0..1 | string | Identifier for the task definition. |
error | 0..1 | Error details if task failed. | |
execId | 0..1 | string | Unique execution identifier. |
executeAt | 0..1 | dateTime | Scheduled time for task execution. |
inProgressTimeout | 0..1 | number | Maximum duration in seconds that a task can remain in in-progress status before timing out. |
label | 0..1 | string | |
outcome | 0..1 | string | Final outcome of the task execution. Allowed values: |
outcomeReason | 0..1 | Detailed reason for the task outcome. | |
type | 0..1 | string | Type of outcome reason. Allowed values: |
message | 0..1 | string | Human-readable explanation of the outcome. |
data | 0..1 | Additional data related to the outcome. | |
params | 0..1 | Parameters required for task execution. | |
requestedToStartTimeout | 0..1 | number | Maximum duration in seconds that a task can remain in requested status before timing out. |
requester | 0..1 | Entity that requested the task. | |
id | 0..1 | string | Identifier of the requester. |
resourceType | 0..1 | string | Type of resource that made the request. |
display | 0..1 | string | Human-readable display name of the requester. |
service | 0..1 | string | Service that initiated the request. |
rule | 0..1 | string | Rule that authorized the request. |
result | 0..1 | Result data produced by successful task execution. | |
retryCount | 0..1 | number | Number of times the task has been retried. |
retryDelay | 0..1 | number | Delay in seconds before retrying a failed task. |
status | 0..1 | string | Current status of the task. Allowed values: |
workflow-definition | 0..1 | string | Reference to the workflow definition for this task. |
AidboxTaskLog
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxTaskLog | |||
action | 0..1 | string | Name of the performed action. |
action-params | 0..1 | Object | Parameters provided with the action. |
re-scheduled | 0..1 | Definition of a rescheduled action. | |
action | 0..1 | string | Name of the rescheduled action. |
id | 0..1 | string | Unique identifier for the rescheduled action. |
delay | 0..1 | number | New delay in seconds before executing the action. |
at | 0..1 | dateTime | New specific time when the action should be executed. |
action-params | 0..1 | Object | Parameters for the rescheduled action. |
scheduled | 0..1 | Definition of a scheduled action. | |
action | 0..1 | string | Name of the scheduled action. |
id | 0..1 | string | Unique identifier for the scheduled action. |
delay | 0..1 | number | Delay in seconds before executing the action. |
at | 0..1 | dateTime | Specific time when the action should be executed. |
action-params | 0..1 | Object | Parameters for the scheduled action. |
status-after | 0..1 | string | Task status after the action was performed. |
status-before | 0..1 | string | Task status before the action was performed. |
subject | 0..1 | Resource that is the subject of the action. | |
id | 0..1 | string | Identifier of the subject. |
resourceType | 0..1 | string | Type of resource that is the subject. |
display | 0..1 | string | Human-readable display name of the subject. |
AidboxWorkflow
| Name | Card. | Type | Description |
|---|---|---|---|
AidboxWorkflow | |||
definition | 0..1 | string | |
error | 0..1 | Error details if workflow failed. | |
execId | 0..1 | string | Unique execution identifier. |
executeAt | 0..1 | string | Scheduled time for workflow execution. |
label | 0..1 | string | Human-readable label for the workflow. |
outcome | 0..1 | string | Final outcome of the workflow execution. Allowed values: |
outcomeReason | 0..1 | Detailed reason for the workflow outcome. | |
type | 0..1 | string | Type of outcome reason. Allowed values: |
message | 0..1 | string | Human-readable explanation of the outcome. |
data | 0..1 | Additional data related to the outcome. | |
params | 0..1 | Parameters required for workflow execution. | |
requester | 0..1 | Entity that requested the workflow. | |
id | 0..1 | string | Identifier of the requester. |
resourceType | 0..1 | string | Type of resource that made the request. |
display | 0..1 | string | Human-readable display name of the requester. |
service | 0..1 | string | Service that initiated the request. |
rule | 0..1 | string | Rule that authorized the request. |
result | 0..1 | Result data produced by successful workflow execution. | |
retryCount | 0..1 | number | Number of times the workflow has been retried. |
status | 0..1 | string | Current status of the workflow. Allowed values: |
SchedulerRuleStatus
| Name | Card. | Type | Description |
|---|---|---|---|
SchedulerRuleStatus | |||
allowedRetryCount | 0..1 | integer | Maximum number of retries allowed for this rule. |
concurrencyLimit | 0..1 | number | Maximum number of concurrent executions allowed for this rule. |
concurrencyPath | 0..* | keyword | Path to the field used for concurrency control. |
definition | 0..1 | string | Identifier for the scheduler rule definition. |
executeAt | 0..1 | dateTime | Next scheduled execution time for this rule. |
id | 0..1 | string | Unique identifier for this scheduler rule status. |
inProgressTimeout | 0..1 | number | Maximum duration in seconds that a task can remain in in-progress status before timing out. |
label | 0..1 | string | Human-readable label for the scheduler rule. |
lastSchedule | 0..1 | dateTime | Timestamp of the last schedule attempt. |
lastScheduleReference | 0..1 | Reference to the last scheduled task for this rule. | |
id | 0..1 | string | Identifier of the last scheduled task. |
resourceType | 0..1 | string | Type of resource that was last scheduled. |
display | 0..1 | string | Human-readable display name of the last scheduled task. |
lastScheduleStatus | 0..1 | string | Status of the last schedule attempt. Allowed values: |
params | 0..1 | Parameters required for rule execution. | |
requestedToStartTimeout | 0..1 | number | Maximum duration in seconds that a task can remain in requested status before timing out. |
retryDelay | 0..1 | number | Delay in seconds before retrying a failed rule execution. |
WebPushSubscription
| Name | Card. | Type | Description |
|---|---|---|---|
WebPushSubscription | |||
app | 0..1 | string | |
subscription | 0..1 | Web Push API subscription details. | |
endpoint | 0..1 | string | URL to which the push notification service should send notifications. |
expirationTime | 0..1 | number | Time in seconds when the subscription will expire. |
keys | 0..1 | Cryptographic keys needed for the push subscription. | |
auth | 0..1 | string | Authentication key for the subscription. |
p256dh | 0..1 | string | Public key for the subscription (P-256 Diffie-Hellman). |
user | 0..1 | Reference to the user who owns this subscription. | |
id | 0..1 | string | User identifier. |
resourceType | 0..1 | string | Fixed value indicating this is a reference to a User resource. |