Verfügbare Methoden

Ihnen stehen für die nützlichsten EGOCMS Objekte unterschiedliche Methoden zur Verfügung, die Sie über die JSON/REST API ansprechen können. Hier finden Sie eine schematische Darstellung dieser Methoden. Angaben zu erwarteten/möglichen Parametern und Rückgabewerten der Methoden entnehmen Sie bitte der detaillierten Dokumentation für Entwickler oder dieser Hilfe.

Zu lesen sind die Definitionen wie folgt:

<Methode des angesteuerten Objekts> = "<Header, über die diese Methode nur aufgerufen werden darf>:<Abgefragte Berechtigung, kommasepariert>"
wb_incandescent

Da Sie sich über die JSON/REST API und dem API Token mit einem EGOCMS Benutzer anmelden, werden alle Methoden über diesen und seinen Berechtigungen ausgeführt.

Site

clearCache = "POST"
clearTrashcan = "POST"
getBlocks = "GET"
getCacheEntry = "GET"
getCacheLastChanged = "GET"
getErrorPage = "GET:view"
getLanguages = "GET"
getMediaSite = "GET"
getMediaUrl = "GET:view"
getPage = "GET:view"
getPages = "GET:view"
getPageUrl = "GET:view"
getRoot = "GET:view"
getSkins = "GET"
getUrl = "GET:view"
hasDeleted = "GET"
hasLiveserver = "GET"
hasMediaSite = "GET"
hasPermission = "GET"
hasRight = "GET"
hasRightsOnId = "GET"
isPermission = "GET"
setCacheEntry = "POST"
save = "PUT"
save_admin = "PUT"

Page

addChild = "PUT:edit,child"
addKeyword = "POST:edit"
addParent = "PUT:edit"
copyTo = "POST:edit,child"
createLanguagePage = "POST:edit"
delete = "DELETE:remove"
delParent = "PUT:edit"
destroy = "DELETE:remove"
getAncestors = "GET:view"
getChildren = "GET:view"
getDescendants = "GET:view"
getIdentity = "GET:view"
getIconUrl = "GET:view"
getKeywords = "GET:view"
getLanguagePage = "GET:view"
getParents = "GET:view"
getPath = "GET:view"
getRights = "GET:view"
getRightsArray = "GET:view"
getSiblings = "GET:view"
getSite = "GET"
getUrl = "GET:view"
getUser = "GET:view"
getUsersArray = "GET:view"
hasChildren = "GET:view"
hasFile = "GET:view"
hasMultiParents = "GET:view"
hasRights = "GET:view"
hasRightsOn = "GET:view"
isClone = "GET:view"
isLanguageLink = "GET:view"
isLocked = "GET:view"
isReleaseCopy = "GET:view"
isRoot = "GET:view"
isWorkflowCopy = "GET:view"
linkTo = "POST:edit,child"
lock = "PUT:edit"
merge = "PUT:edit"
move = "POST:edit,child"
newChild = "POST:child"
newFile = "POST:child"
newRelease = "POST:edit"
poolClear = "PUT:edit"
poolCopy = "POST:edit"
poolDelete = "DELETE:edit"
poolEdit = "PUT:edit"
poolExtract = "PUT:edit"
poolGet = "GET:view"
poolList = "GET:view"
poolMove = "POST:edit"
poolPut = "POST:edit"
poolRestore = "PUT:edit"
release = "PUT:edit"
restore = "PUT:edit"
setRightsArray = "PUT:edit,view_rights"
setUsersArray = "PUT:edit,view_rights"
unlock = "PUT:edit"
update = "PUT:edit"
updateChildren = "PUT:edit"
updateExtra = "PUT:edit"
updateField = "PUT:edit"
updateFile = "PUT:edit"
updateParents = "PUT:edit"
updateRights = "PUT:edit"
undelete = "PUT:remove"
unlinkFrom = "POST:edit,child"
validateFile = "POST:edit"

User_SQL

addFavorite = "PUT"
delete = "DELETE"
destroy = "DELETE"
getAllGroups = "GET"
getFullname = "GET"
getAllRoles = "GET"
getAllUsers = "GET"
getExtra = "GET"
getFavorites = "GET"
getGroupRoleRelations = "GET"
hasGroupRoleRelation = "GET"
isActive = "GET"
isInactive = "GET"
removeFavorite = "DELETE"
sendMail = "POST"
setExtra = "PUT"
undelete = "PUT"
update = "POST,PUT"

Group_SQL

addChild = "POST,PUT"
delete = "DELETE"
getAllUsers = "GET"
getChildren = "GET"
getParent = "GET"
getPath = "GET"
move = "PUT"
update = "POST,PUT"

Role_SQL

addChild = "POST,PUT"
delete = "DELETE"
getAllUsers = "GET"
getChildren = "GET"
getParent = "GET"
getPath = "GET"
move = "PUT"
update = "POST,PUT"