Skip to content

Service: Owner Virtual Corpus List

Eliza Margaretha edited this page Apr 3, 2023 · 16 revisions

** WARNING: This service is deprecated and only supported for a short time. Please use Virtual Corpus List service instead.

Lists all virtual corpora created by a user.

Available in: full version

Method: GET

Service URL: root/vc/~{vc_creator}

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 the username of the VC creator, must be the same as the authenticated user

Examples

Request with cURL

curl -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1MTM1MzI3O
       TAxMzQsInN1YiI6InVzZXJuYW1lIiwiaXNzIjoiaHR0cDpcL1wva29yYXAuaWRzLW1
       hbm5oZWltLmRlIn0.p4jHIGeVwTpYAPFiWAd0R8Zcazyg7e9_tUGxOyFGUlo' 
      http://localhost:8089/api/v1.0/vc/~dory

Request with Basic authentication (for testing only)

List all virtual corpora created by dory

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

Response

[
    {
        "id": 1,
        "name": "dory-vc",
        "type": "private",
        "status": "experimental",
        "description": "test vc",
        "requiredAccess": "FREE",
        "createdBy": "dory",
        "numberOfDoc": 5,
        "numberOfParagraphs": 124,
        "numberOfSentences": 3835,
        "numberOfTokens": 108557,
        "koralQuery": "{"collection": { "@type": "koral:docGroup", 
          "operands": [ { "@type": "koral:doc", "key": "corpusSigle", 
          "match": "match:eq", "value": "GOE" }, { "@type": 
          "koral:doc", "key": "creationDate", "match": "match:geq", 
          "type": "type:date", "value": "1820" } ], "operation": 
          "operation:and" }}"
    },  
    {
        "id": 2,
        "name": "group-vc",
        "type": "project",
        "status": "experimental",
        "description": "test vc",
        "requiredAccess": "PUB",
        "createdBy": "dory",
        "numberOfDoc": 4,
        "numberOfParagraphs": 283,
        "numberOfSentences": 14027,
        "numberOfTokens": 386440,
        "koralQuery": "{"collection": { "@type": "koral:docGroup", 
          "operands": [ { "@type": "koral:doc", "key": "corpusSigle", 
          "match": "match:eq", "value": "GOE" }, { "@type": 
          "koral:doc", "key": "creationDate", "match": "match:leq", 
          "type": "type:date", "value": "1810" } ], "operation": 
          "operation:and" }}"
    }
]

Advanced Setting

Developer Setting

Search services

Metadata services

Authentication and Authorization services

Client services

Super client services

Plugin services

User services

User group services

Virtual corpus (VC) services

VC sharing services

Administrative services

Description services

Clone this wiki locally