-
Notifications
You must be signed in to change notification settings - Fork 19
Ximdex CMS API: NodeInfo
Javi Carretero edited this page Sep 6, 2013
·
5 revisions
This is simplest action you can perform into a node: retrieve information about it.
| Description | Get the information about a specific node |
|---|---|
| URL | /api/node |
| Parameters | ximtoken (required): session token obtained with the login action. |
| nodeid (required): the node ID we want to get the info. | |
| Response | JSON object containing the following information about the node: |
| nodeid: The ID of the node. | |
| nodeType: ID of the node's nodetype. | |
| name: The name of the node. | |
| version: The version of the node, containing information about its version, subversion, publish state, user id, username and date. | |
| creationDate: The creation date (timestamp). | |
| modificationDate: The modification date (timestamp). | |
| path: The Ximdex CMS's path of the node. | |
| parent: The ID of the parent node. | |
| children: object with the ID’s, names and nodetypes of the children if exist or null if it has no children. | |
| Example | |
| POST Request #1 | curl -X POST --data "ximtoken=XXABCDEFGHXX" http://example.org/ximdex/api/nodetype |
| GET Request #1 | curl -X GET "http://example.org/ximdex/api/nodetype?ximtoken=XXABCDEFGHXX" |
| Response #1 | {"error":0,"data":[{"idnodetype":"5001","name":"Root","description":"Root node of Ximdex","mimetype":"httpd\/unix-directory"},{"idnodetype":"5002","name":"ControlCenter","description":"Ximdex control center","mimetype":"httpd\/unix-directory"}, … ]} |