Methods

  • GET — Get app metadata description by code

Resource

{
    "application": {
        "__createdAt": "date-time",
        "__createdBy": "uuid",
        "__deletedAt": "date-time",
        "__updatedAt": "date-time",
        "__updatedBy": "uuid",
        "code": "string",
        "elementName": "string",
        "fields": [
            {
                "array": "boolean",
                "calcByFormula": "boolean",
                "code": "string",
                "data": {},
                "defaultValue": {},
                "deleted": "boolean",
                "formula": "string",
                "indexed": "boolean",
                "required": "boolean",
                "searchable": "boolean",
                "single": "boolean",
                "type": "string",
                "view": {
                    "data": {},
                    "name": "string"
                }
            }
        ],
        "forms": {
            "create": {
                "fields": [
                    {
                        "code": "string",
                        "display": "string",
                        "hideEmpty": "boolean",
                        "readonly": "boolean",
                        "required": "boolean",
                        "tooltip": "string"
                    }
                ]
            },
            "detail": {
                "fields": [
                    {
                        "code": "string",
                        "display": "string",
                        "hideEmpty": "boolean",
                        "readonly": "boolean",
                        "required": "boolean",
                        "tooltip": "string"
                    }
                ]
            },
            "edit": {
                "fields": [
                    {
                        "code": "string",
                        "display": "string",
                        "hideEmpty": "boolean",
                        "readonly": "boolean",
                        "required": "boolean",
                        "tooltip": "string"
                    }
                ]
            },
            "massEdit": {
                "fields": [
                    {
                        "code": "string",
                        "display": "string",
                        "hideEmpty": "boolean",
                        "readonly": "boolean",
                        "required": "boolean",
                        "tooltip": "string"
                    }
                ]
            },
            "tile": {
                "fields": [
                    {
                        "code": "string",
                        "display": "string",
                        "hideEmpty": "boolean",
                        "readonly": "boolean",
                        "required": "boolean",
                        "tooltip": "string"
                    }
                ]
            },
            "view": {
                "fields": [
                    {
                        "code": "string",
                        "display": "string",
                        "hideEmpty": "boolean",
                        "readonly": "boolean",
                        "required": "boolean",
                        "tooltip": "string"
                    }
                ]
            }
        },
        "name": "string",
        "namespace": "string",
        "params": {
            "fields": [
                {
                    "array": "boolean",
                    "calcByFormula": "boolean",
                    "code": "string",
                    "data": {},
                    "defaultValue": {},
                    "deleted": "boolean",
                    "formula": "string",
                    "indexed": "boolean",
                    "required": "boolean",
                    "searchable": "boolean",
                    "single": "boolean",
                    "type": "string",
                    "view": {
                        "data": {},
                        "name": "string"
                    }
                }
            ],
            "values": {
                "<key>": {}
            }
        },
        "permissions": {
            "accessType": "string",
            "permissions": {
                "inheritParent": "boolean",
                "values": [
                    {
                        "group": {
                            "id": "uuid",
                            "type": "string"
                        },
                        "inherited": "boolean",
                        "orgunitField": "string",
                        "types": [
                            "string"
                        ]
                    }
                ]
            }
        },
        "type": "string"
    },
    "error": "string",
    "success": "boolean"
}

Properties

Name Type Description Additional
application object

Complete app metadata description

Optional
application.__createdAt date-time

Created on

Optional
application.__createdBy uuid

Created by

Optional
application.__deletedAt date-time

Deleted on

Optional
application.__updatedAt date-time

Edited on

Optional
application.__updatedBy uuid

Edited by

Optional
application.code string

Code

Optional
application.elementName string

Item Name

Optional
application.fields[] array

Fields

Optional
application.fields[].array boolean

Array

Optional
application.fields[].calcByFormula boolean

Set a formula for the field

Optional
application.fields[].code string

Code

Optional
application.fields[].data object

Additional field attributes

Optional
application.fields[].defaultValue object

Default value

Optional
application.fields[].deleted boolean

Deletion flag

Optional
application.fields[].formula string

Formula

Optional
application.fields[].indexed boolean

Search and Sort

Optional
application.fields[].required boolean

Required

Optional
application.fields[].searchable boolean

Full-text search

Optional
application.fields[].single boolean

Attribute that shows if the field stores a single value (if the attriute istrue then it is a single value, if the attibute is false then it is a multiple value)

Optional
application.fields[].type string

Type

Possible values are:

  • String
  • Float
  • Integer
  • Boolean
  • DateTime
  • Duration
  • Category
  • Tag
  • Money
  • File
  • Phone
  • Email
  • Image
  • Status
  • Version
  • JSON
  • SysUser
  • FullName
  • Link
  • SysOSNode
  • SysCollection
  • RefItem
  • Enum
  • Table
  • Account
  • Role
Optional
application.fields[].view object

Short description of data to be displayed in the app field

Optional
application.fields[].view.data object

Display parameters specific for a particular type of field

Optional
application.fields[].view.name string Optional
application.forms object

App forms

Optional
application.forms.create object

Create form

Optional
application.forms.create.fields[] array

Fields

Optional
application.forms.create.fields[].code string

Code

Optional
application.forms.create.fields[].display string

Display name

Optional
application.forms.create.fields[].hideEmpty boolean

Hide if the field is empty

Optional
application.forms.create.fields[].readonly boolean

Read only

Optional
application.forms.create.fields[].required boolean

Required

Optional
application.forms.create.fields[].tooltip string

Tooltip

Optional
application.forms.detail object

Side menu form

Optional
application.forms.detail.fields[] array

Fields

Optional
application.forms.detail.fields[].code string

Code

Optional
application.forms.detail.fields[].display string

Display name

Optional
application.forms.detail.fields[].hideEmpty boolean

Hide if the field is empty

Optional
application.forms.detail.fields[].readonly boolean

Read only

Optional
application.forms.detail.fields[].required boolean

Required

Optional
application.forms.detail.fields[].tooltip string

Tooltip

Optional
application.forms.edit object

Edit form

Optional
application.forms.edit.fields[] array

Fields

Optional
application.forms.edit.fields[].code string

Code

Optional
application.forms.edit.fields[].display string

Display name

Optional
application.forms.edit.fields[].hideEmpty boolean

Hide if the field is empty

Optional
application.forms.edit.fields[].readonly boolean

Read only

Optional
application.forms.edit.fields[].required boolean

Required

Optional
application.forms.edit.fields[].tooltip string

Tooltip

Optional
application.forms.massEdit object

Bulk edit form

Optional
application.forms.massEdit.fields[] array

Fields

Optional
application.forms.massEdit.fields[].code string

Code

Optional
application.forms.massEdit.fields[].display string

Display name

Optional
application.forms.massEdit.fields[].hideEmpty boolean

Hide if the field is empty

Optional
application.forms.massEdit.fields[].readonly boolean

Read only

Optional
application.forms.massEdit.fields[].required boolean

Required

Optional
application.forms.massEdit.fields[].tooltip string

Tooltip

Optional
application.forms.tile object

Tile form

Optional
application.forms.tile.fields[] array

Fields

Optional
application.forms.tile.fields[].code string

Code

Optional
application.forms.tile.fields[].display string

Display name

Optional
application.forms.tile.fields[].hideEmpty boolean

Hide if the field is empty

Optional
application.forms.tile.fields[].readonly boolean

Read only

Optional
application.forms.tile.fields[].required boolean

Required

Optional
application.forms.tile.fields[].tooltip string

Tooltip

Optional
application.forms.view object

View form

Optional
application.forms.view.fields[] array

Fields

Optional
application.forms.view.fields[].code string

Code

Optional
application.forms.view.fields[].display string

Display name

Optional
application.forms.view.fields[].hideEmpty boolean

Hide if the field is empty

Optional
application.forms.view.fields[].readonly boolean

Read only

Optional
application.forms.view.fields[].required boolean

Required

Optional
application.forms.view.fields[].tooltip string

Tooltip

Optional
application.name string

Name

Optional
application.namespace string Namespace. Optional
application.params object

App parameters

Optional
application.params.fields[] array Optional
application.params.fields[].array boolean

Array

Optional
application.params.fields[].calcByFormula boolean

Set a formula for the field

Optional
application.params.fields[].code string

Code

Optional
application.params.fields[].data object

Additional field attributes

Optional
application.params.fields[].defaultValue object

Default value

Optional
application.params.fields[].deleted boolean

Deletion flag

Optional
application.params.fields[].formula string

Formula

Optional
application.params.fields[].indexed boolean

Search and Sort

Optional
application.params.fields[].required boolean

Required

Optional
application.params.fields[].searchable boolean

Full-text search

Optional
application.params.fields[].single boolean

Attribute that shows if the field stores a single value (if the attriute istrue then it is a single value, if the attibute is false then it is a multiple value)

Optional
application.params.fields[].type string

Type

Possible values are:

  • String
  • Float
  • Integer
  • Boolean
  • DateTime
  • Duration
  • Category
  • Tag
  • Money
  • File
  • Phone
  • Email
  • Image
  • Status
  • Version
  • JSON
  • SysUser
  • FullName
  • Link
  • SysOSNode
  • SysCollection
  • RefItem
  • Enum
  • Table
  • Account
  • Role
Optional
application.params.fields[].view object

Short description of data to be displayed in the app field

Optional
application.params.fields[].view.data object

Display parameters specific for a particular type of field

Optional
application.params.fields[].view.name string Optional
application.params.values object Optional
application.params.values.<key> map of object Optional
application.permissions object

Access settings

Optional
application.permissions.accessType string

Possible values are:

  • none
  • collection
  • row
  • directory
Optional
application.permissions.permissions object

List of access permissions

Optional
application.permissions.permissions.inheritParent boolean Optional
application.permissions.permissions.values[] array Optional
application.permissions.permissions.values[].group object

User, group, or org chart item

Optional
application.permissions.permissions.values[].group.id uuid Optional
application.permissions.permissions.values[].group.type string

Possible values are:

  • user
  • group
  • orgstruct
  • role
Optional
application.permissions.permissions.values[].inherited boolean Optional
application.permissions.permissions.values[].orgunitField string Optional
application.permissions.permissions.values[].types[] array of string Optional
application.type string

Type

Optional
error string

Error message if success == false

Optional
success boolean

Successful request flag

Optional