Skip to main content

Appteum (1.0.0)

Download OpenAPI specification:Download

Objects API description

Introduction

Object API documented in OpenAPI format.

Auth

Sign-Up

you can use this method to sign up new workspace users. In addition to the standard "email" and "password" properties, you must also specify a "profileId". Profiles are used to manage data access control permissions for workspace users. You can create and configure profiles in the Appteum Admin panel in the profiles section of a selected workspace. After sign up, a confirmation code is sent to the user's sign up email address. Users need to provide this code in the "confirm-sign-up" method to verify the user's email.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
email
required
string
password
required
string
profileId
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "profileId": "string"
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "success": true
}

Confirm Sign-Up

To verify their sign up and email identity, workspace users must use the "confirm-sign-up" method. After successfully signing up, an email with a confirmation code is sent to the user's email address. This code must be provided in the "confirm-sign-up" method to complete the registration process and verify the user's identity. Without completing the registration process, workspace users will not be able to access data.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
email
required
string
confirmationCode
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "confirmationCode": "string"
}

Response samples

Content type
application/json
{
  • "success": true
}

Resend Sign-Up Confirmation Code

The 'confirm-sign-up' method is used to verify the identity and registration of workspace users. After a user has successfully registered, an email containing a confirmation code is sent to their registered email address. The confirmation code is required in the 'confirm-sign-up' method to complete the registration process and verify the user's email identity. Access to workspace data is restricted until the sign up is verified.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
email
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "success": true
}

Sign-In

You can use this method to sign in workspace users. For users which have been invited to a workspase and have been issued a temporary password, use the temporary-password-sign-in method to set a permanent password.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
email
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "auth": {
    }
}

Temporary Password Sign-In

You can use this method to sign in workspace users which were issued a temporary password from a a workspace invite. In the "password" property a permanent password is set.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
email
required
string
temporaryPassword
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "temporaryPassword": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "auth": {
    }
}

Refresh JWT token

When you successfully sign in, the platform issues a JWT (JSON Web Token) id token with a default lifetime of 15 minutes. After the token expires, you can use this method to request a new JWT id token using a refresh token. Refresh tokens can be used to issue new JWT tokens for up to 30 days after they are issued, at which point a new sign in will be requested.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
refreshToken
required
string

Responses

Request samples

Content type
application/json
{
  • "refreshToken": "string"
}

Response samples

Content type
application/json
{
  • "auth": {
    }
}

Change User Password

Use this method to change workspace users password

Authorizations:
(ApiKeyAuthBearerAuth)
header Parameters
x-access-token
required
string
Request Body schema: application/json
previousPassword
required
string
newPassword
required
string

Responses

Request samples

Content type
application/json
{
  • "previousPassword": "string",
  • "newPassword": "string"
}

Response samples

Content type
application/json
{
  • "success": true
}

Forgot Password

When a workspace user requests to reset their password using the "forgot password" method, an email will be sent to their registered email address with a confirmation code. To complete the password reset process, the user should provide the confirmation code along with their desired new password in the "confirm-forgot-password" method.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
email
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "success": true
}

Confirm Forgot Password

To set a new password after using the "forgot password" method, the workspace user should use the "confirm-forgot-password" method. This requires the confirmation code that was sent to the user's registered email address when they requested the password reset. Once the user provides the confirmation code in the "confirm-forgot-password" method, they can set their new password.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
email
required
string
password
required
string
confirmationCode
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string",
  • "confirmationCode": "string"
}

Response samples

Content type
application/json
{
  • "success": true
}

Objects

Query Data

Use Appteums sql query language to query you data. ex: select id,name from menu where name = 'new'

Authorizations:
(ApiKeyAuthBearerAuth) ApiKeyAuth
query Parameters
q
required
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "expandable": [
    ],
  • "done": true,
  • "cursor": {
    }
}

Query Data Cursor

To retrieve the next or previous batch of data from a query, use a query cursor either nextDataCursor or previousDataCursor. You can control the size of the batch by setting the "x-query-batch-size" header. By default, the batch size is set to 100, with a maximum value of 1000 and a minimum value of 100.

Authorizations:
(ApiKeyAuthBearerAuth) ApiKeyAuth
path Parameters
cursor
required
string
header Parameters
x-query-batch-size
string

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "expandable": [
    ],
  • "done": true,
  • "cursor": {
    }
}

Create Data

To add data to a specified object, use this API method. The object is identified by the "objectName" path parameter. Object Name is assigned during object creation in the Appteums admin panel.

Authorizations:
(ApiKeyAuthBearerAuth) ApiKeyAuth
path Parameters
objectName
required
string
Request Body schema: application/json
Array of objects
Array
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "dataRecords": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "success": true
}

Update Data

use this api method to update records from the specified object. Objects are specified from the "objectName" path param. Object Name is specified during object creation in Appteums admin panel.

Authorizations:
(ApiKeyAuthBearerAuth) ApiKeyAuth
path Parameters
objectName
required
string
recordId
required
string
Request Body schema: application/json
rowVersion
required
number <double>
required
object

Responses

Request samples

Content type
application/json
{
  • "rowVersion": 0,
  • "dataRecord": {
    }
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "success": true
}

Delete Data

To delete records from a specified object, use this API method. The object is identified by the "objectName" path parameter. Object Name is assigned during object creation in the Appteums admin panel.

Authorizations:
(ApiKeyAuthBearerAuth) ApiKeyAuth
path Parameters
objectName
required
string
recordId
required
string

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "success": true
}

Describe Object

To retrieve information about an object, including its fields, data types, relationships with other objects, and picklist values, use the describe object API method. The object is identified by the "objectName" path parameter. Object Name is assigned during object creation in the Appteums admin panel.

Authorizations:
(ApiKeyAuthBearerAuth) ApiKeyAuth
path Parameters
objectName
required
string

Responses

Response samples

Content type
application/json
{
  • "ObjectEntity": {
    },
  • "Fields": [
    ]
}