Revision as of 18:04, 15 September 2011 (view source) Nina (Talk | contribs) m (→Create a predefined query) ← Older edit		Latest revision as of 20:50, 21 January 2013 (view source) Smiller (Talk | contribs) (→Search)
(63 intermediate revisions by 4 users not shown)
Line 1:		Line 1:
		+	{{REST_resource}}
		+
	= Search =		= Search =
−	{{REST Operations	+	== Query language ==
−	|REST_op_description=Search in the default space	+
−	|REST_op_method=GET	+	Suggestion:
−	|REST_op_uri=/query	+
−	|REST_op_params=TBD, search parameters, page parameters	+	Queries will be passed as parameters to the search URI.  Valid query parameters are as follows:
−	|REST_header_param=subjectid:SECURITY-TOKEN	+
−	|REST_op_mime_input=application/x-www-form-urlencoded, RDF,  JSON	+	keyword=some_keyword
−	|REST_op_result=URIs of the results, or in other supported format	+	Search only keywords for given keyword
−	|REST_op_mime_output=text/uri-list, RDF, JSON	+	metadata=free_text
−	|REST_op_status=200,400,401,402,403	+	Search all metadata for given free text
−	}}	+	resourceType=protocol|data
		+	Limit search to either protocol or data.  All resource types are searched if omitted.
		+	timeModified=epoch-epoch
		+	Limit search to give time period.  Times must be represented as seconds since the epoch.
		+	timeModified=0 - all times equal to and after the value.
		+	timeModified=-11111111 - all times up to and including the value.
		+	timeMOdified=1234-11111111 - all times inclusive of value range.
		+
		+	== Search Ad Hoc Query ==
		+	{{HasOperation |id=Search:AdHocQuery}}
		+
		+	== Get Indexed Investigation ==
		+	{{HasOperation |id=Search:GetIndexedInvestigation}}
		+
		+	== Get Indexed Protocol ==
		+	{{HasOperation |id=Search:GetIndexedProtocol}}
−	= Search Protocols =	+	== Index Investigation ==
		+	{{HasOperation |id=Search:IndexInvestigation}}
−	{{REST Operations	+	== Index Protocol ==
−	|REST_op_description=Search protocols	+	{{HasOperation |id=Search:IndexProtocol}}
−	|REST_op_method=GET	+
−	|REST_op_uri=/query/protocols	+
−	|REST_op_params=TBD, search parameters, page parameters	+
−	|REST_header_param=subjectid:SECURITY-TOKEN	+
−	|REST_op_mime_input=application/x-www-form-urlencoded, RDF,  JSON	+
−	|REST_op_result=URIs of the protocols found, or in other supported format	+
−	|REST_op_mime_output=text/uri-list, RDF, JSON	+
−	|REST_op_status=200,400,401,402,403	+
−	}}	+
−	= Search Studies =	+	== Delete Indexed Investigation ==
		+	{{HasOperation |id=Search:DeleteIndexedInvestigation}}
−	{{REST Operations	+	== Delete Indexed Protocol ==
−	|REST_op_description=Search studies	+	{{HasOperation |id=Search:DeleteIndexedProtocol}}
−	|REST_op_method=GET	+
−	|REST_op_uri=/query/study	+
−	|REST_op_params=TBD, search parameters, page parameters	+
−	|REST_header_param=subjectid:SECURITY-TOKEN	+
−	|REST_op_mime_input=application/x-www-form-urlencoded, RDF,  JSON	+
−	|REST_op_result=URIs of the studies found, or in other supported format	+
−	|REST_op_mime_output=text/uri-list, RDF, JSON	+
−	|REST_op_status=200,400,401,402,403	+
−	}}	+
−	= Search Data=	+	== Administer Index Resources ==
		+	{{HasOperation |id=Search:AdministerIndexResources}}
−	{{REST Operations	+	== Keyword hierarchy ==
−	|REST_op_description=Search data	+
−	|REST_op_method=GET	+
−	|REST_op_uri=/query/data	+
−	|REST_op_params=TBD, search parameters, page parameters	+
−	|REST_header_param=subjectid:SECURITY-TOKEN	+
−	|REST_op_mime_input=application/x-www-form-urlencoded, RDF,  JSON	+
−	|REST_op_result=URIs of the datasets found, or in other supported format	+
−	|REST_op_mime_output=text/uri-list, RDF, JSON	+
−	|REST_op_status=200,400,401,402,403	+
−	}}	+
−	= Create a predefined query =	+	Web service access to ontologies
−	{{REST Operations	+	== Filtering the query ==
−	|REST_op_description=Create a predefined query	+	TBD
−	|REST_op_method=POST	+
−	|REST_op_uri=/query	+
−	|REST_op_params=TBD	+
−	|REST_header_param=subjectid:SECURITY-TOKEN	+
−	|REST_op_mime_input=application/x-www-form-urlencoded, RDF,  JSON	+
−	|REST_op_result=URI of the new query, e.g. /query/Q999	+
−	|REST_op_mime_output=text/uri-list	+
−	|REST_op_status=200,400,401,402,403	+
−	}}	+
	= Alerts =		= Alerts =
−	TBD	+	An [[API_Alert|Alert]] is defined by [[API_Query|Query]] URI ,frequency and an [[API_User|User]] to be notified.
−	Create a predefined query, assign frequency to send alerts (by email?)	+

---

Latest revision as of 20:50, 21 January 2013

Search

Contents 1 Search 1.1 Query language 1.2 Search Ad Hoc Query 1.3 Get Indexed Investigation 1.4 Get Indexed Protocol 1.5 Index Investigation 1.6 Index Protocol 1.7 Delete Indexed Investigation 1.8 Delete Indexed Protocol 1.9 Administer Index Resources 1.10 Keyword hierarchy 1.11 Filtering the query 2 Alerts

Search

Query language

Suggestion:

Queries will be passed as parameters to the search URI. Valid query parameters are as follows:

   keyword=some_keyword
       Search only keywords for given keyword
   metadata=free_text
       Search all metadata for given free text
   resourceType=protocol|data
       Limit search to either protocol or data.  All resource types are searched if omitted.
   timeModified=epoch-epoch
       Limit search to give time period.  Times must be represented as seconds since the epoch.
       timeModified=0 - all times equal to and after the value.
       timeModified=-11111111 - all times up to and including the value.
       timeMOdified=1234-11111111 - all times inclusive of value range.

Search Ad Hoc Query

Description	Search an ad hoc query
Resource	Search
Method	GET
URI	/search
Parameters	See query language
Header Parameters	subjectid:SECURITY-TOKEN
Media Type (input)
Results	URIs of the results
Media Type (output)	text/uri-list
Status code	200,400,401,402,403

Links: Page, Edit with form

Get Indexed Investigation

Description	Get uri of index investigation
Resource	Index
Method	GET
URI	/search/index/investigation
Parameters	resourceUri={resourceUri}
Header Parameters	subjectid:SECURITY-TOKEN
Media Type (input)
Results
Media Type (output)	uri of resource if it exists in index
Status code	200,400,401,402,403

Links: Page, Edit with form

Get Indexed Protocol

Description	Get uri of indexed protocol
Resource	Index
Method	GET
URI	/search/index/protocol
Parameters	resourceUri={resourceUri}
Header Parameters	subjectid:SECURITY-TOKEN
Media Type (input)
Results
Media Type (output)	uri of resource if it exists in index
Status code	200,400,401,402,403

Links: Page, Edit with form

Index Investigation

Description	Add investigation to query index
Resource	Index
Method	PUT
URI	/search/index/investigation
Parameters	resourceUri={resourceUri}
Header Parameters	subjectid:SECURITY-TOKEN
Media Type (input)	text/uri
Results
Media Type (output)
Status code	200,400,401,402,403

Links: Page, Edit with form

Index Protocol

Description	Add protocol to query index
Resource	Index
Method	PUT
URI	/search/index/protocol
Parameters	resourceUri={resourceUri}
Header Parameters	subjectid:SECURITY-TOKEN
Media Type (input)	text/uri
Results
Media Type (output)
Status code	200,400,401,402,403

Links: Page, Edit with form

Delete Indexed Investigation

Description	Delete an indexed investigation
Resource	Index
Method	DELETE
URI	/search/index/investigation
Parameters	resourceUri={resourceUri}
Header Parameters	subjectid:SECURITY-TOKEN
Media Type (input)
Results
Media Type (output)
Status code	200,400,401,402,403

Links: Page, Edit with form

Delete Indexed Protocol

Description	Delete an indexed protocol
Resource	Index
Method	DELETE
URI	/search/index/protocol
Parameters	resourceUri={resourceUri}
Header Parameters	subjectid:SECURITY-TOKEN
Media Type (input)
Results
Media Type (output)
Status code	200,400,401,402,403

Links: Page, Edit with form

Administer Index Resources

Description	Sync search index with actual data
Resource	Index
Method	POST
URI	/search/index
Parameters	admin=sync
Header Parameters	subjectid:SECURITY-TOKEN
Media Type (input)
Results
Media Type (output)
Status code	200,400,401,402,403

Links: Page, Edit with form

Keyword hierarchy

Web service access to ontologies

Filtering the query

TBD

Alerts

An Alert is defined by Query URI ,frequency and an User to be notified.