API docs by Redocly

Aptic API Gateway - System (v1.0)

Download OpenAPI specification:Download

Aptic AB: api@aptic.net URL: https://www.aptic.net Terms of Service

System related API for Aptic solutions

Forms

Get initial field values for a specified form

Authorizations:
(oauth2apikey)
path Parameters
entity
required
string

The name of the entity/resource/object to get initial form values for

type
required
string

The type of form

query Parameters
initialValues
required
boolean

Query parameter, needs to be true. If set to true the response will contain initial values for this function

id
string

The identity of the specific resource to get initial values for

subId
string

The sub identity of the specific resource to get initial values for

name
string

The name of the specific part of the resource to get initial values for

Responses

Response samples

Content type
{
  • "name1": "string",
  • "name2": 0,
  • "name3": true
}

Recalculates field values for a specified form

Authorizations:
(oauth2apikey)
path Parameters
entity
required
string

The name of the entity/resource/object to recalculate

type
required
string

The type of form

query Parameters
recalc
required
string

Query parameter, needs to be set. If set to true the response will contain initial values for this function

id
string

The identity of the specific resource to recalculate

subId
string

The sub identity of the specific resource to recalculate

name
string

The name of the specific part of the resource to recalculate

Request Body schema:

A subset of fields used when recalculating the form values

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": 0,
  • "name3": true
}

Response samples

Content type
{
  • "name1": "string",
  • "name2": 0,
  • "name3": true
}

Creates a resource from fields in a specified form

Authorizations:
(oauth2apikey)
path Parameters
entity
required
string

The name of the entity/resource/object to create

type
required
string

The type of form

query Parameters
id
string

The primary identity of the specific resource to create

subId
string

The sub identity of the specific resource to create

name
string

The name of the specific part of the resource to create

Request Body schema:

All fields needed create the resource

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": 0,
  • "name3": true
}

Response samples

Content type
{
  • "name1": "string",
  • "name2": 0,
  • "name3": true
}

Updates a resource with field values from a specified form

Authorizations:
(oauth2apikey)
path Parameters
entity
required
string

The name of the entity/resource/object to store

type
required
string

The type of form

query Parameters
id
string

The primary identity of the specific resource to store

subId
string

The sub identity of the specific resource to store

name
string

The name of the specific part of the resource to store

Request Body schema:

A subset of form fields to update

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": 0,
  • "name3": true
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes a resource identified by a specified form

Authorizations:
(oauth2apikey)
path Parameters
entity
required
string

The name of the entity/resource/object to delete

type
required
string

The type of form

query Parameters
id
string

The primary identity of the specific resource to delete

subId
string

The sub identity of the specific resource to delete

name
string

The name of the specific part of the resource to delete

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }

Metadata

Get general metadata information

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{
  • "textChecksum": 0,
  • "fieldChecksum": 0,
  • "lookupChecksum": 0,
  • "sectionChecksum": 0,
  • "workspaceChecksum": 0
}

Get available sections

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{
  • "sections": [
    ]
}

Get static text translations to current user's language

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }

Get application lookup translations to current user's language

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }

Get configuration lookup translations to current user's language

Authorizations:
(oauth2apikey)
path Parameters
lookupcode
required
string

Lookup code/table to get translations for

Responses

Response samples

Content type
{ }

Get all matching keys and descriptions from dynamic lookup of selected lookup code (excluding "dat:")

Authorizations:
(oauth2apikey)
path Parameters
lookupcode
required
string

Dynamic lookup code to use for the key lookup

Request Body schema:

Request body containing the search string

searchStr
string or null

Search string for dynamic lookups

arguments
Array of strings or null

Additional search arguments

Responses

Request samples

Content type
{
  • "searchStr": "string",
  • "arguments": [
    ]
}

Response samples

Content type
{
  • "values": [
    ]
}

Get dynamic lookup of selected lookup code (excluding "dat:") of the specified key

Authorizations:
(oauth2apikey)
path Parameters
lookupcode
required
string

Dynamic lookup code to use for the key lookup

key
required
string

The key lookup

Responses

Response samples

Content type
{
  • "values": [
    ]
}

Get object field metadata for current user's language

Authorizations:
(oauth2apikey)
path Parameters
objectName
required
string

Object to get field metadata for

Responses

Response samples

Content type
{ }

Get form field metadata for current user's language

Authorizations:
(oauth2apikey)
path Parameters
objectName
required
string

Object to get field metadata for

formName
required
string

Form to get field metadata for

Responses

Response samples

Content type
{ }

Get a form definition for current user

Authorizations:
(oauth2apikey)
path Parameters
objectname
required
string

Name of main object, like client, invoice, etc.

formcode
required
string

Name of the form

Responses

Response samples

Content type
{
  • "title": "string",
  • "metadataFieldsType": "string",
  • "submitMethod": "string",
  • "submitBtnText": "string",
  • "recalc": [
    ],
  • "groups": [
    ]
}

Get workspace template for the user

Authorizations:
(oauth2apikey)
path Parameters
section
required
string

Section/main menu

subsection
required
string

Sub section/sub menu

query Parameters
role
string

Role of user for customized templates

Responses

Response samples

Content type
{ }

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }

System

Get general system information

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{
  • "version": "string",
  • "copyright": "string",
  • "fullCopyright": "string",
  • "systemName": "string",
  • "systemDescription": "string",
  • "licensedTo": "string",
  • "customerNo": "string",
  • "validUntilCollect": "2019-08-24T14:15:22Z",
  • "validUntilEdge": "2019-08-24T14:15:22Z",
  • "validUntilCredit": "2019-08-24T14:15:22Z",
  • "languages": "string",
  • "systemTimeZone": 0,
  • "systemTimeZoneCode": "string",
  • "systemTimeZoneDescription": "string",
  • "systemDate": "2019-08-24T14:15:22Z"
}

Send generic system command

Authorizations:
(oauth2apikey)
path Parameters
command
required
string

System command

Request Body schema:

System command arguments

argument
Array of strings or null

Array of up to 6 arguments to the server command

Responses

Request samples

Content type
{
  • "argument": [
    ]
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Refresh all caches. This can be a resource demaning operation.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Refresh specific cache

Authorizations:
(oauth2apikey)
path Parameters
name
required
string

Name of cache to refresh

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Sets new logging level

Authorizations:
(oauth2apikey)
Request Body schema:

New log level

logLevel
integer or null <int32>

New logging level, between 0 and 10. 1 is default log level.

Responses

Request samples

Content type
{
  • "logLevel": 0
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Changes the system date

Authorizations:
(oauth2apikey)
Request Body schema:

New system date

systemDate
string or null

New system date. Null or empty date resets the system date to current date.

Responses

Request samples

Content type
{
  • "systemDate": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }