Service: Virtual Corpus Retrieval

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

returns a virtual corpus with name vc_name and 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/~{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

Examples

Request with Basic authentication (for testing only)

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

Response

   {
        "id": 3,
        "name": "system-vc",
        "type": "system",
        "status": "experimental",
        "description": "test vc",
        "requiredAccess": "ALL",
        "createdBy": "system",
        "numberOfDoc": 11,
        "numberOfParagraphs": 772,
        "numberOfSentences": 25074,
        "numberOfTokens": 665842        
    }