schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
api.json | messageId | The message id pointing to the template string to format. | {"type": "string"} |
api.json | template | The template default string to format. | {"type": "string"} |
api.json | values | A set of remappers to convert the input to usable values. | {"additionalProperties": {}} |
api.json | string.replace |
Uses RegEx to find a value in a string and replace it with a given value.
```yaml
# Input: Eindhoven is the best city in the Netherlands
string.replace:
(beszt*)\w+: cleanest
```
Result:
```json
"Eindhoven is the cleanest city in the Netherlands"
```
| {"type": "object", "minProperties": 1, "maxProperties": 1, "additionalProperties": {"type": "string"}} |
api.json | ics | Create a calendar event. This event can be downloaded as an `.ics` file and
uploaded to your agenda using the [download](../reference/action#download) action.
For example, the following input:
```yaml
ics:
coordinates
object.from:
latitude: 38.897700545442646
longitude: -77.03655660152435
description: "Sprin... | {"type": "object", "additionalProperties": false, "required": ["start", "title"], "properties": {"start": {}, "end": {}, "duration": {"example": "1w 3d 10h 30m"}, "url": {}, "location": {}, "coordinates": {}}} |
api.json | start | The start of the icalendar event. | {} |
api.json | end | The end of the icalendar event. | {} |
api.json | duration | The duration of the event. | {"example": "1w 3d 10h 30m"} |
api.json | title | The title of the event. | {} |
api.json | description | An optional description of the event. | {} |
api.json | url | An optional link to attach to the event. | {} |
api.json | location | An optional location description to attach to the event. | {} |
api.json | coordinates | An optional geolocation description to attach to the event.
This must be an object with the properties `lat` or `latitude`, and `lon`, `lng` or `longitude`. | {} |
api.json | null.strip | Strip all null, undefined, and empty array values from an object or array.
For example, with the following input value:
```json
[0, 4, null, null, "Peter", 0.4234, null]
```
```yaml
null.strip: null
```
The null values will be removed, leaving a dense array:
```json
[0, 4, "Peter", 0.4234]
```
Instead of giving it `n... | {"anyOf": [{"enum": [null]}, {"type": "object", "required": ["depth"], "additionalProperties": false, "properties": {"depth": {"type": "integer", "minimum": 1}}}]} |
api.json | null.strip | Options for the null.strip remapper. | {"type": "object", "required": ["depth"], "additionalProperties": false, "properties": {"depth": {"type": "integer", "minimum": 1}}} |
api.json | depth | How deep to recurse into objects and arrays to remove null values. | {"type": "integer", "minimum": 1} |
api.json | log | Logs in the browser's console and returns the incoming data and the remapper function's context.
The context contains relevant info about the app, like the URL and locale, but also contains the
remapper’s history.
The options represent the level of logging that will show in the console.
- `input`: The input data goi... | {"enum": ["info", "warn", "error"]} |
api.json | Organization | An organization groups a set of users, apps, themes, and permissions together | {"type": "object", "required": ["id"], "additionalProperties": false, "properties": {"id": {"type": "string", "pattern": "^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$", "minLength": 1, "maxLength": 30}, "name": {"type": "string"}, "email": {"type": "string"}, "website": {"type": "string"}, "iconUrl": {"type": "string"}}... |
api.json | id | The unique identifier for the organization. | {"type": "string", "pattern": "^([\\da-z](?:(?!.*--)[\\da-z-]*[\\da-z])?)$", "minLength": 1, "maxLength": 30} |
api.json | name | The display name for the organization. | {"type": "string"} |
api.json | description | The description of the organization. | {"type": "string", "maxLength": 160} |
api.json | email | The email address of the organization. | {"type": "string"} |
api.json | website | The website of the organization. | {"type": "string"} |
api.json | iconUrl | The URL used to fetch the organization’s icon. | {"type": "string"} |
api.json | PageDefinition | The list of blocks that are displayed on the page.
Each page requires at least one block. Blocks are displayed in the order that they are defined in
the list.
| {"type": "object", "additionalProperties": false, "required": ["blocks", "name"], "properties": {"blocks": {"type": "array", "minItems": 1, "items": {}}, "name": {"type": "string", "maxLength": 50}, "hideName": {"type": "boolean"}, "navTitle": {}, "hideNavTitle": {"type": "boolean", "default": false}, "navigation": {},... |
api.json | blocks | The blocks that make up a page. | {"type": "array", "minItems": 1, "items": {}} |
api.json | name | The name of an app.
This field is always required and must be unique within the app, meaning that it is not possible to
have two pages with the same name. The name of the page is displayed at the *app bar* of each page as well as in the side navigational menu.
> **Note**: The URL used to navigate to pages is determin... | {"type": "string", "maxLength": 50} |
api.json | hideName | Whether or not the page name should be displayed in the *app bar*. | {"type": "boolean"} |
api.json | navTitle | The name of the page when displayed in the navigation menu.
Context property `name` can be used to access the name of the page.
| {} |
api.json | hideNavTitle | Whether or not the page should be displayed in navigational menus.
By default all pages without parameters are added to navigational menus. Set to `true` to hide the
page from menus.
| {"type": "boolean", "default": false} |
api.json | navigation | The type of navigation displayed on the page.
This overrides the navigation property of the app itself. Defaults to `left-menu` if navigation or
App navigation are not set.
Set to `bottom` to use a navigation pane at the bottom of the screen instead of the default side
menu. Set to `hidden` to display no navigational... | {} |
api.json | icon | An optional icon from the fontawesome icon set
This will be displayed in the navigation menu.
| {"type": "string"} |
api.json | parameters | Page parameters can be used for linking to a page that should display a single resource.
This defined as a list of strings representing the properties to pass through. More often than not
passing `id` through is sufficient, depending on the block.
| {"type": "array", "items": {"type": "string", "minLength": 1, "maxLength": 30}} |
api.json | roles | The list of roles that are allowed to view this page.
If the user doesn’t have any of the roles in the list the page will be unavailable to them. An empty
list can be used to specify that users need to log in but do not need a specific role.
Users trying to visit a page without having the correct roles will be redire... | {"type": "array", "items": {"type": "string"}} |
api.json | Rating | A representation of an App rating. | {"type": "object", "additionalProperties": false, "required": ["rating"], "properties": {"rating": {"type": "number", "minimum": 1, "maximum": 5}, "name": {"readOnly": true}}} |
api.json | rating | A value ranging from 1 to 5 stars rating of the App. | {"type": "number", "minimum": 1, "maximum": 5} |
api.json | description | An optional explanation of the given rating. | {"type": "string"} |
api.json | name | The name of the user who submitted the rating. | {"readOnly": true} |
api.json | RemapperDefinition | A boolean remapper is always returned directly. | {"type": "boolean"} |
api.json | RemapperDefinition | A null remapper is always returned directly. | {"enum": [null]} |
api.json | RemapperDefinition | A numeric remapper is always returned directly. | {"type": "number"} |
api.json | RemapperDefinition | A string remapper is always returned directly. | {"type": "string"} |
api.json | type | Performs an HTTP request.
This can be used to call the Appsemble API or an external API in order to fetch data or send data.
When sending `POST`, `PUT`, `DELETE` and `PATCH` calls the data that is currently available
in the block gets passed through.
If the content type of the request is `text/xml` or `application/xm... | {"enum": ["request"]} |
api.json | url | A remapper that results in the URL to send the request to.
Can be a relative URL (E.g. `/api/health`) for usage with the Appsemble API, or an absolute URL
(E.g. `https://example.com`) for usage with external sites. | {} |
api.json | method | The type of request to make. | {"enum": ["delete", "get", "patch", "post", "put"], "default": "get"} |
api.json | query | A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is. | {} |
api.json | body | remapper that results in the request body to send.
If not specified, the raw input data is used.
| {} |
api.json | proxy | By default requests will be proxied through the Appsemble API.
This allows to protect user data and ensures
[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be
disabled by setting this to `false`
| {"type": "boolean", "default": true} |
api.json | schema | The name of the schema to validate against before submitting data. | {} |
api.json | Resource | A resource can be anything defined as described in an app resource definition. | {"type": "object", "additionalProperties": true, "properties": {"id": {"type": "number", "readOnly": true}, "$clonable": {"type": "boolean"}, "$expires": {"type": "string", "format": "date-time"}}} |
api.json | type | Count the number of resources a similar `resource.query` action would return. | {"enum": ["resource.count"]} |
api.json | resource | The type of the resource to count. | {"type": "string"} |
api.json | method | The type of request to make. | {"enum": ["delete", "get", "patch", "post", "put"], "default": "get"} |
api.json | query | A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is. | {} |
api.json | body | remapper that results in the request body to send.
If not specified, the raw input data is used.
| {} |
api.json | proxy | By default requests will be proxied through the Appsemble API.
This allows to protect user data and ensures
[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be
disabled by setting this to `false`
| {"type": "boolean", "default": true} |
api.json | schema | The name of the schema to validate against before submitting data. | {} |
api.json | type | Create a resource. | {"enum": ["resource.create"]} |
api.json | resource | The type of the resource to create. | {"type": "string"} |
api.json | method | The type of request to make. | {"enum": ["delete", "get", "patch", "post", "put"], "default": "get"} |
api.json | query | A remapper that results in either an object containing each property of the query string, or a string that gets passed through as-is. | {} |
api.json | body | remapper that results in the request body to send.
If not specified, the raw input data is used.
| {} |
api.json | proxy | By default requests will be proxied through the Appsemble API.
This allows to protect user data and ensures
[CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) is enabled. This behavior can be
disabled by setting this to `false`
| {"type": "boolean", "default": true} |
api.json | schema | The name of the schema to validate against before submitting data. | {} |
api.json | ResourceDefinition | A definition of how this resource works. | {"type": "object", "additionalProperties": false, "required": ["schema"], "properties": {"expires": {"type": "string", "pattern": "^(\\d+(y|yr|years))?\\s*(\\d+months)?\\s*(\\d+(w|wk|weeks))?\\s*(\\d+(d|days))?\\s*(\\d+(h|hr|hours))?\\s*(\\d+(m|min|minutes))?\\s*(\\d+(s|sec|seconds))?$"}, "schema": {}, "references": {"... |
api.json | expires | A time string representing when a resource should expire.
Example: 1d 8h 30m
| {"type": "string", "pattern": "^(\\d+(y|yr|years))?\\s*(\\d+months)?\\s*(\\d+(w|wk|weeks))?\\s*(\\d+(d|days))?\\s*(\\d+(h|hr|hours))?\\s*(\\d+(m|min|minutes))?\\s*(\\d+(s|sec|seconds))?$"} |
api.json | schema | JSON schema definitions that may be used by the app. | {} |
api.json | references | References to other resources.
The key is the property that references the other resource. The value is an object describing the
name of the resource and how it should behave.
| {"type": "object", "minProperties": 1, "additionalProperties": {"type": "object", "additionalProperties": false, "properties": {"resource": {"type": "string"}, "create": {"type": "object", "additionalProperties": false, "properties": {"trigger": {"type": "array", "items": {"enum": ["create", "update", "delete"]}, "minI... |
api.json | additionalProperties | A reference to between two resource types. | {"type": "object", "additionalProperties": false, "properties": {"resource": {"type": "string"}, "create": {"type": "object", "additionalProperties": false, "properties": {"trigger": {"type": "array", "items": {"enum": ["create", "update", "delete"]}, "minItems": 1, "uniqueItems": true}}}, "update": {"type": "object", ... |
api.json | create | To be documented. | {"type": "object", "additionalProperties": false, "properties": {"trigger": {"type": "array", "items": {"enum": ["create", "update", "delete"]}, "minItems": 1, "uniqueItems": true}}} |
api.json | update | To be documented. | {"type": "object", "additionalProperties": false, "properties": {"trigger": {"type": "array", "items": {"enum": ["create", "update", "delete"]}, "minItems": 1, "uniqueItems": true}}} |
api.json | delete | To be documented. | {"type": "object", "additionalProperties": false, "properties": {"trigger": {"type": "array", "items": {"enum": ["create", "update", "delete"]}, "minItems": 1, "uniqueItems": true}}} |
api.json | roles | The default roles that are allowed to perform all actions. | {"type": "array", "items": {"type": "string"}} |
api.json | url | URL to use if not otherwise specified. | {"type": "string", "default": "/api/apps/{appId}/{resource}"} |
api.json | id | Name of the field used when accessing singular entities. | {"type": "string", "default": "id"} |
api.json | history | A definition of how versioning should happen for instances of this resource. | {"default": false, "oneOf": [{"type": "boolean"}, {}]} |
api.json | history | Setting this to `true` is the same as using an object with the property `data` set to `true`. | {"type": "boolean"} |
api.json | query | Overrides for 'query' requests. | {"type": "object", "additionalProperties": false, "properties": {"roles": {"type": "array", "items": {"type": "string"}}, "query": {"type": "object", "additionalProperties": {"type": "string"}}, "method": {"type": "string", "default": "GET"}, "url": {"type": "string", "default": "/api/apps/{appId}/{resource}"}}} |
api.json | roles | The list of roles that are allowed to use this action.
This will override the default roles that are assigned.
| {"type": "array", "items": {"type": "string"}} |
api.json | query | The query parameters to use in the request. | {"type": "object", "additionalProperties": {"type": "string"}} |
api.json | method | HTTP method to use for this type of request. | {"type": "string", "default": "GET"} |
api.json | url | URL to use for this type of request. | {"type": "string", "default": "/api/apps/{appId}/{resource}"} |
api.json | get | Overrides for 'get' requests. | {"type": "object", "additionalProperties": false, "properties": {"roles": {"type": "array", "items": {"type": "string"}}, "query": {"type": "object", "additionalProperties": {"type": "string"}}, "method": {"type": "string", "default": "GET"}, "url": {"type": "string", "default": "/api/apps/{appId}/{resource}/{id}"}}} |
api.json | roles | The list of roles that are allowed to use this action.
This will override the default roles that are assigned.
| {"type": "array", "items": {"type": "string"}} |
api.json | query | The query parameters to use in the request. | {"type": "object", "additionalProperties": {"type": "string"}} |
api.json | method | HTTP method to use for this type of request. | {"type": "string", "default": "GET"} |
api.json | url | URL to use for this type of request. | {"type": "string", "default": "/api/apps/{appId}/{resource}/{id}"} |
api.json | count | Overrides for 'count' requests. | {"type": "object", "additionalProperties": false, "properties": {"roles": {"type": "array", "items": {"type": "string"}}, "query": {"type": "object", "additionalProperties": {"type": "string"}}, "method": {"type": "string", "default": "GET"}, "url": {"type": "string", "default": "/api/apps/{appId}/{resource}/$count"}}} |
api.json | roles | The list of roles that are allowed to use this action.
This will override the default roles that are assigned.
| {"type": "array", "items": {"type": "string"}} |
api.json | query | The query parameters to use in the request. | {"type": "object", "additionalProperties": {"type": "string"}} |
api.json | method | HTTP method to use for this type of request. | {"type": "string", "default": "GET"} |
api.json | url | URL to use for this type of request. | {"type": "string", "default": "/api/apps/{appId}/{resource}/$count"} |
api.json | create | Overrides for 'create' requests. | {"type": "object", "additionalProperties": false, "properties": {"roles": {"type": "array", "items": {"type": "string"}}, "query": {"type": "object", "additionalProperties": {"type": "string"}}, "method": {"type": "string", "default": "POST"}, "url": {"type": "string", "default": "/api/apps/{appId}/{resource}/{id}"}, "... |
api.json | roles | The list of roles that are allowed to use this action.
This will override the default roles that are assigned.
| {"type": "array", "items": {"type": "string"}} |
api.json | query | The query parameters to use in the request. | {"type": "object", "additionalProperties": {"type": "string"}} |
api.json | method | HTTP method to use for this type of request. | {"type": "string", "default": "POST"} |
api.json | url | URL to use for this type of request. | {"type": "string", "default": "/api/apps/{appId}/{resource}/{id}"} |
api.json | update | Overrides for 'update' requests. | {"type": "object", "additionalProperties": false, "properties": {"roles": {"type": "array", "items": {"type": "string"}}, "query": {"type": "object", "additionalProperties": {"type": "string"}}, "method": {"type": "string", "default": "PUT"}, "url": {"type": "string", "default": "/api/apps/{appId}/{resource}/{id}"}, "h... |
api.json | roles | The list of roles that are allowed to use this action.
This will override the default roles that are assigned.
| {"type": "array", "items": {"type": "string"}} |
api.json | query | The query parameters to use in the request. | {"type": "object", "additionalProperties": {"type": "string"}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.