Skip to content

Service: Virtual Corpus Sharing

Eliza Margaretha Illig edited this page Oct 25, 2024 · 17 revisions

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

allows users to share their virtual corpora (VC) with a group of users. This service is only available for group admins and requires authorization scope share_vc.

Available in: full version

Method: POST

Service URL: root/vc/~{vc_creator}/{vc_name}/share/@{group_name}

Parameters

Header Parameters

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

Path Parameters

Name Required Description Type
vc_creator yes the username of the virtual corpus creator String
vc_name yes virtual corpus name String
group_name yes user-group name String

Examples

Sharing marlin-vc to marlin-group

Request with cURL

curl --request POST 
     -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE' 
     http://localhost:8089/api/v1.0/vc/~marlin/marlin-vc/share/@marlin-group

Request with Basic authentication (for testing only)

curl --request POST 
     -H 'Authorization: Basic bWFybGluOnBhc3N3b3Jk' 
     http://localhost:8089/api/v1.0/vc/~marlin/marlin-vc/share/@marlin-group

Response

HTTP Status Code Description
200 OK successful request
400 Bad Request when fieldName is null
415 Unsupported Media Type when the request method (e.g. GET) is incorrect.
401 Unauthorized when the operation is not permitted, e.g. user doesn't log in.

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