REST Model of a form
name | data type | constraints | description |
---|---|---|---|
description | string | Form description | |
folderId | number | Folder ID of the form | |
languages | array of string | Form languages | |
data | object | Form data in JSON format | |
publisher | User | Publisher of the form | |
pdate | number | required int | Publish timestamp |
online | boolean | required boolean | Whether the form is currently online |
modified | boolean | required boolean | Whether the form was modified after being published |
planned | boolean | required boolean | Whether the form has time management set or not |
locked | boolean | required boolean | Whether the form is currently locked |
lockedSince | number | required int | Timestamp, since when the form is locked |
lockedBy | User | User, who locked the form | |
version | ItemVersion | Current form version | |
publishedVersion | ItemVersion | Published form version | |
timeManagement | FormTimeManagement | Time Management | |
successPageId | number | ID of the optional success page | |
successNodeId | number | Node ID of the optional success page | |
Properties inherited from ContentNodeItem |
|||
id | number | ID of the item | |
globalId | string | Global ID of the item | |
name | string | Name of the item | |
creator | User | Creator of the item | |
cdate | number | required int | Creation date of the item |
editor | User | Last editor of the item | |
edate | number | required int | Last Edit Date of the item |
type | ItemType | Item type | |
deleted | DeleteInfo | Deletion information, if object was deleted | |
masterDeleted | DeleteInfo | Deletion information about the master (if the object is not a master itself). | |
folderDeleted | DeleteInfo | Deletion information about the containing folder. |
Example
{ "description" : "...", "folderId" : 12345, "languages" : [ "...", "..." ], "data" : { }, "publisher" : { "id" : 12345, "firstName" : "...", "lastName" : "...", "description" : "...", "email" : "...", "groups" : [ { "id" : 12345, "name" : "...", "description" : "...", "children" : [ { }, { } ] }, { "id" : 12345, "name" : "...", "description" : "...", "children" : [ { }, { } ] } ], "login" : "...", "password" : "..." }, "pdate" : 12345, "online" : true, "modified" : true, "planned" : true, "locked" : true, "lockedSince" : 12345, "lockedBy" : { "id" : 12345, "firstName" : "...", "lastName" : "...", "description" : "...", "email" : "...", "groups" : [ { "id" : 12345, "name" : "...", "description" : "...", "children" : [ { }, { } ] }, { "id" : 12345, "name" : "...", "description" : "...", "children" : [ { }, { } ] } ], "login" : "...", "password" : "..." }, "version" : { "number" : "...", "timestamp" : 12345, "editor" : { "id" : 12345, "firstName" : "...", "lastName" : "...", "description" : "...", "email" : "...", "groups" : [ { }, { } ], "login" : "...", "password" : "..." } }, "publishedVersion" : { "number" : "...", "timestamp" : 12345, "editor" : { "id" : 12345, "firstName" : "...", "lastName" : "...", "description" : "...", "email" : "...", "groups" : [ { }, { } ], "login" : "...", "password" : "..." } }, "timeManagement" : { "at" : 12345, "version" : { "number" : "...", "timestamp" : 12345, "editor" : { } }, "offlineAt" : 12345 }, "successPageId" : 12345, "successNodeId" : 12345, "id" : 12345, "globalId" : "...", "name" : "...", "creator" : { "id" : 12345, "firstName" : "...", "lastName" : "...", "description" : "...", "email" : "...", "groups" : [ { "id" : 12345, "name" : "...", "description" : "...", "children" : [ { }, { } ] }, { "id" : 12345, "name" : "...", "description" : "...", "children" : [ { }, { } ] } ], "login" : "...", "password" : "..." }, "cdate" : 12345, "editor" : { "id" : 12345, "firstName" : "...", "lastName" : "...", "description" : "...", "email" : "...", "groups" : [ { "id" : 12345, "name" : "...", "description" : "...", "children" : [ { }, { } ] }, { "id" : 12345, "name" : "...", "description" : "...", "children" : [ { }, { } ] } ], "login" : "...", "password" : "..." }, "edate" : 12345, "type" : "folder", "deleted" : { "at" : 12345, "by" : { "id" : 12345, "firstName" : "...", "lastName" : "...", "description" : "...", "email" : "...", "groups" : [ { }, { } ], "login" : "...", "password" : "..." } }, "masterDeleted" : { "at" : 12345, "by" : { "id" : 12345, "firstName" : "...", "lastName" : "...", "description" : "...", "email" : "...", "groups" : [ { }, { } ], "login" : "...", "password" : "..." } }, "folderDeleted" : { "at" : 12345, "by" : { "id" : 12345, "firstName" : "...", "lastName" : "...", "description" : "...", "email" : "...", "groups" : [ { }, { } ], "login" : "...", "password" : "..." } } }