You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@manifoldcf.apache.org by Karl Wright <da...@gmail.com> on 2013/02/23 18:45:36 UTC
[DISCUSS] API additions for reports
Hi Folks,
The ManifoldCF REST-style API has been missing support for reports.
I'm intending to add it for ManifoldCF 1.2 (see CONNECTORS-63). But
what stopped me in the past has been the query-like inputs for the
report.
Our current REST implementation is nice in that there are NO extra
inputs above and beyond what is provided in the URI path. For
instance:
/repositoryconnections - gets a list of connections
/repositoryconnections/myconnection - gets the connection "myconnection"
With reports, there is no longer a simple solution, however. There is
instead a number of query parameters, e.g. an activity list, or a
regexp on document identifiers. And yet the verb is still clearly
"GET".
So, my proposal to solve this problem is to use the URL's query
parameters as our query parameters. So, for instance:
GET /repositoryconnectionhistory/myconnection?report=simple&activity=fetch&activity=ingest
Comments? Objections?
Karl
Re: [DISCUSS] API additions for reports
Posted by Karl Wright <da...@gmail.com>.
I found a number of online resources that claimed query parameters
were typical for report execution in REST; that's what I based it on.
Karl
On Mon, Feb 25, 2013 at 5:37 AM, Piergiorgio Lucidi
<pi...@apache.org> wrote:
> I think that this could be a good starting point.
> I'm not an expert of the BI area but I'm wondering if exists a standard to
> execute queries for a report.
>
> Piergiorgio
>
>
> 2013/2/23 Karl Wright <da...@gmail.com>
>
>> Hi Folks,
>>
>> The ManifoldCF REST-style API has been missing support for reports.
>> I'm intending to add it for ManifoldCF 1.2 (see CONNECTORS-63). But
>> what stopped me in the past has been the query-like inputs for the
>> report.
>>
>> Our current REST implementation is nice in that there are NO extra
>> inputs above and beyond what is provided in the URI path. For
>> instance:
>>
>> /repositoryconnections - gets a list of connections
>> /repositoryconnections/myconnection - gets the connection "myconnection"
>>
>> With reports, there is no longer a simple solution, however. There is
>> instead a number of query parameters, e.g. an activity list, or a
>> regexp on document identifiers. And yet the verb is still clearly
>> "GET".
>>
>> So, my proposal to solve this problem is to use the URL's query
>> parameters as our query parameters. So, for instance:
>>
>> GET
>> /repositoryconnectionhistory/myconnection?report=simple&activity=fetch&activity=ingest
>>
>> Comments? Objections?
>>
>> Karl
>>
>
>
>
> --
> Piergiorgio Lucidi
> http://www.open4dev.com
Re: [DISCUSS] API additions for reports
Posted by Piergiorgio Lucidi <pi...@apache.org>.
I think that this could be a good starting point.
I'm not an expert of the BI area but I'm wondering if exists a standard to
execute queries for a report.
Piergiorgio
2013/2/23 Karl Wright <da...@gmail.com>
> Hi Folks,
>
> The ManifoldCF REST-style API has been missing support for reports.
> I'm intending to add it for ManifoldCF 1.2 (see CONNECTORS-63). But
> what stopped me in the past has been the query-like inputs for the
> report.
>
> Our current REST implementation is nice in that there are NO extra
> inputs above and beyond what is provided in the URI path. For
> instance:
>
> /repositoryconnections - gets a list of connections
> /repositoryconnections/myconnection - gets the connection "myconnection"
>
> With reports, there is no longer a simple solution, however. There is
> instead a number of query parameters, e.g. an activity list, or a
> regexp on document identifiers. And yet the verb is still clearly
> "GET".
>
> So, my proposal to solve this problem is to use the URL's query
> parameters as our query parameters. So, for instance:
>
> GET
> /repositoryconnectionhistory/myconnection?report=simple&activity=fetch&activity=ingest
>
> Comments? Objections?
>
> Karl
>
--
Piergiorgio Lucidi
http://www.open4dev.com