-
Notifications
You must be signed in to change notification settings - Fork 3
Field Value Retrieval
Eliza Margaretha edited this page May 20, 2022
·
2 revisions
Lists field values of a virtual corpus. This service is restricted for system admin use only.
Available in: full version
Method: GET
Service URL: root/vc/field/~{vc_creator}/{vc_name}
Header Parameter
Name | Required | Authentication scheme | Value |
---|---|---|---|
Authorization | yes | HTTP authentication with scheme: Bearer | OAuth2 access token |
Path Parameters
Name | Required | Description | Type | Example |
---|---|---|---|---|
vc_creator | yes | username of the vc creator, must be the same as the authenticated user or a system admin | String | system |
vc_name | yes | virtual corpus name consisting only of alphabets, underscores, dashes or fullstops | String | named-vc1 |
Query Parameters
Name | Required | Description | Type | Value |
---|---|---|---|---|
fieldName | yes | a field name | String | for example: textSigle |
Request with cURL
curl -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1MT' 'http://localhost:8089/api/v1.0/vc/field/~system/named-vc1?fieldName=textSigle'
Request with Basic authentication (for testing only)
curl -H 'Authorization: Basic YWRtaW46cGFzc3dvcmQ=' 'http://localhost:8089/api/v1.0/vc/field/~system/named-vc1?fieldName=textSigle'
Output example:
{
"@context": "http://korap.ids-mannheim.de/ns/KoralQuery/v0.3/context.jsonld",
"corpus": {
"@type": "koral:doc",
"key": "textSigle",
"type": "type:string",
"value": [
"GOE/AGA/01784",
"GOE/AGF/00000"
]
}
}
- OAuth2 client registration
- OAuth2 client info
- OAuth2 client deregistration
- OAuth2 client secret reset
- Plugin registration
- Plugin list (Marketplace)
- Plugin installation
- Plugin uninstallation
- Installed plugin list
- User group creation
- User group deletion
- User group list
- Member invitation
- Member deletion
- Approval of member invitation
- Rejection of member invitation
- Member role management
- Virtual corpus creation and update
- Virtual corpus deletion
- Virtual corpus list
- Virtual corpus retrieval
- Virtual corpus statistics
- Virtual corpus statistics with KoralQuery