This describes the resources that make up the Lizard API v1.
GET /api/v1/portals
Response
Status: 200 OK
{
data: [
{
"id" : "{portal id}",
"name": "{portal name}",
"description": "{portal description}",
"url": "/api/v1/portals/{portal id}"
}
]
count: 1
}
GET /api/v1/portals/:portalid
Response
Status: 200 OK
{
data: {
"id": "{portal id}"
"name": "{portal name}"
"description": "{portal description}",
"icon": "/api/v1/icons/4"
"appScreenUrl": "/api/v1/portals/{portalid}/appScreen/"
"links": [
{
"name": "{link name}",
"url": "{link url}"
},
],
}
}
GET /api/v1/portals/:portalid/appscreens/
Response
Status: 200 OK
{
"data": [
{
"id": "{app id}",
"name": "{app name}",
"description": "{app description}",
"url": "/api/v1/portal/{app id}",
"icon": "/api/v1/icon/{icon id}",
"actionType": "lizard.app.xxxxx"
},
{
"id": "{app id2}",
"name": "{app name2}",
"description": "{app description}",
"url": "/api/v1/portal/{app id2}",
"icon": "/api/v1/icon/{icon id}",
"actionType": "linkTo"
}
],
"count": 2
}
GET /api/v1/portals/:portalid/appscreens/:appscreenid
Response
Status: 200 OK
{
"data": {
"id": "{app id}",
"name": "{app name}",
"description": "{app description}",
"url": "/api/v1/portal/{app id}",
"icon": "/api/v1/icon/{icon id}",
"actionType": "lizard.app.xxxxx"
}
}
Note
This seems to be the same as the Application Screen.
GET /api/v1/apps
Response
Status: 200 OK
{
"data": [
{
"id": "{app id}",
"name": "{app name}",
"description": "{app description}",
"url": "/api/v1/apps/{app id}",
"icon": "/api/v1/icons/{icon id}",
"actionType": "{lizard.app.xxxxx}",
},
],
"count": 1
}