REST Model of a form
| name | data type | constraints | description |
|---|---|---|---|
| publisher | User | Publisher | |
| futurePublisher | User | Future Publisher | |
| pdate | number | required int | Publish Date |
| id | number | ID of the item | |
| unpublishedDate | number | Gets the unpublished date. | |
| globalId | string | Global ID of the item | |
| name | string | Name of the item | |
| description | string | Form description | |
| creator | User | read-only | Creator of the item |
| unpublisher | User | Gets the unpublisher. | |
| cdate | number | required int, read-only int | Creation date of the item as unix timestamp |
| editor | User | read-only | Last editor of the item |
| folderId | number | Folder ID of the form | |
| edate | number | required int, read-only int | Last Edit Date of the item as unix timestamp |
| futureUnpublisher | User | Gets the user that set the unpublish action. | |
| type | ItemType | read-only | Item type |
| languages | array of string | Form languages | |
| data | object | Form data in JSON format | |
| online | boolean | required boolean | Whether the form is currently online |
| modified | boolean | required boolean | Whether the form was modified after being published |
| deleted | DeleteInfo | read-only | Deletion information, if object was deleted |
| planned | boolean | required boolean | Whether the form has time management set or not |
| masterDeleted | DeleteInfo | read-only | Deletion information about the master (if the object is not a master itself). |
| locked | boolean | required boolean | Whether the form is currently locked |
| lockedSince | number | required int | Timestamp, since when the form is locked |
| folderDeleted | DeleteInfo | read-only | Deletion information about the containing folder. |
| 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 |
Example
{
"publisher" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ {
"id" : 12345,
"name" : "...",
"description" : "...",
"children" : [ { }, { } ]
}, {
"id" : 12345,
"name" : "...",
"description" : "...",
"children" : [ { }, { } ]
} ],
"login" : "...",
"password" : "..."
},
"futurePublisher" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ {
"id" : 12345,
"name" : "...",
"description" : "...",
"children" : [ { }, { } ]
}, {
"id" : 12345,
"name" : "...",
"description" : "...",
"children" : [ { }, { } ]
} ],
"login" : "...",
"password" : "..."
},
"pdate" : 12345,
"id" : 12345,
"unpublishedDate" : 12345,
"globalId" : "...",
"name" : "...",
"description" : "...",
"creator" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ {
"id" : 12345,
"name" : "...",
"description" : "...",
"children" : [ { }, { } ]
}, {
"id" : 12345,
"name" : "...",
"description" : "...",
"children" : [ { }, { } ]
} ],
"login" : "...",
"password" : "..."
},
"unpublisher" : {
"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" : "..."
},
"folderId" : 12345,
"edate" : 12345,
"futureUnpublisher" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ {
"id" : 12345,
"name" : "...",
"description" : "...",
"children" : [ { }, { } ]
}, {
"id" : 12345,
"name" : "...",
"description" : "...",
"children" : [ { }, { } ]
} ],
"login" : "...",
"password" : "..."
},
"type" : "folder",
"languages" : [ "...", "..." ],
"data" : { },
"online" : true,
"modified" : true,
"deleted" : {
"at" : 12345,
"by" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
}
},
"planned" : true,
"masterDeleted" : {
"at" : 12345,
"by" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
}
},
"locked" : true,
"lockedSince" : 12345,
"folderDeleted" : {
"at" : 12345,
"by" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
}
},
"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" : {
"futurePublisher" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"futureUnpublisher" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"at" : 12345,
"version" : {
"number" : "...",
"timestamp" : 12345,
"editor" : { }
},
"offlineAt" : 12345
},
"successPageId" : 12345,
"successNodeId" : 12345
}