/report/image
Methods
GET
Gets the list of Report Images
Fields Parameter
Expand
The fields parameter should be specified along the query string, and it takes the syntax
?fields=<field>,...
Allowed Fields
*id
**name
**description
creator
type
filename
originalFilename
createdTime
modifiedTime
image
Legend
* = always comes back
** = comes back if fields list not specified on GET all
Request Query Parameters
None
Example Response
Expand
{
"type" : "regular",
"response" : [
{
"id" : "1",
"name" : "Fake",
"description" : "faked from SQLite Manager"
}
],
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1418679112
}
POST
Adds an Report Image.
Request Parameters
Expand
NOTE: The 'image' field is for GET only. It cannot be added or modified directly
{
"name" : <string>,
"description" : <string> DEFAULT "",
"type" : <string> "Logo" | "Watermark",
"filename" : <string>,
"originalFilename" : <string> DEFAULT (filename)
}
Example Response
Expand
{
"type" : "regular",
"response" : {
"id" : "3",
"name" : "reportImage",
"description" : "Example for Documentation",
"type" : "Logo",
"filename" : "scfile_jtiiVb",
"originalFilename" : "fake.png",
"createdTime" : "1418746737",
"modifiedTime" : "1418746737",
"image" : "iVBORw0KGgoAAAANSUhEUgAAAbQAAAEECAIAAADPnFZkAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAAT8SURBVHhe7dndbeM4GEDRqSsFTT2pZppJMVls1rJl6+rHhjErgOe8RSI\/6umCRn59A7AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgCBHEECOIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgCBHEECOIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgCBHEECOIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgCBHEECOIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgO6evz49em338uK5f+\/L6s2Vz1r2nlx+fX5cnc9Rvmr3c\/bGUYvJ04DmkWuLaevbut23XciuNtzN2M3Q8TR\/4WcRzSVra2PdRrs46rp9zuh4+vXv8weDNxHNLLDbps\/Pj8PDBh5ZRbGpdpFUdOQxyH9GqDrm38OjIil0wPe+OrHwZvJ45DerFBl23\/7dqfsVyxdWn8IY6chjgO6aUGTWWbNu0OeVww\/b1xrDhyGuI4pFca9NjG\/Sl373cvjT\/EkdMQxyG90KApbvO0TWNWejc75ZrGnRPFkdMQxyE936Bq4+w6mHW8tvNq69L4Y7nlzu5+eBtxHNJOg5bN7Dbu1PGa4I\/Lov26iSOnIY5DejaO0\/plnLbqeI3j7Gf1Tt9mWy5P4H8ijkN6skHrbdys490ptzxuHSqOnIY4Dum5Bk2rdyzq+HjKbc7q9VEcOQ1xHNJTDTrYxuW05Sm7eRRHTkMch\/RMg6a1q7e91XH1eOfXtThyGuI4pCcadKCNa\/P66WYexZHTEMchHW7Qxr9b7uTAtVNueVyMFUdOQxyHdLRBR9vYEzdOmV49ThZHTkMch3SwQcfbOLsN3tZunnLLY\/V0w\/63wDuI45COxfGJNs4W32bunFI9vT1bJY78HeIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgCBHEECOIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgCBHEECOIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgCBHEECOIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgCBHEECOIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgCBHEECOIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4CF7+9\/AL01WNsOCEiAAAAAAElFTkSuQmCC",
"creator" : {
"id" : "1",
"username" : "head",
"firstname" : "Security Manager",
"lastname" : "",
"uuid": "2E2B70F2-3471-428F-82AF-A6905090EAA9"
}
},
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1418746737
}
/report/image/{id}
Methods
GET
Gets the Report Image associated with {id}.
Fields Parameter
Expand
The fields parameter should be specified along the query string, and it takes the syntax
?fields=<field>,...
Allowed Fields
*id
**name
**description
creator
type
filename
originalFilename
createdTime
modifiedTime
image
Legend
* = always comes back
** = comes back if fields list not specified on GET all
Request Query Parameters
None
Example Response
Expand
{
"type" : "regular",
"response" : {
"id" : "1",
"name" : "Fake",
"description" : "faked from SQLite Manager",
"type" : "watermark",
"filename" : "fake.png",
"originalFilename" : "fake",
"createdTime" : "1",
"modifiedTime" : "1",
"image" : "iVBORw0KGgoAAAANSUhEUgAAAbQAAAEECAIAAADPnFZkAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAAEnQAABJ0Ad5mH3gAAAT8SURBVHhe7dndbeM4GEDRqSsFTT2pZppJMVls1rJl6+rHhjErgOe8RSI\/6umCRn59A7AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgCBHEECOIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgCBHEECOIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgCBHEECOIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgCBHEECOIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgO6evz49em338uK5f+\/L6s2Vz1r2nlx+fX5cnc9Rvmr3c\/bGUYvJ04DmkWuLaevbut23XciuNtzN2M3Q8TR\/4WcRzSVra2PdRrs46rp9zuh4+vXv8weDNxHNLLDbps\/Pj8PDBh5ZRbGpdpFUdOQxyH9GqDrm38OjIil0wPe+OrHwZvJ45DerFBl23\/7dqfsVyxdWn8IY6chjgO6aUGTWWbNu0OeVww\/b1xrDhyGuI4pFca9NjG\/Sl373cvjT\/EkdMQxyG90KApbvO0TWNWejc75ZrGnRPFkdMQxyE936Bq4+w6mHW8tvNq69L4Y7nlzu5+eBtxHNJOg5bN7Dbu1PGa4I\/Lov26iSOnIY5DejaO0\/plnLbqeI3j7Gf1Tt9mWy5P4H8ijkN6skHrbdys490ptzxuHSqOnIY4Dum5Bk2rdyzq+HjKbc7q9VEcOQ1xHNJTDTrYxuW05Sm7eRRHTkMch\/RMg6a1q7e91XH1eOfXtThyGuI4pCcadKCNa\/P66WYexZHTEMchHW7Qxr9b7uTAtVNueVyMFUdOQxyHdLRBR9vYEzdOmV49ThZHTkMch3SwQcfbOLsN3tZunnLLY\/V0w\/63wDuI45COxfGJNs4W32bunFI9vT1bJY78HeIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgCBHEECOIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgCBHEECOIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgCBHEECOIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgCBHEECOIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4AgjgBBHAGCOAIEcQQI4ggQxBEgiCNAEEeAII4AQRwBgjgCBHEECOIIEMQRIIgjQBBHgCCOAEEcAYI4AgRxBAjiCBDEESCII0AQR4CF7+9\/AL01WNsOCEiAAAAAAElFTkSuQmCC",
"creator" : {
"id" : "1",
"username" : "head",
"firstname" : "Security Manager",
"lastname" : "",
"uuid": "2E2B70F2-3471-428F-82AF-A6905090EAA9"
}
},
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1418679161
}
PATCH
Edits the Report Image associated with {id}, changing only the passed in fields.
Request Parameters
(All fields are optional)
See /report/image::POST for parameters.
Example Response
See /report/image/{id}::GETDELETE
Deletes the Report Image associated with {id}, depending on access and permissions.
Request Parameters
None
Example Response
Expand
{
"type" : "regular",
"response" : "",
"error_code" : 0,
"error_msg" : "",
"warnings" : [],
"timestamp" : 1418744408
}