Resource for forms
List forms
name | type | description | default | constraints |
---|---|---|---|---|
createdbefore | query | Timestamp to search objects, which were created before a given time (0 for all objects) | 0 | int |
createdsince | query | Timestamp to search objects, which were created since a given time (0 for all objects) | 0 | int |
creator | query | Pattern for restricting objects by creator | ||
editedbefore | query | Timestamp to search objects, which were edited before a given time (0 for all objects) | 0 | int |
editedsince | query | Timestamp to search objects, which were edited since a given time (0 for all objects) | 0 | int |
editor | query | Pattern for restricting objects by editor | ||
folderId | query | Folder ID | ||
iscreator | query | (optional) true when only the objects created by the user shall be returned | false | boolean |
iseditor | query | (optional) true when only the objects last edited by the user shall be returned | false | boolean |
ispublisher | query | (optional) true when only the objects which were last published by the user shall be returned | false | boolean |
modified | query | (optional) true to restrict to modified objects, false to restrict to unmodified objects | boolean | |
online | query | (optional) true to restrict to online objects, false to restrict to offline objects | boolean | |
page | query | Returned page, if paging is used. Paging starts with 1 |
1 | int |
pageSize | query | Page size for paging. If this is set to -1 no paging is used (all matching items are returned).
Setting this to 0 will return no items. |
-1 | int |
publishedbefore | query | Timestamp to search objects, which were published before a given time (0 for all objects) | 0 | int |
publishedsince | query | Timestamp to search objects, which were published since a given time (0 for all objects) | 0 | int |
publisher | query | Pattern for restricting objects by publisher | ||
q | query | Query string for filtering | ||
recursive | query | (optional) true when the items shall be fetched recursively, false if not. Defaults to false | false | boolean |
sort | query | Comma separated list of sorted attributes.
Each attribute name may be prefixed with + for sorting in ascending order or - for sorting in descending order |
name | |
wastebin | query | "exclude" (default) to exclude deleted items, "include" to include deleted items, "only" to return only deleted items | exclude | "exclude" or "include" or "only" |
code | condition |
---|---|
200 | The list of forms is returned. |
404 | The given folder does not exist |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | FormListResponse (JSON) | response containing a list of forms |
GET /form Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"perms" : {
"property1" : [ "edit", "create" ],
"property2" : [ "view", "edit" ]
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Create a new form in the folder
media type | data type | description |
---|---|---|
application/json | FormModel (JSON) | form |
code | condition |
---|---|
201 | The form was created |
404 | The given folder does not exist |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | FormResponse (JSON) | response containing the created form |
POST /form
Content-Type: application/json
Accept: application/json
{
"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" : "channel",
"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" : "..."
}
}
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"item" : { },
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Delete a form
name | type | description |
---|---|---|
id | path | form ID |
code | condition |
---|---|
200 | The form was deleted |
404 | The form with given ID does not exist |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | response |
DELETE /form/{id} Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Load a form
name | type | description |
---|---|---|
id | path | form ID |
code | condition |
---|---|
200 | The form is returned |
404 | The form with given ID does not exist |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | FormResponse (JSON) | response containing the form |
GET /form/{id} Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"item" : { },
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Update a form
name | type | description |
---|---|---|
id | path | form ID |
media type | data type | description |
---|---|---|
application/json | FormModel (JSON) | form data to update |
code | condition |
---|---|
200 | The form was updated |
404 | The form with given ID does not exist |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | FormResponse (JSON) | updated form |
PUT /form/{id}
Content-Type: application/json
Accept: application/json
{
"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" : "page",
"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" : "..."
}
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"item" : { },
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the pages using one of the given forms
name | type | description | default | constraints | multivalued |
---|---|---|---|---|---|
contenttags | query | True if the contenttags shall be attached to all returned pages. Default is false | false | boolean | no |
folder | query | True for adding folder info to the pages. Default is false. | false | boolean | no |
id | query | list of form IDs, for which the usage shall be fetched | int | yes | |
langvars | query | True for adding the language variants to the pages. Default is false. | false | boolean | no |
maxItems | query | maximum number of items to be returned, set to -1 for returning all items | -1 | int | no |
nodeId | query | ID of the node | int | no | |
objecttags | query | True if the objecttags shall be attached to all returned pages. Default is false. | false | boolean | no |
pages | query | true (default) if the pages shall be returned, false for only returning the counts | true | boolean | no |
skipCount | query | number of items to be skipped, set to 0 for skipping no items | 0 | int | no |
sortby | query | (optional) attribute to sort by. defaults to name | name | no | |
sortorder | query | (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc". | asc | no | |
template | query | True for adding template info to the pages. Default is false. | false | boolean | no |
translationstatus | query | True if the translationstatus information shall be added for every page. Default is false. | false | boolean | no |
code | condition |
---|---|
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | PageUsageListResponse (JSON) | list of pages using the given forms |
GET /form/usage/page Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"withoutPermission" : 12345,
"total" : 12345,
"pages" : [ {
"niceUrl" : "...",
"alternateUrls" : [ "...", "..." ],
"fileName" : "...",
"description" : "...",
"templateId" : 12345,
"folderId" : 12345,
"priority" : 12345,
"publisher" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"pdate" : 12345,
"language" : "...",
"languageName" : "...",
"tags" : {
"property1" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
}
},
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"pageVariants" : [ { }, { } ],
"readOnly" : true,
"timeManagement" : {
"at" : 12345,
"version" : { },
"offlineAt" : 12345,
"queuedPublish" : { },
"queuedOffline" : { }
},
"path" : "...",
"url" : "...",
"liveUrl" : "...",
"publishPath" : "...",
"online" : true,
"modified" : true,
"queued" : true,
"planned" : true,
"template" : {
"inheritedFrom" : "...",
"masterNode" : "...",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"description" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"locked" : true,
"markupLanguage" : { },
"inherited" : true,
"folderId" : 12345,
"masterId" : 12345,
"path" : "...",
"templateTags" : {
"property1" : { },
"property2" : { }
},
"objectTags" : {
"property1" : { },
"property2" : { }
},
"source" : "...",
"channelSetId" : 12345,
"channelId" : 12345,
"master" : true
},
"folder" : {
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"motherId" : 12345,
"publishDir" : "...",
"description" : "...",
"nodeId" : 12345,
"inherited" : true,
"atposidx" : "...",
"startPageId" : { },
"tags" : {
"property1" : { },
"property2" : { }
},
"subfolders" : [ { }, { } ],
"hasSubfolders" : true,
"privileges" : [ "createpage", "deletefile" ],
"privilegeBits" : "...",
"privilegeMap" : { },
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ { }, { } ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ { }, { } ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "node",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
},
"contentSetId" : 12345,
"contentGroupId" : 12345,
"languageVariants" : {
"property1" : { },
"property2" : { }
},
"inherited" : true,
"locked" : true,
"lockedSince" : 12345,
"lockedBy" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"workflow" : {
"groups" : [ { }, { } ],
"message" : "...",
"user" : { },
"modified" : true,
"timestamp" : 12345
},
"translationStatus" : {
"pageId" : 12345,
"name" : "...",
"versionTimestamp" : 12345,
"language" : "...",
"inSync" : true,
"version" : "...",
"latestVersion" : { }
},
"currentVersion" : {
"number" : "...",
"timestamp" : 12345,
"editor" : { }
},
"publishedVersion" : {
"number" : "...",
"timestamp" : 12345,
"editor" : { }
},
"versions" : [ {
"number" : "...",
"timestamp" : 12345,
"editor" : { }
}, {
"number" : "...",
"timestamp" : 12345,
"editor" : { }
} ],
"contentId" : 12345,
"channelSetId" : 12345,
"channelId" : 12345,
"master" : true,
"disinheritedChannels" : [ {
"folderId" : 12345,
"publishDir" : "...",
"binaryPublishDir" : "...",
"pubDirSegment" : true,
"https" : true,
"host" : "...",
"utf8" : true,
"publishFs" : true,
"publishFsPages" : true,
"publishFsFiles" : true,
"publishContentMap" : true,
"publishContentMapPages" : true,
"publishContentMapFiles" : true,
"publishContentMapFolders" : true,
"contentRepositoryId" : 12345,
"disablePublish" : true,
"editorVersion" : 12345,
"contentEditor" : "AlohaEditor",
"defaultFileFolderId" : 12345,
"defaultImageFolderId" : 12345,
"languagesId" : [ 12345, 12345 ],
"masterId" : 12345,
"inheritedFromId" : 12345,
"masterNodeId" : 12345,
"urlRenderWayPages" : 12345,
"urlRenderWayFiles" : 12345,
"meshPreviewUrl" : "...",
"insecurePreviewUrl" : true,
"meshProject" : "...",
"omitPageExtension" : true,
"pageLanguageCode" : "NONE",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "file",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"folderId" : 12345,
"publishDir" : "...",
"binaryPublishDir" : "...",
"pubDirSegment" : true,
"https" : true,
"host" : "...",
"utf8" : true,
"publishFs" : true,
"publishFsPages" : true,
"publishFsFiles" : true,
"publishContentMap" : true,
"publishContentMapPages" : true,
"publishContentMapFiles" : true,
"publishContentMapFolders" : true,
"contentRepositoryId" : 12345,
"disablePublish" : true,
"editorVersion" : 12345,
"contentEditor" : "LiveEditor",
"defaultFileFolderId" : 12345,
"defaultImageFolderId" : 12345,
"languagesId" : [ 12345, 12345 ],
"masterId" : 12345,
"inheritedFromId" : 12345,
"masterNodeId" : 12345,
"urlRenderWayPages" : 12345,
"urlRenderWayFiles" : 12345,
"meshPreviewUrl" : "...",
"insecurePreviewUrl" : true,
"meshProject" : "...",
"omitPageExtension" : true,
"pageLanguageCode" : "PATH",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "form",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"customCdate" : 12345,
"customEdate" : 12345,
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"cdate" : 12345,
"editor" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"edate" : 12345,
"type" : "page",
"deleted" : {
"at" : 12345,
"by" : { }
},
"masterDeleted" : {
"at" : 12345,
"by" : { }
},
"folderDeleted" : {
"at" : 12345,
"by" : { }
}
}, {
"niceUrl" : "...",
"alternateUrls" : [ "...", "..." ],
"fileName" : "...",
"description" : "...",
"templateId" : 12345,
"folderId" : 12345,
"priority" : 12345,
"publisher" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"pdate" : 12345,
"language" : "...",
"languageName" : "...",
"tags" : {
"property1" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
}
},
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"pageVariants" : [ { }, { } ],
"readOnly" : true,
"timeManagement" : {
"at" : 12345,
"version" : { },
"offlineAt" : 12345,
"queuedPublish" : { },
"queuedOffline" : { }
},
"path" : "...",
"url" : "...",
"liveUrl" : "...",
"publishPath" : "...",
"online" : true,
"modified" : true,
"queued" : true,
"planned" : true,
"template" : {
"inheritedFrom" : "...",
"masterNode" : "...",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"description" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"locked" : true,
"markupLanguage" : { },
"inherited" : true,
"folderId" : 12345,
"masterId" : 12345,
"path" : "...",
"templateTags" : {
"property1" : { },
"property2" : { }
},
"objectTags" : {
"property1" : { },
"property2" : { }
},
"source" : "...",
"channelSetId" : 12345,
"channelId" : 12345,
"master" : true
},
"folder" : {
"inheritedFrom" : "...",
"inheritedFromId" : 12345,
"masterNode" : "...",
"masterNodeId" : 12345,
"motherId" : 12345,
"publishDir" : "...",
"description" : "...",
"nodeId" : 12345,
"inherited" : true,
"atposidx" : "...",
"startPageId" : { },
"tags" : {
"property1" : { },
"property2" : { }
},
"subfolders" : [ { }, { } ],
"hasSubfolders" : true,
"privileges" : [ "viewpage", "deletefolder" ],
"privilegeBits" : "...",
"privilegeMap" : { },
"path" : "...",
"masterId" : 12345,
"channelsetId" : 12345,
"channelId" : 12345,
"isMaster" : true,
"disinheritedChannels" : [ { }, { } ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"meshProject" : "...",
"breadcrumbs" : [ { }, { } ],
"nameI18n" : {
"property1" : "...",
"property2" : "..."
},
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"publishDirI18n" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "node",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
},
"contentSetId" : 12345,
"contentGroupId" : 12345,
"languageVariants" : {
"property1" : { },
"property2" : { }
},
"inherited" : true,
"locked" : true,
"lockedSince" : 12345,
"lockedBy" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"workflow" : {
"groups" : [ { }, { } ],
"message" : "...",
"user" : { },
"modified" : true,
"timestamp" : 12345
},
"translationStatus" : {
"pageId" : 12345,
"name" : "...",
"versionTimestamp" : 12345,
"language" : "...",
"inSync" : true,
"version" : "...",
"latestVersion" : { }
},
"currentVersion" : {
"number" : "...",
"timestamp" : 12345,
"editor" : { }
},
"publishedVersion" : {
"number" : "...",
"timestamp" : 12345,
"editor" : { }
},
"versions" : [ {
"number" : "...",
"timestamp" : 12345,
"editor" : { }
}, {
"number" : "...",
"timestamp" : 12345,
"editor" : { }
} ],
"contentId" : 12345,
"channelSetId" : 12345,
"channelId" : 12345,
"master" : true,
"disinheritedChannels" : [ {
"folderId" : 12345,
"publishDir" : "...",
"binaryPublishDir" : "...",
"pubDirSegment" : true,
"https" : true,
"host" : "...",
"utf8" : true,
"publishFs" : true,
"publishFsPages" : true,
"publishFsFiles" : true,
"publishContentMap" : true,
"publishContentMapPages" : true,
"publishContentMapFiles" : true,
"publishContentMapFolders" : true,
"contentRepositoryId" : 12345,
"disablePublish" : true,
"editorVersion" : 12345,
"contentEditor" : "LiveEditor",
"defaultFileFolderId" : 12345,
"defaultImageFolderId" : 12345,
"languagesId" : [ 12345, 12345 ],
"masterId" : 12345,
"inheritedFromId" : 12345,
"masterNodeId" : 12345,
"urlRenderWayPages" : 12345,
"urlRenderWayFiles" : 12345,
"meshPreviewUrl" : "...",
"insecurePreviewUrl" : true,
"meshProject" : "...",
"omitPageExtension" : true,
"pageLanguageCode" : "FILENAME",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "folder",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
}, {
"folderId" : 12345,
"publishDir" : "...",
"binaryPublishDir" : "...",
"pubDirSegment" : true,
"https" : true,
"host" : "...",
"utf8" : true,
"publishFs" : true,
"publishFsPages" : true,
"publishFsFiles" : true,
"publishContentMap" : true,
"publishContentMapPages" : true,
"publishContentMapFiles" : true,
"publishContentMapFolders" : true,
"contentRepositoryId" : 12345,
"disablePublish" : true,
"editorVersion" : 12345,
"contentEditor" : "LiveEditor",
"defaultFileFolderId" : 12345,
"defaultImageFolderId" : 12345,
"languagesId" : [ 12345, 12345 ],
"masterId" : 12345,
"inheritedFromId" : 12345,
"masterNodeId" : 12345,
"urlRenderWayPages" : 12345,
"urlRenderWayFiles" : 12345,
"meshPreviewUrl" : "...",
"insecurePreviewUrl" : true,
"meshProject" : "...",
"omitPageExtension" : true,
"pageLanguageCode" : "NONE",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : { },
"cdate" : 12345,
"editor" : { },
"edate" : 12345,
"type" : "form",
"deleted" : { },
"masterDeleted" : { },
"folderDeleted" : { }
} ],
"excluded" : true,
"disinheritDefault" : true,
"disinherited" : true,
"customCdate" : 12345,
"customEdate" : 12345,
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"cdate" : 12345,
"editor" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"edate" : 12345,
"type" : "image",
"deleted" : {
"at" : 12345,
"by" : { }
},
"masterDeleted" : {
"at" : 12345,
"by" : { }
},
"folderDeleted" : {
"at" : 12345,
"by" : { }
}
} ],
"hasMoreItems" : true,
"numItems" : 12345,
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the templates using one of the given forms
name | type | description | default | constraints | multivalued |
---|---|---|---|---|---|
id | query | list of form ids, for which the usage shall be fetched | int | yes | |
maxItems | query | maximum number of items to be returned, set to -1 for returning all items | -1 | int | no |
nodeId | query | id of the node | int | no | |
skipCount | query | number of items to be skipped, set to 0 for skipping no items | 0 | int | no |
sortby | query | (optional) attribute to sort by. defaults to name | name | no | |
sortorder | query | (optional) result sort order - may be "asc" for ascending or "desc" for descending other strings will be ignored. defaults to "asc". | asc | no | |
templates | query | true (default) if the templates shall be returned, false for only returning the counts | true | boolean | no |
code | condition |
---|---|
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | TemplateUsageListResponse (JSON) | response |
GET /form/usage/template Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"withoutPermission" : 12345,
"total" : 12345,
"templates" : [ {
"inheritedFrom" : "...",
"masterNode" : "...",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"description" : "...",
"creator" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"cdate" : 12345,
"editor" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"edate" : 12345,
"locked" : true,
"markupLanguage" : {
"id" : 12345,
"name" : "...",
"extension" : "...",
"contentType" : "..."
},
"inherited" : true,
"folderId" : 12345,
"masterId" : 12345,
"path" : "...",
"templateTags" : {
"property1" : {
"mandatory" : true,
"editableInPage" : true,
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
},
"property2" : {
"mandatory" : true,
"editableInPage" : true,
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
}
},
"objectTags" : {
"property1" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
}
},
"source" : "...",
"channelSetId" : 12345,
"channelId" : 12345,
"master" : true
}, {
"inheritedFrom" : "...",
"masterNode" : "...",
"id" : 12345,
"globalId" : "...",
"name" : "...",
"description" : "...",
"creator" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"cdate" : 12345,
"editor" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"edate" : 12345,
"locked" : true,
"markupLanguage" : {
"id" : 12345,
"name" : "...",
"extension" : "...",
"contentType" : "..."
},
"inherited" : true,
"folderId" : 12345,
"masterId" : 12345,
"path" : "...",
"templateTags" : {
"property1" : {
"mandatory" : true,
"editableInPage" : true,
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
},
"property2" : {
"mandatory" : true,
"editableInPage" : true,
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "TEMPLATETAG"
}
},
"objectTags" : {
"property1" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "OBJECTTAG"
},
"property2" : {
"id" : 12345,
"name" : "...",
"constructId" : 12345,
"construct" : { },
"active" : true,
"properties" : {
"property1" : { },
"property2" : { }
},
"type" : "CONTENTTAG"
}
},
"source" : "...",
"channelSetId" : 12345,
"channelId" : 12345,
"master" : true
} ],
"hasMoreItems" : true,
"numItems" : 12345,
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the total usage information of the given forms.
name | type | description | constraints | multivalued |
---|---|---|---|---|
id | query | list of form IDs | int | yes |
nodeId | query | ID of the node | int | no |
code | condition |
---|---|
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | TotalUsageResponse (JSON) | Total usage response |
GET /form/usage/total Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"infos" : {
"property1" : {
"total" : 12345,
"pages" : 12345,
"folders" : 12345,
"templates" : 12345,
"files" : 12345,
"images" : 12345
},
"property2" : {
"total" : 12345,
"pages" : 12345,
"folders" : 12345,
"templates" : 12345,
"files" : 12345,
"images" : 12345
}
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Remove a form from the wastebin
name | type | description |
---|---|---|
id | path | form ID |
code | condition |
---|---|
200 | Form was removed from the wastebin |
404 | Form did not exist in the wastebin |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | response |
DELETE /form/wastebin/{id} Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Download binary data from Mesh, which has been submitted to the form
name | type | description |
---|---|---|
id | path | form ID |
code | condition |
---|---|
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/zip | (custom) | response |
GET /form/{id}/binaries Accept: application/zip
HTTP/1.1 200 OK
Content-Type: application/zip
...
List data entries from Mesh, which have been submitted to the form
name | type | description | default | constraints |
---|---|---|---|---|
id | path | form ID | ||
page | query | Returned page, if paging is used. Paging starts with 1 |
1 | int |
pageSize | query | Page size for paging. If this is set to -1 no paging is used (all matching items are returned).
Setting this to 0 will return no items. |
-1 | int |
publishedOnly | query | Use only published objects | boolean | |
q | query | Query string for filtering |
code | condition |
---|---|
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
GET /form/{id}/data Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
...
Export data from Mesh, which has been submitted to the form
name | type | description | constraints | multivalued |
---|---|---|---|---|
id | path | form ID | no | |
format | query | Export format (CSV) | no | |
lang | query | Optional language codes | yes | |
options | query | Options for the export format | no | |
publishedOnly | query | Use only published objects | boolean | no |
q | query | Query string for filtering | no |
code | condition |
---|---|
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
GET /form/{id}/export Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
...
Unlock the form
name | type | description |
---|---|---|
id | path | form ID |
code | condition |
---|---|
200 | The form was unlocked |
404 | The form with given ID does not exist |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | FormResponse (JSON) | response containing the unlocked form |
DELETE /form/{id}/lock Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"item" : { },
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Lock the form
name | type | description |
---|---|---|
id | path | form ID |
code | condition |
---|---|
200 | The form was locked |
404 | The form with given ID does not exist |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | FormResponse (JSON) | response containing the locked form |
PUT /form/{id}/lock Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"item" : { },
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Take a form offline
name | type | description | default | constraints |
---|---|---|---|---|
id | path | form ID | ||
at | query | timestamp for scheduled taking offline (0 for taking offline immediately) | 0 | int |
code | condition |
---|---|
200 | The form was taken offline |
404 | The form with given ID does not exist |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | FormResponse (JSON) | response containing the form |
DELETE /form/{id}/online Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"item" : { },
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Publish a form
name | type | description | default | constraints |
---|---|---|---|---|
id | path | form ID | ||
at | query | timestamp for scheduled publishing (0 for publishing immediately) | 0 | int |
keepVersion | query | true to keep the currently scheduled version (if "at" is not 0 and a form version is currently scheduled to be published) | false | boolean |
code | condition |
---|---|
200 | The form was published |
404 | The form with given ID does not exist |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | FormResponse (JSON) | response containing the form |
PUT /form/{id}/online Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"item" : { },
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Get the versions of a form
name | type | description |
---|---|---|
id | path | form ID |
code | condition |
---|---|
200 | The versions are returned |
404 | The form with given ID does not exist |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ItemVersionListResponse (JSON) | response containing a list of versions |
GET /form/{id}/version Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"perms" : {
"property1" : [ "edit", "delete" ],
"property2" : [ "publish", "create" ]
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Restore a form from the wastebin
name | type | description |
---|---|---|
id | path | form ID |
code | condition |
---|---|
200 | Form was restored from the wastebin |
404 | Form did not exist in the wastebin |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | FormResponse (JSON) | response containing the restored form |
POST /form/wastebin/{id}/restore Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"item" : { },
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Permanently delete a single data entry from Mesh, which has been submitted to the form
name | type | description |
---|---|---|
dataId | path | |
id | path | form ID |
code | condition |
---|---|
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
DELETE /form/{id}/data/{dataId} Accept: application/json
HTTP/1.1 204 No Content
Content-Type: application/json
...
Load a single data entry from Mesh, which has been submitted to the form
name | type | description |
---|---|---|
dataId | path | |
id | path | form ID |
code | condition |
---|---|
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
GET /form/{id}/data/{dataId} Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
...
Move the form to the given folder
name | type | description |
---|---|---|
folderId | path | target folder ID |
id | path | form ID |
code | condition |
---|---|
200 | Form was moved to the folder |
404 | Either the form or the folder do not exist |
409 | Form cannot be moved, because of reasons TODO |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | FormResponse (JSON) | folder response |
PUT /form/{id}/folder/{folderId} Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"item" : { },
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Remove the time for scheduled taking offline
name | type | description |
---|---|---|
id | path | form ID |
code | condition |
---|---|
200 | The time management of the form was modified |
404 | The form with given ID does not exist |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | FormResponse (JSON) | response containing the form |
DELETE /form/{id}/offline/at Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"item" : { },
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Render a preview of the form in the given language
name | type | description |
---|---|---|
id | path | form ID |
language | path | language code |
code | condition |
---|---|
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
text/html | (custom) | rendered preview |
GET /form/{id}/preview/{language} Accept: text/html
HTTP/1.1 200 OK
Content-Type: text/html
...
Render a preview of the form in the given language
name | type | description |
---|---|---|
id | path | form ID |
language | path | language code |
media type | data type | description |
---|---|---|
application/json | FormModel (JSON) | form model |
code | condition |
---|---|
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
text/html | (custom) | rendered preview |
POST /form/{id}/preview/{language}
Content-Type: application/json
Accept: text/html
{
"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" : "page",
"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" : "..."
}
}
}
HTTP/1.1 201 Created
Content-Type: text/html
...
Remove the time for scheduled publishing
name | type | description |
---|---|---|
id | path | form ID |
code | condition |
---|---|
200 | The time management of the form was modified |
404 | The form with given ID does not exist |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | FormResponse (JSON) | response containing the form |
DELETE /form/{id}/publish/at Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"item" : { },
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Load a version of a form
name | type | description |
---|---|---|
id | path | form ID |
version | path | version number |
code | condition |
---|---|
200 | The version is returned |
404 | The form with given ID or the version does not exist |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | FormResponse (JSON) | response containing the version number |
GET /form/{id}/version/{version} Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"item" : { },
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Restore a version of the form
name | type | description |
---|---|---|
id | path | form ID |
version | path | version number |
code | condition |
---|---|
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | FormResponse (JSON) | response containing the restored form |
POST /form/{id}/version/{version}/restore Accept: application/json
HTTP/1.1 201 Created
Content-Type: application/json
{
"item" : { },
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Download the binary data for a single field in a data entry
name | type | description |
---|---|---|
dataId | path | data ID (uuid of the data node in Mesh) |
field | path | field name |
id | path | form ID |
code | condition |
---|---|
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | object (JSON) | response |
GET /form/{id}/data/{dataId}/binary/{field} Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
...