Virtual Corpus KoralQuery

** WARNING: This service is experimental and may change without any notice.

retrieve the KoralQuery of a virtual corpus with name vc_name created by the given vc_creator. This service requires an OAuth2 access token with scope vc_info.

Available in: full version

Method: GET

Service URL: root/vc/koralQuery/~{vc_creator}/{vc_name}

Parameters

Header Parameter

Name	Required	Authentication scheme	Value
Authorization	yes	HTTP authentication with scheme: Bearer	OAuth2 access token

Path Parameter

Name	Required	Description
vc_creator	yes	username of the vc creator
vc_name	yes	a virtual corpus name

Response Codes

HTTP Status Code	Description
200 OK	successful request
400 Bad Request	when fieldName is null
401 Unauthorized	when the operation is not permitted, e.g. user is not a system-admin.
415 Unsupported Media Type	when content-type is not specified or incorrect

Examples

Request with Basic authentication (for testing only)

curl -H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' 
      http://localhost:8089/api/v1.0/vc/koralQuery/~system/system-vc

Response

{
  "collection": {
    "operands": [
      {
        "@type": "koral:doc",
        "match": "match:eq",
        "value": "GOE",
        "key": "corpusSigle"
      },
      {
        "@type": "koral:doc",
        "match": "match:geq",
        "type": "type:date",
        "value": "1820",
        "key": "creationDate"
      }
    ],
    "@type": "koral:docGroup",
    "operation": "operation:and"
  }
}