ABX Service API Data Structures
Model representing an ABX action
{
"actionType": "string",
"compressedContent": "string",
"contentId": "string",
"dependencies": "string",
"description": "string",
"entrypoint": "string",
"id": "string",
"memoryInMB": "integer",
"name": "string",
"orgId": "string",
"projectId": "string",
"runtime": "string",
"source": "string",
"system": "boolean",
"timeoutSeconds": "integer"
}Type of the action
base64encoded ZIP of action content (source & dependencies)
Configuration of the action for specific providers
ID of the actions saved compressed content
A list of libraries to import, delimited by a comma
Description of the action
Name of the entry function of the action
ID of the action
Map defining the inputs of the action
Runtime RAM constraints in megabytes
Name of the action
Organization ID of the action.
Project Id of the action (required for non-system actions)
Runtime of the action (python, nodejs, etc...)
Source of the action as string
Flag indicating if the action is a system action
Defines how long an action can run (default 180)
Model representing an action export request
{
"actions": [
{
"id": "string",
"orgId": "string",
"projectId": "string"
}
]
}Model representing an action identity
{
"id": "string",
"orgId": "string",
"projectId": "string"
}ID of the action
Organization ID of the action
ID of the project where the action is available (required for non-system actions)
Model representing an action run
{
"actionId": "string",
"actionType": "string",
"actionVersionId": "string",
"actionVersionName": "string",
"createdMillis": "integer",
"endTimeMillis": "integer",
"errorMessage": "string",
"id": "string",
"logs": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"provider": "string",
"runState": "string",
"runtime": "string",
"source": "string",
"startTimeMillis": "integer",
"system": "boolean",
"timeoutSeconds": "integer"
}ID of the action
Type of the action
ID of the action version used for the execution
Name of the action version used for the execution
Configuration of the action run for specific providers
Creation time in millis
Completion time in millis
Error message in case the run completed with an error
ID of the resource
Input parameters of the action
Action run logs
Name of the resource
Org ID of the resource
Output parameters generated by the action
Project Id of the action (required for non-system actions)
Provider used for code execution
State of the action run
Runtime of the action run (python, nodejs, etc...)
Source used for the execution
Start time in millis
system
Timeout in seconds for execution
Page of action runs
{
"content": [
{
"actionId": "string",
"actionType": "string",
"actionVersionId": "string",
"actionVersionName": "string",
"createdMillis": "integer",
"endTimeMillis": "integer",
"errorMessage": "string",
"id": "string",
"logs": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"provider": "string",
"runState": "string",
"runtime": "string",
"source": "string",
"startTimeMillis": "integer",
"system": "boolean",
"timeoutSeconds": "integer"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}empty
first
last
number
numberOfElements
size
totalElements
totalPages
Model representing an ABX action template
{
"actionType": "string",
"createdMillis": "integer",
"dependencies": "string",
"description": "string",
"id": "string",
"name": "string",
"orgId": "string",
"runtime": "string",
"source": "string"
}Type of the action
Creation time in millis
Dependencies needed for the code execution
Description of the action
ID of the resource
Map defining the inputs of the action
Name of the resource
Org ID of the resource
Runtime of the action (python, nodejs, etc...)
Source of the action as string
Page of action templates
{
"content": [
{
"actionType": "string",
"createdMillis": "integer",
"dependencies": "string",
"description": "string",
"id": "string",
"name": "string",
"orgId": "string",
"runtime": "string",
"source": "string"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}empty
first
last
number
numberOfElements
size
totalElements
totalPages
Model representing an ABX action version
{
"action": {
"actionType": "string",
"compressedContent": "string",
"contentId": "string",
"dependencies": "string",
"description": "string",
"entrypoint": "string",
"id": "string",
"memoryInMB": "integer",
"name": "string",
"orgId": "string",
"projectId": "string",
"runtime": "string",
"source": "string",
"system": "boolean",
"timeoutSeconds": "integer"
},
"actionId": "string",
"createdBy": "string",
"createdMillis": "integer",
"description": "string",
"gitCommitId": "string",
"id": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"released": "boolean"
}ID of the action
Name of the version creator
Creation time in millis
Description of the version
Commit ID of the version if pushed to git
ID of the resource
Name of the resource
Org ID of the resource
Project Id of the action (required for non-system actions)
Flag indicating if the version is released (only 1 released version allowed per action)
Model representing a request to release an action version
{
"version": "string"
}Name of the version to be released
Page of action versions
{
"content": [
{
"action": {
"actionType": "string",
"compressedContent": "string",
"contentId": "string",
"dependencies": "string",
"description": "string",
"entrypoint": "string",
"id": "string",
"memoryInMB": "integer",
"name": "string",
"orgId": "string",
"projectId": "string",
"runtime": "string",
"source": "string",
"system": "boolean",
"timeoutSeconds": "integer"
},
"actionId": "string",
"createdBy": "string",
"createdMillis": "integer",
"description": "string",
"gitCommitId": "string",
"id": "string",
"name": "string",
"orgId": "string",
"projectId": "string",
"released": "boolean"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}empty
first
last
number
numberOfElements
size
totalElements
totalPages
Model representing an action bundle to be imported
{
"bundleId": "string",
"compressedBundle": "string",
"option": "string",
"projectId": "string",
"system": "boolean"
}ID of the saved bundle used for import conflict resolution
base64encoded ZIP bundle of actions to import
Conflict option when importing (CREATE on initial import)
Project ID for where to create the actions
Flag indicating if the imported actions should be system actions
Page of actions
{
"content": [
{
"actionType": "string",
"compressedContent": "string",
"contentId": "string",
"dependencies": "string",
"description": "string",
"entrypoint": "string",
"id": "string",
"memoryInMB": "integer",
"name": "string",
"orgId": "string",
"projectId": "string",
"runtime": "string",
"source": "string",
"system": "boolean",
"timeoutSeconds": "integer"
}
],
"empty": "boolean",
"first": "boolean",
"last": "boolean",
"number": "integer",
"numberOfElements": "integer",
"size": "integer",
"totalElements": "integer",
"totalPages": "integer"
}empty
first
last
number
numberOfElements
size
totalElements
totalPages
{
"statusCode": "string",
"statusCodeValue": "integer"
}body
statusCode
statusCodeValue