REST provenance api search options

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

REST provenance api search options

philippe.gibert

Hello, 

My SW context : nifi 1.0.0/ubuntu

 I am trying to use the provenance search options . I have the Id of my processor ie (ProcessorID ) but it’s not very clear for me how to fill the searchableFields. 

Is something  as the following to be right  ? and in this case where do i put the ProcessorID? in the field or  in the Id ? and what for label?

-----------------------------------------------

curl -i -X PUT -H 'Content-Type: application/json' -d '{"searchableFields":[{"id":"ProcessorID","field":"processorId","label":"Component ID","type":"STRING"}]}

' http://localhost:8080/nifi-api/provenance/search-options

--------------------------------------------------

​ please can you clarify ? with an example ?

Best regards 

phil

 

 

Description : Description : Description : cid:image002.gif@01CDFAED.D49218F0

Philippe Gibert

Ingénieur R&D

FT/IMT/OLPS/BIZZ/INFSVC/ITS4B

tél. +33 4 92 94 53 70

mob. +33 6 73 41 11 18

[hidden email]

 

 

_________________________________________________________________________________________________________________________

Ce message et ses pieces jointes peuvent contenir des informations confidentielles ou privilegiees et ne doivent donc
pas etre diffuses, exploites ou copies sans autorisation. Si vous avez recu ce message par erreur, veuillez le signaler
a l'expediteur et le detruire ainsi que les pieces jointes. Les messages electroniques etant susceptibles d'alteration,
Orange decline toute responsabilite si ce message a ete altere, deforme ou falsifie. Merci.

This message and its attachments may contain confidential or privileged information that may be protected by law;
they should not be distributed, used or copied without authorisation.
If you have received this email in error, please notify the sender and delete this message and its attachments.
As emails may be altered, Orange is not liable for messages that have been modified, changed or falsified.
Thank you.
Reply | Threaded
Open this post in threaded view
|

Re: REST provenance api search options

Matt Gilman
Philippe,

Here's an example command for initiating a provenance search:

curl 'http://localhost:8080/nifi-api/provenance' -H 'Content-Type: application/json' -H 'Accept: application/json, text/javascript, */*; q=0.01' --data-binary '{"provenance":{"request":{"maxResults":1000,"startDate":"11/15/2016 00:00:00 EST","endDate":"11/15/2016 23:59:59 EST","searchTerms":{"FlowFileUUID":"<flowfile-uuid>","Filename":"<name of flowfile>","ProcessorID":"<component-uuid>"}}}}' --compressed

The available searchable fields are defined in your nifi.properties file under the following properties:

nifi.provenance.repository.indexed.fields
nifi.provenance.repository.indexed.attributes

Because the searches can be long running they are performed asynchronously. These means that the curl command above creates the search request but does not wait for it to complete. Instead, you'll need to get the uuid to the search request to continue to GET it until the search completes. Once completed, you should DELETE the search request. Open up the Dev Tools in your browser to seen this sequence of requests in action.

Let me know if you have any more questions. Thanks.

Matt


On Tue, Nov 15, 2016 at 2:47 AM, <[hidden email]> wrote:

Hello, 

My SW context : nifi 1.0.0/ubuntu

 I am trying to use the provenance search options . I have the Id of my processor ie (ProcessorID ) but it’s not very clear for me how to fill the searchableFields. 

Is something  as the following to be right  ? and in this case where do i put the ProcessorID? in the field or  in the Id ? and what for label?

-----------------------------------------------

curl -i -X PUT -H 'Content-Type: application/json' -d '{"searchableFields":[{"id":"ProcessorID","field":"processorId","label":"Component ID","type":"STRING"}]}

' http://localhost:8080/nifi-api/provenance/search-options

--------------------------------------------------

​ please can you clarify ? with an example ?

Best regards 

phil

 

 

Description : Description : Description : cid:image002.gif@01CDFAED.D49218F0

Philippe Gibert

Ingénieur R&D

FT/IMT/OLPS/BIZZ/INFSVC/ITS4B

tél. <a href="tel:%2B33%204%2092%2094%2053%2070" value="+33492945370" target="_blank">+33 4 92 94 53 70

mob. <a href="tel:%2B33%206%2073%2041%2011%2018" value="+33673411118" target="_blank">+33 6 73 41 11 18

[hidden email]

 

 

_________________________________________________________________________________________________________________________

Ce message et ses pieces jointes peuvent contenir des informations confidentielles ou privilegiees et ne doivent donc
pas etre diffuses, exploites ou copies sans autorisation. Si vous avez recu ce message par erreur, veuillez le signaler
a l'expediteur et le detruire ainsi que les pieces jointes. Les messages electroniques etant susceptibles d'alteration,
Orange decline toute responsabilite si ce message a ete altere, deforme ou falsifie. Merci.

This message and its attachments may contain confidential or privileged information that may be protected by law;
they should not be distributed, used or copied without authorisation.
If you have received this email in error, please notify the sender and delete this message and its attachments.
As emails may be altered, Orange is not liable for messages that have been modified, changed or falsified.
Thank you.

Reply | Threaded
Open this post in threaded view
|

RE: REST provenance api search options

philippe.gibert

Thanks a lot Matt

It works nicely !

 

From: Matt Gilman [mailto:[hidden email]]
Sent: mardi 15 novembre 2016 15:08
To: [hidden email]
Subject: Re: REST provenance api search options

 

Philippe,

 

Here's an example command for initiating a provenance search:

 

curl 'http://localhost:8080/nifi-api/provenance' -H 'Content-Type: application/json' -H 'Accept: application/json, text/javascript, */*; q=0.01' --data-binary '{"provenance":{"request":{"maxResults":1000,"startDate":"11/15/2016 00:00:00 EST","endDate":"11/15/2016 23:59:59 EST","searchTerms":{"FlowFileUUID":"<flowfile-uuid>","Filename":"<name of flowfile>","ProcessorID":"<component-uuid>"}}}}' --compressed

 

The available searchable fields are defined in your nifi.properties file under the following properties:

 

nifi.provenance.repository.indexed.fields

nifi.provenance.repository.indexed.attributes

 

Because the searches can be long running they are performed asynchronously. These means that the curl command above creates the search request but does not wait for it to complete. Instead, you'll need to get the uuid to the search request to continue to GET it until the search completes. Once completed, you should DELETE the search request. Open up the Dev Tools in your browser to seen this sequence of requests in action.

 

Let me know if you have any more questions. Thanks.

 

Matt

 

 

On Tue, Nov 15, 2016 at 2:47 AM, <[hidden email]> wrote:

Hello, 

My SW context : nifi 1.0.0/ubuntu

 I am trying to use the provenance search options . I have the Id of my processor ie (ProcessorID ) but it’s not very clear for me how to fill the searchableFields. 

Is something  as the following to be right  ? and in this case where do i put the ProcessorID? in the field or  in the Id ? and what for label?

-----------------------------------------------

curl -i -X PUT -H 'Content-Type: application/json' -d '{"searchableFields":[{"id":"ProcessorID","field":"processorId","label":"Component ID","type":"STRING"}]}

' http://localhost:8080/nifi-api/provenance/search-options

--------------------------------------------------

​ please can you clarify ? with an example ?

Best regards 

phil

 

 

_________________________________________________________________________________________________________________________

Ce message et ses pieces jointes peuvent contenir des informations confidentielles ou privilegiees et ne doivent donc
pas etre diffuses, exploites ou copies sans autorisation. Si vous avez recu ce message par erreur, veuillez le signaler
a l'expediteur et le detruire ainsi que les pieces jointes. Les messages electroniques etant susceptibles d'alteration,
Orange decline toute responsabilite si ce message a ete altere, deforme ou falsifie. Merci.

This message and its attachments may contain confidential or privileged information that may be protected by law;
they should not be distributed, used or copied without authorisation.
If you have received this email in error, please notify the sender and delete this message and its attachments.
As emails may be altered, Orange is not liable for messages that have been modified, changed or falsified.
Thank you.