Reports
A report is a collection of data built via the ItemPath application. This collection of data is available through the API.
Attributes
-
id
integer
Unique identifier for the object.
-
name
string
A non-unique name given to the object.
-
type
string
Either Table, Timeline.
-
table
string
The base table of the report.
-
columns
string
The number of columns in the report.
Endpoints
List Reports
get /api/reportsGet the list of reports created from the ItemPath application, and return a response.
Arguments
- name string
- limit integer
- type string
- table string
Request with curl
curl "http://[Your IP]/api/reports" \
-X
get
\-H "Content-Type: application/json" \-H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{
"reports": [{
"id": "integer",
"name": "string",
"type": "string",
"table": "string",
"columns": "string",
}]
}]
}
Show Report
get /api/reports/[id]Get a specific report from ItemPath Connect and return a JSON response.
Arguments
Request with curl
curl "http://[Your IP]/api/reports/[id]" \
-X
get
\-H "Content-Type: application/json" \-H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{
"reports": [{
"id": "integer",
"name": "string",
"type": "string",
"table": "string",
"columns": "string",
}]
}]
}
Create Report
post /api/reportsCreate a Report.
Arguments
-
name
string
The name of the report.
- reportType
-
theme
string
The base table for the report.
Request with curl
curl "http://[Your IP]/api/reports" \
-X
post
\-H "Content-Type: application/json" \-H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{
"reports": [{
"id": "integer",
"name": "string",
"type": "string",
"table": "string",
"columns": "string",
}]
}]
}
Delete Report
get /api/reports/[id]/deleteDelete a specific report from ItemPath Connect and return a JSON response.
Request with curl
curl "http://[Your IP]
/api/reports/[id]/delete" \
-X
get
\-H "Content-Type: application/json" \-H "Authorization: Bearer [Your JWT Access Token]"
Example Response
{"deleted": "true"
}