Adds a form to a database.
Request
POST https://www.activityinfo.org/resources/databases/{databaseId}/forms
Request body
application/json
object | |||
formResource | object | required | |
id | string | The resource's id. Form and subform resources must have globally-unique ids (across all of ActivityInfo) but folder ids are only guaranteed to be unique within a single database. | required |
type | string | The resource type.Values:
|
required |
parentId | string | The id of this resource's parent, for example, a folder id. If this is a top-level folder or form, the the parentId will be the id of the database itself. | required |
label | string | The resource's human-readable label. | required |
visibility | string | The resource's visibility.Values:
|
required |
formClass | object | required | |
id | string | required | |
label | string | required | |
schemaVersion | string | required | |
databaseId | string | required | |
parentFormId | string | optional | |
elements | array[object] | required | |
id | string | required | |
code | string | required | |
label | string | required | |
relevanceCondition | string | required | |
validationCondition | string | required | |
visible | boolean | required | |
required | boolean | required | |
key | boolean | required | |
type | string | required | |
securityCategoryId | string | optional | |
typeParameters | object | required | |
units | string | optional | |
inputMask | string | optional | |
cardinality | string | optional | |
range | object | optional | |
formId | string | optional | |
items | array[object] | optional | |
formula | string | optional | |
prefixFormula | string | optional |
Successful response
application/json
object | |||
database | object | required | |
databaseId | string | This database's id | required |
userId | string | The id of the requesting user. The contents of the tree depends on the permissions of the requesting user. | optional |
version | string | The monotonically-increasing version of the database tree. The version number is incremented whenever a change is made that affects the database tree. | required |
label | string | This database's human-readable label. | required |
description | string | required | |
ownerRef | object | required | |
id | string | required | |
name | string | required | |
string | required | ||
language | string | Current database language | required |
originalLanguage | string | Original database language | optional |
languages | array[string] | The languages that have been defined for this database translation. | required |
continuousTranslation | boolean | True if the database continuous automatic translation is enabled | required |
translationFromDbMemory | boolean | True if automatic translation from database memory is allowed for the database | required |
thirdPartyTranslation | boolean | True if third-party translation is allowed for the database | required |
suspended | boolean | True if this database is suspended for billing reasons | required |
role | object | The requesting user's assigned role in this database. | required |
roleId | string | The id of the role assigned to this user. | required |
roleParameters | object | The values of the parameters defined for this role. | required |
roleResources | array[string] | The resources (database, folder, forms, or subforms) to which the role's permissions are to apply. | required |
roles | array[object] | The roles that have been defined for this database. | required |
id | string | This role's id | required |
label | string | This role's human-readable label | required |
permissions | array[object] | Permissions granted this role. | required |
operation | string | Values:
|
required |
filter | string | A formula which restricts a permission to specific records. Only record-level permissions can be filtered. | optional |
securityCategories | array[string] | required | |
parameters | array[object] | Parameters defined for this role. Parameters can be referenced in filtering formulas. | required |
parameterId | string | required | |
label | string | required | |
range | string | required | |
filters | array[object] | Pre-defined filters. Role filters allow other users to choose filters for permissions without having to write formulas themselves. | required |
id | string | This filter's id. | required |
label | string | This filter's human-readable label | required |
filter | string | A formula that can be used to filter a record-level permission. | required |
grants | array[object] | required | |
resourceId | string | required | |
operations | array[string] | required | |
securityCategories | array[object] | The security categories that have been defined for this database. | required |
id | string | This security category's id | required |
label | string | This security category's human-readable label | required |
resources | array[object] | The set of resources (folders, forms, and subforms) that belong to this database. | required |
id | string | The resource's id. Form and subform resources must have globally-unique ids (across all of ActivityInfo) but folder ids are only guaranteed to be unique within a single database. | required |
type | string | The resource type.Values:
|
required |
parentId | string | The id of this resource's parent, for example, a folder id. If this is a top-level folder or form, the the parentId will be the id of the database itself. | required |
label | string | The resource's human-readable label. | required |
visibility | string | The resource's visibility.Values:
|
required |
locks | array[object] | The record locks that have been defined on this database. | required |
id | string | This lock's id. | required |
label | string | A human-readable label for this lock | required |
resourceId | string | The resource (database, folder, form, or subform) to which this lock applies. | required |
dateRange | object | The date range to which this lock applies. | optional |
startDate | local_date | required | |
endDate | local_date | required | |
formula | string | The formula to which this rule based lock applies. | optional |
message | string | user descroption pf the rule based lock. | optional |
deactivated | boolean | required | |
grants | array[object] | The permission grants that have been made to the requesting user for this database. | required |
resourceId | string | required | |
operations | array[string] | required | |
billingAccountId | integer | required | |
forms | array[object] | required | |
id | string | The id of the form | required |
visible | boolean | True if the form is visible to the authenticated user | required |
deleted | boolean | True if the form has been deleted | required |
schema | object | required | |
id | string | required | |
label | string | required | |
schemaVersion | string | required | |
databaseId | string | required | |
parentFormId | string | optional | |
elements | array[object] | required | |
id | string | required | |
code | string | required | |
label | string | required | |
relevanceCondition | string | required | |
validationCondition | string | required | |
visible | boolean | required | |
required | boolean | required | |
key | boolean | required | |
type | string | required | |
securityCategoryId | string | optional | |
typeParameters | object | required | |
units | string | optional | |
inputMask | string | optional | |
cardinality | string | optional | |
range | object | optional | |
formId | string | optional | |
items | array[object] | optional | |
formula | string | optional | |
prefixFormula | string | optional | |
permissions | object | required | |
suspended | boolean | True if the form belongs to a suspended database. | required |
Error responses
Status Code | Error Code | Description |
---|---|---|
401 | AUTHENTICATION_ |
The request must be authenticated |