AWF Module Resources

Resources for configuration and management of Aidbox Workflows.

Overview

AWF module includes the following resource types:

• AidboxTask

• AidboxTaskLog

• AidboxWorkflow

• SchedulerRuleStatus

• WebPushSubscription

AidboxTask

Path	Card.	Type	Description
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: succeeded | failed | canceled
outcomeReason	0..1		Detailed reason for the task outcome.
outcomeReason.type	0..1	string	Type of outcome reason. Allowed values: awf.task/failed-due-to-in-progress-timeout | awf.task/failed-by-executor | awf.executor/unknown-error
outcomeReason.message	0..1	string	Human-readable explanation of the outcome.
outcomeReason.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.
requester.id	0..1	string	Identifier of the requester.
requester.resourceType	0..1	string	Type of resource that made the request.
requester.display	0..1	string	Human-readable display name of the requester.
requester.service	0..1	string	Service that initiated the request.
requester.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: created | ready | requested | in-progress | done | waiting
workflow-definition	0..1	string	Reference to the workflow definition for this task.

AidboxTaskLog

Path	Card.	Type	Description
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.
re-scheduled.action	0..1	string	Name of the rescheduled action.
re-scheduled.id	0..1	string	Unique identifier for the rescheduled action.
re-scheduled.delay	0..1	number	New delay in seconds before executing the action.
re-scheduled.at	0..1	dateTime	New specific time when the action should be executed.
re-scheduled.action-params	0..1	Object	Parameters for the rescheduled action.
scheduled	0..1		Definition of a scheduled action.
scheduled.action	0..1	string	Name of the scheduled action.
scheduled.id	0..1	string	Unique identifier for the scheduled action.
scheduled.delay	0..1	number	Delay in seconds before executing the action.
scheduled.at	0..1	dateTime	Specific time when the action should be executed.
scheduled.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.
subject.id	0..1	string	Identifier of the subject.
subject.resourceType	0..1	string	Type of resource that is the subject.
subject.display	0..1	string	Human-readable display name of the subject.

AidboxWorkflow

Path	Card.	Type	Description
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: succeeded | failed | canceled
outcomeReason	0..1		Detailed reason for the workflow outcome.
outcomeReason.type	0..1	string	Type of outcome reason. Allowed values: awf.workflow/failed-by-executor | awf.executor/unknown-error
outcomeReason.message	0..1	string	Human-readable explanation of the outcome.
outcomeReason.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.
requester.id	0..1	string	Identifier of the requester.
requester.resourceType	0..1	string	Type of resource that made the request.
requester.display	0..1	string	Human-readable display name of the requester.
requester.service	0..1	string	Service that initiated the request.
requester.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: created | in-progress | done

SchedulerRuleStatus

Path	Card.	Type	Description
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.
lastScheduleReference.id	0..1	string	Identifier of the last scheduled task.
lastScheduleReference.resourceType	0..1	string	Type of resource that was last scheduled.
lastScheduleReference.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: started | skipped
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

Path	Card.	Type	Description
app	0..1	string
subscription	0..1		Web Push API subscription details.
subscription.endpoint	0..1	string	URL to which the push notification service should send notifications.
subscription.expirationTime	0..1	number	Time in seconds when the subscription will expire.
subscription.keys	0..1		Cryptographic keys needed for the push subscription.
subscription.keys.auth	0..1	string	Authentication key for the subscription.
subscription.keys.p256dh	0..1	string	Public key for the subscription (P-256 Diffie-Hellman).
user	0..1		Reference to the user who owns this subscription.
user.id	0..1	string	User identifier.
user.resourceType	0..1	string	Fixed value indicating this is a reference to a User resource.