MixDEM API Reference
Request URL
- We assume that the complete API URL is
http://api.domaine.com/index.php
- The MixDEM web service use only URL parameters (GET and/or POST
data) for requesting and sending data.
- MixDEM web services typically use 3 parameters category : &render,
&do and the needed arguments for method to call :
- render is the response type.
- do is the method to execute by the web service, ex:
do=User.connect,
do=project.save, ...
- needed arguments for do methods is something like
do=methodToCall&arg1=value1&arg=value1&arg2=value2
-
There is many format supported by the MixDEM API :
- XML
- JSON
- DUMP (php:print_r)
- SERIALIZED (php:serialize)
- LIST
- TREE
- CSV
- DEFAULT
This will depend on the component node type. ex an XML_READER will return an XML document by default
and an CSV_READER will return an CSV document by default, ..
Note : If no render format has been specified
or not supported yet, the Web API will return HTTP/1.0
400 Bad Request.
Function description
User.connect
To connect user to the web api service :
GET /?&render=${RESPONSE_FORMAT}&do=User.connect&user=${LOGIN}&password=${PASSWORD}
| Request parameters |
Value |
Description |
render |
string (required) |
response format. |
do |
string (required) |
action to execute by the web service. |
user |
string (required) |
User login. |
password |
string (required) |
User passwod. |
ts |
integer (optional) |
The current time stamp. |
utf8 |
string (optional) |
utf parameter can be :
- encode to encode the API response to utf-8
- decode to decode the API response from utf-8.
|
User.disconnect
To disconnect user from the web api service :
GET /?&render=${RESPONSE_FORMAT}&do=User.connect&user=${LOGIN}
| Request parameters |
Value |
Description |
render |
string (required) |
response format. |
do |
string (required) |
action to execute by the web service. |
user |
string (required) |
User login. |
ts |
integer (optional) |
The current time stamp. |
utf8 |
string (optional) |
utf parameter can be :
- encode to encode the API response to utf-8
- decode to decode the API response from utf-8.
|
User.keepAlive
To keep-alive the tracker of this user session :
GET /?&render=${RESPONSE_FORMAT}&do=User.keepAlive
| Request parameters |
Value |
Description |
render |
string (required) |
response format. |
do |
string (required) |
action to execute by the web service. |
ts |
integer (optional) |
The current time stamp. |
utf8 |
string (optional) |
utf parameter can be :
- encode to encode the API response to utf-8
- decode to decode the API response from utf-8.
|
Project.list
Project.list, will return list of projects avaible on da server
GET /?&render=${RESPONSE_FORMAT}&do=Project.list
| Request parameters |
Value |
Description |
render |
string (required) |
response format. |
do |
string (required) |
action to execute by the web service. |
Project.open
Project.open, will return da xml content of da given project name if exist on the server
GET /?&render=${RESPONSE_FORMAT}&do=Project.open&name=${PROJECT_NAME}
| Request parameters |
Value |
Description |
render |
string (required) |
response format. |
do |
string (required) |
action to execute by the web service. |
Project.save
To save an existing project :
POST
/?&render=${RESPONSE_FORMAT}&do=Project.save&name=${PROJECT_NAME}
code=${PROJECT_CODE_XML}
| Request parameters |
Value |
Methode |
Description |
render |
string (required) |
GET |
response format. |
do |
string (required) |
GET |
action to execute by the web service. |
name |
string (required) |
GET |
project name to delete. |
code |
string (required) |
POST |
project code source XML. |
ts |
integer (optional) |
GET |
The current time stamp. |
utf8 |
string (optional) |
GET |
utf parameter can be :
- encode to encode the API response to utf-8
- decode to decode the API response from utf-8.
|
Project.test
To test an existing project :
GET /?&render=${RESPONSE_FORMAT}&do=Project.test&name=${PROJECT_NAME}
| Request parameters |
Value |
Description |
render |
string (required) |
response format. |
do |
string (required) |
action to execute by the web service. |
name |
string (required) |
project name to delete. |
ts |
integer (optional) |
The current time stamp. |
utf8 |
string (optional) |
utf parameter can be :
- encode to encode the API response to utf-8
- decode to decode the API response from utf-8.
|
Project.Node.list
will return defined nodes of da given project name if exist on the server
GET /?&render=${RESPONSE_FORMAT}&do=Project.Node.list&name=${PROJECT_NAME}
| Request parameters |
Value |
Description |
render |
string (required) |
response format. |
do |
string (required) |
action to execute by the web service. |
name |
string (required) |
project name. |
Project.run
To run an existing project :
GET /?&render=${RESPONSE_FORMAT}&do=Project.run&name=${PROJECT_NAME}&node=${NODE_NAME}
&offset=${LIMIT_RESULT_OFFSET}&rows=${LIMIT_RESULT_MAX_ROWS}&logid=${UNIQUE_ID_FOR_LOG}
| Request parameters |
Value |
Description |
render |
string (required) |
response format. |
do |
string (required) |
action to execute by the web service. |
name |
string (required) |
project name to run. |
node |
string (optional) |
node name to run. |
logid |
string (optional) |
an id, to be used by MixDEM ETL Engine to save the log of the execution |
offset |
integer (optional) |
set result offset. |
rows |
integer (optional) |
limit result max rows. |
ts |
integer (optional) |
The current time stamp. |
utf8 |
string (optional) |
utf parameter can be :
- encode to encode the API response to utf-8
- decode to decode the API response from utf-8.
|
Project.delete
To delete an existing project :
GET /?&render=${RESPONSE_FORMAT}&do=Project.delete&name=${PROJECT_NAME}
| Request parameters |
Value |
Description |
render |
string (required) |
response format. |
do |
string (required) |
action to execute by the web service. |
name |
string (required) |
project name to delete. |
ts |
integer (optional) |
The current time stamp. |
utf8 |
string (optional) |
utf parameter can be :
- encode to encode the API response to utf-8
- decode to decode the API response from utf-8.
|
Project.getExecLog
Open the Log of the last executed project done by Project.run:
GET /?&render=${RESPONSE_FORMAT}&do=Project.getExecLog&logid=${UNIQUE_ID_FOR_LOG}
| Request parameters |
Value |
Description |
render |
string (required) |
response format. |
logid |
string (required) |
id of log. it must be the same used on Project.run |
ts |
integer (optional) |
The current time stamp. |
utf8 |
string (optional) |
utf parameter can be :
- encode to encode the API response to utf-8
- decode to decode the API response from utf-8.
|