L2 Construct: get
atlas entityDescription
GetEntity retrieves data from a specific entity.
L2 Data
- Provider: atlas
- Module: action
- Action: get
Example Step
{
"name": "insert-your-step-name",
"type": "l2",
"l2_data": {
"provider": "atlas",
"module": "action",
"action": "get",
"metadata": {}
}
}
Input
Example
{
"entity_name": "example-entity",
"operation": {},
"page_size": 100
}
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://pontus.bpa/pkgs/atlas/entity_actions/get-entity-input",
"$ref": "#/$defs/GetEntityInput",
"$defs": {
"GetEntityInput": {
"properties": {
"entity_name": {
"type": "string"
},
"operation": {
"$ref": "#/$defs/SheetOperation"
},
"page_size": {
"type": "integer"
},
"page_number": {
"type": "integer"
}
},
"additionalProperties": false,
"type": "object",
"required": ["entity_name", "operation"]
},
"SelectColumn": {
"properties": {
"column": {
"type": "string"
},
"alias": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object",
"required": ["column"]
},
"SheetFilter": {
"properties": {
"column": {
"type": "string"
},
"operator": {
"type": "string"
},
"value_type": {
"type": "string"
},
"value": true
},
"additionalProperties": false,
"type": "object",
"required": ["column", "operator"]
},
"SheetOperation": {
"properties": {
"select_columns": {
"items": {
"$ref": "#/$defs/SelectColumn"
},
"type": "array"
},
"filters": {
"items": {
"$ref": "#/$defs/SheetFilter"
},
"type": "array"
},
"order_by": {
"items": {
"$ref": "#/$defs/SheetOrderBy"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object"
},
"SheetOrderBy": {
"properties": {
"column": {
"type": "string"
},
"direction": {
"type": "string"
}
},
"additionalProperties": false,
"type": "object",
"required": ["column", "direction"]
}
}
}
Output
Example
{
"body": {
"table": {
"columns": null,
"rows": null
},
"error": {
"is_error": false
}
}
}
Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://pontus.bpa/pkgs/atlas/entity_actions/get-entity-output",
"$ref": "#/$defs/GetEntityOutput",
"$defs": {
"Column": {
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"string": {
"$ref": "#/$defs/ColumnTypeStringConfig"
},
"number": {
"$ref": "#/$defs/ColumnTypeNumberConfig"
},
"boolean": {
"$ref": "#/$defs/ColumnTypeBooleanConfig"
},
"date": {
"$ref": "#/$defs/ColumnTypeDateConfig"
},
"datetime": {
"$ref": "#/$defs/ColumnTypeDateTimeConfig"
}
},
"additionalProperties": false,
"type": "object",
"required": ["name"]
},
"ColumnTypeBooleanConfig": {
"properties": {},
"additionalProperties": false,
"type": "object"
},
"ColumnTypeDateConfig": {
"properties": {},
"additionalProperties": false,
"type": "object"
},
"ColumnTypeDateTimeConfig": {
"properties": {},
"additionalProperties": false,
"type": "object"
},
"ColumnTypeNumberConfig": {
"properties": {
"min": {
"type": "integer"
},
"max": {
"type": "integer"
},
"step": {
"type": "number"
},
"latin_numbering": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object",
"required": ["latin_numbering"]
},
"ColumnTypeStringConfig": {
"properties": {
"is_json": {
"type": "boolean"
},
"is_url": {
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object",
"required": ["is_json", "is_url"]
},
"DataTable": {
"properties": {
"columns": {
"items": {
"$ref": "#/$defs/Column"
},
"type": "array"
},
"rows": {
"items": {
"items": true,
"type": "array"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object",
"required": ["columns", "rows"]
},
"GetEntityOutput": {
"properties": {
"body": {
"$ref": "#/$defs/GetEntityOutputBody"
}
},
"additionalProperties": false,
"type": "object",
"required": ["body"]
},
"GetEntityOutputBody": {
"properties": {
"table": {
"$ref": "#/$defs/DataTable"
},
"error": {
"$ref": "#/$defs/HandlerError"
}
},
"additionalProperties": false,
"type": "object",
"required": ["table"]
},
"HandlerError": {
"properties": {
"is_error": {
"type": "boolean"
},
"errors": {
"items": {
"type": "string"
},
"type": "array"
}
},
"additionalProperties": false,
"type": "object",
"required": ["is_error"]
}
}
}