This page lists all available types of this document. For more information and export options please take a look at the document at our app.
Document| Type | Description |
|---|---|
| Backend_AccountChangePassword | |
| Backend_Action | This object represents the business logic which can be executed either through an operation or cronjob |
| Backend_ActionCollection | A paginated collection of action objects |
| Backend_ActionConfig | The action configuration which contains arbitrary key-value entries |
| Backend_ActionCreate | |
| Backend_ActionExecuteRequest | Represents a request to execute an action |
| Backend_ActionExecuteRequestBody | Represents a request body |
| Backend_ActionExecuteResponse | Represents an action execution response |
| Backend_ActionExecuteResponseBody | Represents a response body |
| Backend_ActionExecuteResponseHeaders | Represents a map of headers |
| Backend_ActionIndex | Contains all possible classes which can be used at an action as class |
| Backend_ActionIndexEntry | Represents a concrete action class |
| Backend_ActionUpdate | |
| Backend_App | This object represents an app to access the API on-behalf of a user |
| Backend_AppCollection | A paginated collection of app objects |
| Backend_AppCreate | |
| Backend_AppUpdate | |
| Backend_Audit | This object represents an audit which is created every time something was changed at the system |
| Backend_AuditCollection | A paginated collection of audit objects |
| Backend_AuditObject | A key value object containing the changes |
| Backend_BackupExport | Export of the complete system configuration |
| Backend_BackupImport | Import a previously exported system configuration |
| Backend_BackupImportResult | Result of a backup import operation |
| Backend_Category | This object represents a category. Every user is assigned to a category and can only view objects which are also assigned to the same category, through this it is possible to build separate areas for external developers |
| Backend_CategoryCollection | A paginated collection of category objects |
| Backend_CategoryCreate | |
| Backend_CategoryUpdate | |
| Backend_Config | This object represents a system configuration |
| Backend_ConfigCollection | A paginated collection of config objects |
| Backend_ConfigUpdate | |
| Backend_Connection | This object represents a connection to an external system like i.e. a database, message-queue or client-sdk |
| Backend_ConnectionCollection | A paginated collection of connection objects |
| Backend_ConnectionConfig | The connection configuration which contains arbitrary key-value entries |
| Backend_ConnectionCreate | |
| Backend_ConnectionIndex | Contains all possible classes which can be used at an connection as class |
| Backend_ConnectionIndexEntry | Represents a concrete connection class |
| Backend_ConnectionRedirectResponse | Redirect response to initiate an OAuth2 flow |
| Backend_ConnectionUpdate | |
| Backend_Cronjob | This object represents a cronjob which can invoke an action at a specific interval |
| Backend_CronjobCollection | A paginated collection of cronjob objects |
| Backend_CronjobCreate | |
| Backend_CronjobError | Represents an error which occurred on cronjob execution |
| Backend_CronjobUpdate | |
| Backend_Dashboard | Represents an object containing all widget data for the dashboard |
| Backend_DatabaseRow | This object represents a row on a relational table |
| Backend_DatabaseRowCollection | A paginated collection of database rows |
| Backend_DatabaseTable | This object represents a relational table on a database connection |
| Backend_DatabaseTableCollection | |
| Backend_DatabaseTableColumn | This object represents a column at a relation table |
| Backend_DatabaseTableForeignKeyConstraint | This object represents a foreign key constraint on a relational database |
| Backend_DatabaseTableIndex | This object represents a table index on a relational database |
| Backend_Event | This object represents an event which can be triggered by an action |
| Backend_EventCollection | A paginated collection of event objects |
| Backend_EventCreate | |
| Backend_EventUpdate | |
| Backend_File | This object represents a file on the filesystem |
| Backend_FileCollection | A paginated collection of file objects |
| Backend_Firewall | This object represents a firewall rule which blocks specific IP addresses |
| Backend_FirewallCollection | A paginated collection of firewall objects |
| Backend_FirewallCreate | |
| Backend_FirewallUpdate | |
| Backend_Form | This object represents a form which helps to dynamically generate a form at a frontend app |
| Backend_FormCollection | A paginated collection of form objects |
| Backend_FormCreate | |
| Backend_FormUpdate | |
| Backend_GeneratorIndexProvider | Represents a concrete generator class |
| Backend_GeneratorIndexProviders | Contains all possible classes which can be used at an generator as class |
| Backend_GeneratorProvider | |
| Backend_GeneratorProviderChangelog | |
| Backend_GeneratorProviderConfig | |
| Backend_HttpRequest | This object represents a HTTP request |
| Backend_HttpResponse | This object represents a HTTP response |
| Backend_Identity | This object represents an identity which allows to authenticate with a remote identity provider |
| Backend_IdentityCollection | A paginated collection of identity objects |
| Backend_IdentityConfig | |
| Backend_IdentityCreate | |
| Backend_IdentityIndex | Contains all possible classes which can be used at an identity as class |
| Backend_IdentityIndexEntry | Represents a concrete identity class |
| Backend_IdentityUpdate | |
| Backend_Log | This object represents a log entry. Every HTTP requests to the system generates such a log entry. |
| Backend_LogCollection | A paginated collection of log objects |
| Backend_LogError | |
| Backend_LogErrorCollection | A paginated collection of log error objects |
| Backend_Operation | This object represents an operation, an operation invokes an action in case a specific HTTP method and path was requested. It defines also schema information about the request and response payload |
| Backend_OperationCollection | A paginated collection of operation objects |
| Backend_OperationCreate | |
| Backend_OperationParameters | |
| Backend_OperationSchema | |
| Backend_OperationThrows | |
| Backend_OperationUpdate | |
| Backend_Page | This object represents a page at the developer portal |
| Backend_PageCollection | A paginated collection of page objects |
| Backend_PageCreate | |
| Backend_PageUpdate | |
| Backend_Plan | This object represents a plan, a plan allows users to obtain points or in general subscribe to your app |
| Backend_PlanCollection | A paginated collection of plan objects |
| Backend_PlanCreate | |
| Backend_PlanUpdate | |
| Backend_Rate | This object represents a rate limitation, which allows to limit the requests which a user can send |
| Backend_RateAllocation | This object represents a rate allocation, in case a request matches it gets assigned to the attached rate |
| Backend_RateCollection | A paginated collection of rate objects |
| Backend_RateCreate | |
| Backend_RateUpdate | |
| Backend_Role | This object represents a role, every user is assigned to a role and all scopes of the role are automatically attached to the user |
| Backend_RoleCollection | A paginated collection of role objects |
| Backend_RoleCreate | |
| Backend_RoleUpdate | |
| Backend_Schema | This object represents a schema to describe a JSON payload |
| Backend_SchemaCollection | A paginated collection of schema objects |
| Backend_SchemaCreate | |
| Backend_SchemaPreviewResponse | |
| Backend_SchemaSource | Contains the TypeSchema specification |
| Backend_SchemaUpdate | |
| Backend_Scope | This object represents a scope. A scope is assigned to a user and is required to access operations |
| Backend_ScopeCategories | |
| Backend_ScopeCategory | |
| Backend_ScopeCategoryScope | |
| Backend_ScopeCollection | A paginated collection of scope objects |
| Backend_ScopeCreate | |
| Backend_ScopeOperation | |
| Backend_ScopeUpdate | |
| Backend_SdkGenerate | |
| Backend_SdkMessage | |
| Backend_SdkResponse | |
| Backend_SdkTypes | Represents available SDK type which can be generated |
| Backend_StatisticChart | |
| Backend_StatisticChartSeries | |
| Backend_StatisticCount | |
| Backend_Test | This object represents a test. A test helps to verify that all operations work as expected |
| Backend_TestCollection | A paginated collection of test objects |
| Backend_TestConfig | |
| Backend_Token | This object represents a token, this an access token which was requested by a user |
| Backend_TokenCollection | A paginated collection of token objects |
| Backend_Transaction | This object represents a transaction. A transaction is generated by the system in case the payment provide provides a message that the payment was successfully executed |
| Backend_TransactionCollection | A paginated collection of transaction objects |
| Backend_TrashData | |
| Backend_TrashDataCollection | A paginated collection of deleted objects |
| Backend_TrashRestore | |
| Backend_TrashTypes | |
| Backend_User | This object represents a user |
| Backend_UserCollection | A paginated collection of user objects |
| Backend_UserCreate | |
| Backend_UserUpdate | |
| Backend_Webhook | This object represents a webhook, a webhook is called in case a specific event was triggered |
| Backend_WebhookCollection | A paginated collection of webhook objects |
| Backend_WebhookCreate | |
| Backend_WebhookResponse | |
| Backend_WebhookUpdate | |
| Common_Collection | Base collection |
| Common_FormContainer | |
| Common_FormElement | |
| Common_FormElementInput | |
| Common_FormElementSelect | |
| Common_FormElementSelectOption | |
| Common_FormElementTag | |
| Common_FormElementTextArea | |
| Common_Message | Common error message |
| Common_Metadata | |
| Consumer_App | |
| Consumer_AppCollection | |
| Consumer_AppCreate | |
| Consumer_AppUpdate | |
| Consumer_AuthorizeMeta | |
| Consumer_AuthorizeRequest | |
| Consumer_AuthorizeResponse | |
| Consumer_Event | |
| Consumer_EventCollection | |
| Consumer_Form | |
| Consumer_FormCollection | |
| Consumer_Grant | |
| Consumer_GrantCollection | |
| Consumer_Identity | |
| Consumer_IdentityCollection | |
| Consumer_Log | |
| Consumer_LogCollection | |
| Consumer_Page | |
| Consumer_PageCollection | |
| Consumer_PaymentCheckoutRequest | |
| Consumer_PaymentCheckoutResponse | |
| Consumer_PaymentPortalRequest | |
| Consumer_PaymentPortalResponse | |
| Consumer_Plan | |
| Consumer_PlanCollection | |
| Consumer_Scope | |
| Consumer_ScopeCategories | |
| Consumer_ScopeCategory | |
| Consumer_ScopeCategoryScope | |
| Consumer_ScopeCollection | |
| Consumer_Token | |
| Consumer_TokenAccessToken | |
| Consumer_TokenCollection | |
| Consumer_TokenCreate | |
| Consumer_TokenUpdate | |
| Consumer_Transaction | |
| Consumer_TransactionCollection | |
| Consumer_UserAccount | |
| Consumer_UserActivate | |
| Consumer_UserEmail | |
| Consumer_UserJWT | |
| Consumer_UserLogin | |
| Consumer_UserPasswordReset | |
| Consumer_UserPlan | |
| Consumer_UserRefresh | |
| Consumer_UserRegister | |
| Consumer_Webhook | |
| Consumer_WebhookCollection | |
| Consumer_WebhookCreate | |
| Consumer_WebhookResponse | |
| Consumer_WebhookUpdate | |
| MarketplaceAction | |
| MarketplaceActionCollection | |
| MarketplaceActionConfig | |
| MarketplaceApp | |
| MarketplaceAppCollection | |
| MarketplaceCollection | |
| MarketplaceInstall | Installs an object from the marketplace |
| MarketplaceMessage | |
| MarketplaceObject | Base class of all objects on the marketplace |
| MarketplaceUser | |
| Passthru | No schema information available |
| System_About | |
| System_AboutApps | |
| System_AboutLink | |
| System_HealthCheck | |
| System_Route | |
| System_RouteMethod | |
| System_RoutePath | |
| System_Schema | |
| System_SchemaForm | |
| System_SchemaTypeSchema |