-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathnen-vocabulary-openapi3.yaml
1822 lines (1815 loc) · 51.1 KB
/
nen-vocabulary-openapi3.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
swagger: '2.0'
info:
title: NEN Vocabulary API
version: v1
description: >
The NEN Vocabulary REST API is a read-only interface to the data stored on the
vocabulary server. The URL namespace is the base URL of the Skosmos instance
followed by `/rest/v1/`.
Most methods return the data as UTF-8 encoded JSON-LD, served using the
`application/json` MIME type. The data consists of a single JSON object
which includes JSON-LD context information (in the `@context` field) and one
or more fields which contain the actual data. Some methods (`data`) return
other formats (RDF/XML, Turtle, RDF/JSON) with the appropriate MIME type.
The API supports Cross-Origin Resource Sharing by setting the
Access-Control-Allow-Origin HTTP header to `"*"` for all requests.
The API supports the JSONP convention of appending a callback parameter to
any URL. The returned data will then be wrapped in a JavaScript function
call using the function name provided as the callback parameter value. JSONP
wrapped data will be served using the `application/javascript` MIME type.
schemes:
- https
host: data.nen.nl
basePath: /skosmos/rest/v1
produces:
- application/rdf+xml
- text/turtle
- application/ld+json
- application/json
paths:
/vocabularies:
get:
summary: Available vocabularies
parameters:
- name: lang
in: query
description: language of labels, e.g. "en" or "fi"
required: true
type: string
produces:
- application/json
responses:
'200':
description: a list of vocabularies on the server
schema:
$ref: '#/definitions/VocabularyList'
tags:
- Global methods
/search:
get:
summary: Search concepts and collections by query term
parameters:
- name: query
in: query
description: the term to search for e.g. "cat*"
required: true
type: string
- name: lang
in: query
description: language of labels to match, e.g. "en" or "fi"
required: false
type: string
- name: labellang
in: query
description: language of labels to return, e.g. "en" or "fi"
required: false
type: string
- name: vocab
in: query
description: >-
vocabulary/vocabularies to limit search to, e.g. "yso" or "yso
allars"
required: false
type: string
- name: type
in: query
description: limit search to concepts of the given type(s), e.g. "skos:Concept".
required: false
type: string
- name: parent
in: query
description: >-
limit search to concepts which have the given concept (specified by
URI) as parent in their transitive broader hierarchy
required: false
type: string
- name: group
in: query
description: limit search to concepts in the given group (specified by URI)
required: false
type: string
- name: maxhits
in: query
description: >-
Maximum number of results to return. If not given, all results will
be returned.
required: false
type: integer
- name: offset
in: query
description: >-
offset where to start in the result set, useful for paging the
result. If not given, defaults to 0.
required: false
type: integer
- name: fields
in: query
description: >-
space-separated list of extra fields to include in the results. e.g.
"related" or "prefLabel" or any other skos property.
required: false
type: string
- name: unique
in: query
description: >-
boolean flag to indicate that each concept should be returned only
once, instead of returning all the different ways it could match
(for example both via prefLabel and altLabel).
required: false
type: string
produces:
- application/json
responses:
'200':
description: data of the concepts matching the search term
schema:
$ref: '#/definitions/SearchResults'
tags:
- Global methods
/label:
get:
summary: List of labels for the requested concept
parameters:
- name: uri
in: query
description: URI of the concept whose labels to return
required: true
type: string
- name: lang
in: query
description: search language, e.g. "en" or "fi"
required: false
type: string
produces:
- application/ld+json
responses:
'200':
description: labels for the requested concept
schema:
$ref: '#/definitions/LabelsAndUri'
'304':
description: >-
the resource was not modified, so there is no need to retransmit the
requested resources
'404':
description: no concept could be found with the requested URI
tags:
- Global methods
/data:
get:
summary: RDF data of the requested concept
parameters:
- name: uri
in: query
description: URI of the concept whose data to return
required: true
type: string
- name: format
in: query
description: >-
the MIME type of the serialization format, e.g. "text/turtle" or
"application/rdf+xml"
required: false
type: string
produces:
- application/rdf+xml
- text/turtle
- application/ld+json
- application/json
responses:
'200':
description: the data of the requested concept
'404':
description: the URI did not match any known concept
tags:
- Global methods
/types:
get:
summary: >-
Information about the types (classes) of objects contained in all
vocabularies
parameters:
- name: lang
in: query
description: language of labels, e.g. "en" or "fi"
required: true
type: string
produces:
- application/ld+json
responses:
'200':
description: the data of the requested concept
schema:
$ref: '#/definitions/TypeList'
tags:
- Global methods
/{vocid}/:
get:
summary: General information about the vocabulary
parameters:
- name: vocid
in: path
description: The Skosmos vocabulary id e.g. stw or yso
required: true
type: string
- name: lang
in: query
description: language of labels, e.g. "en" or "fi"
required: false
type: string
produces:
- application/ld+json
responses:
'200':
description: information about the requested vocabulary
schema:
$ref: '#/definitions/VocabularyInfo'
'304':
description: >-
the resource was not modified, so there is no need to retransmit the
requested resources
'404':
description: no vocabulary could be found with the requested id
tags:
- Vocabulary-specific methods
/{vocid}/types:
get:
summary: Information about the types (classes) of objects in the vocabulary
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: lang
in: query
description: language of labels, e.g. "en" or "fi"
required: false
type: string
produces:
- application/ld+json
responses:
'200':
description: type information about the requested vocabulary
schema:
$ref: '#/definitions/TypeList'
'304':
description: >-
the resource was not modified, so there is no need to retransmit the
requested resources
'404':
description: no vocabulary could be found with the requested id
tags:
- Vocabulary-specific methods
/{vocid}/topConcepts:
get:
summary: Top concepts of the vocabulary
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: lang
in: query
description: language of labels, e.g. "en" or "fi"
type: string
- name: scheme
in: query
description: >-
concept scheme whose top concepts to return. If not given, the
default concept scheme of the vocabulary will be used.
type: string
produces:
- application/ld+json
responses:
'200':
description: type information about the requested vocabulary
schema:
$ref: '#/definitions/TopConcepts'
'304':
description: >-
the resource was not modified, so there is no need to retransmit the
requested resources
'404':
description: no vocabulary could be found with the requested id
tags:
- Vocabulary-specific methods
/{vocid}/data:
get:
summary: >-
RDF data of the whole vocabulary or a specific concept. If the
vocabulary has support for it, MARCXML data is available for the whole
vocabulary in each language.
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: format
in: query
description: >-
The MIME type of the serialization format, e.g "text/turtle" or
"application/rdf+xml". If not specified, HTTP content negotiation
(based on the Accept header) is used to determine a suitable
serialization format from among the available ones.
required: false
type: string
- name: uri
in: query
description: >-
URI of the desired concept. When no uri parameter is given, the
whole vocabulary is returned instead.
required: false
type: string
- name: lang
in: query
description: >-
RDF language code when the requested resource for the MIME type is
language specific, e.g. "fi" or "en".
required: false
type: string
produces:
- application/rdf+xml
- text/turtle
- application/ld+json
- application/json
- application/marcxml+xml
responses:
'200':
description: >-
the RDF data of the requested vocabulary/concept, or MARCXML if the
vocabulary supports such
'304':
description: >-
the resource was not modified, so there is no need to retransmit the
requested resources
'404':
description: no vocabulary/concept could be found with the requested id/uri
tags:
- Vocabulary-specific methods
- Concept-specific methods
/{vocid}/search:
get:
summary: Finds concepts and collections from a vocabulary by query term
description: >-
Returns a list of search results. The search is performed as a
case-insensitive pattern, where an asterisk (*) may be used as wildcard.
E.g. "cat*" may return results such as "CATCH-22" and "categorization".
If decoded into RDF, the result is a vocabulary fragment expressed as
SKOS.
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: query
in: query
description: the term to search for e.g. "cat*"
required: true
type: string
- name: lang
in: query
description: language of labels to match, e.g. "en" or "fi"
required: false
type: string
- name: type
in: query
description: >-
limit search to concepts of the given type, e.g. "skos:Concept";
multiple types can be specified as a space-separated list
required: false
type: string
- name: parent
in: query
description: >-
limit search to concepts which have the given concept (specified by
URI) as parent in their transitive broader hierarchy
required: false
type: string
- name: group
in: query
description: limit search to concepts in the given group (specified by URI)
required: false
type: string
- name: maxhits
in: query
description: >-
Maximum number of results to return. If not given, all results will
be returned.
required: false
type: integer
- name: offset
in: query
description: >-
offset where to start in ther esult set, useful for paging the
result. If not given, defaults to 0.
required: false
type: integer
- name: fields
in: query
description: >-
space-separated list of extra fields to include in the results. e.g.
"related" or "prefLabel" or any other skos property.
required: false
type: string
- name: unique
in: query
description: >-
boolean flag to indicate that each concept should be returned only
once, instead of returning all the different ways it could match
(for example both via prefLabel and altLabel).
required: false
type: string
produces:
- application/json
responses:
'200':
description: data of the concepts matching the search term
schema:
$ref: '#/definitions/SearchResults'
tags:
- Vocabulary-specific methods
/{vocid}/lookup:
get:
summary: Look up concepts by label
description: >-
Returns the best matching concept(s) for the given label in JSON-LD
format. In case the label matches several concepts with the same
precedence, all of them are returned.
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: label
in: query
description: the label to look for, e.g. "cat" or "dog"
required: true
type: string
- name: lang
in: query
description: search language, e.g. "en" or "fi"
required: false
type: string
produces:
- application/ld+json
responses:
'200':
description: type information about the requested vocabulary
schema:
$ref: '#/definitions/LookupResults'
'404':
description: no concept could be found with the requested label
tags:
- Vocabulary-specific methods
/{vocid}/vocabularyStatistics:
get:
summary: Number of Concepts and Collections in the vocabulary
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: lang
in: query
description: language of labels, e.g. "en" or "fi"
required: false
type: string
produces:
- application/ld+json
responses:
'200':
description: the concept and group counts for the vocabulary
schema:
$ref: '#/definitions/VocabularyStatistics'
'304':
description: >-
the resource was not modified, so there is no need to retransmit the
requested resources
'404':
description: no vocabulary could be found with the requested id
tags:
- Vocabulary-specific methods
/{vocid}/labelStatistics:
get:
summary: Number of labels by language
description: >-
Returns a list of label (skos:prefLabel, skos:altLabel and
skos:hiddenLabel) counts in all the different languages.
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: lang
in: query
description: language of labels, e.g. "en" or "fi"
required: false
type: string
produces:
- application/ld+json
responses:
'200':
description: the concept and group counts for the vocabulary
schema:
$ref: '#/definitions/LabelStatistics'
'304':
description: >-
the resource was not modified, so there is no need to retransmit the
requested resources
'404':
description: no vocabulary could be found with the requested id
tags:
- Vocabulary-specific methods
/{vocid}/index/:
get:
summary: Initial letters of the alphabetical index
description: >-
Returns a list of the initial letters of labels (skos:prefLabel,
skos:altLabel) in the given language, or the default language of the
vocabulary. The special value "0-9" indicates the presence of labels
starting with a number and the value "!*" indicates labels starting with
a special character.
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: lang
in: query
description: language of labels, e.g. "en" or "fi"
required: false
type: string
produces:
- application/ld+json
responses:
'200':
description: initial letters of the alphabetical index
schema:
$ref: '#/definitions/IndexLetters'
'304':
description: >-
the resource was not modified, so there is no need to retransmit the
requested resources
'404':
description: no vocabulary could be found with the requested id
tags:
- Vocabulary-specific methods
/{vocid}/index/{letter}:
get:
summary: Concepts for a given letter in the alphabetical index
description: >-
Returns a list of the concepes which have a label (skos:prefLabel or
skos:altLabel) starting with the given letter in the given language, or
the default language of the vocabulary. The special value "0-9" matches
labels starting with a number and the value "!*" matches labels starting
with a special character.
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: letter
in: path
description: an initial letter, or one of the special values "0-9 or "!*"
required: true
type: string
- name: lang
in: query
description: language of labels, e.g. "en" or "fi"
required: false
type: string
produces:
- application/ld+json
responses:
'200':
description: concepts of the alphabetical index
schema:
$ref: '#/definitions/IndexConcepts'
'404':
description: no vocabulary could be found with the requested id
tags:
- Vocabulary-specific methods
/{vocid}/label:
get:
summary: List of labels for the requested concept
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: uri
in: query
description: URI of the concept whose labels to return
required: true
type: string
- name: lang
in: query
description: search language, e.g. "en" or "fi"
required: false
type: string
produces:
- application/ld+json
responses:
'200':
description: labels for the requested concept
schema:
$ref: '#/definitions/LabelsAndUri'
'304':
description: >-
the resource was not modified, so there is no need to retransmit the
requested resources
'404':
description: no concept could be found with the requested URI
tags:
- Concept-specific methods
/{vocid}/broader:
get:
summary: Broader concepts of the requested concept
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: uri
in: query
description: URI of the concept whose broader concept to return
required: true
type: string
- name: lang
in: query
description: label language, e.g. "en" or "fi"
required: false
type: string
produces:
- application/ld+json
responses:
'200':
description: >-
the broader concept(s) of the requested concept or an empty array if
there are none
schema:
$ref: '#/definitions/BroaderResult'
'304':
description: >-
the resource was not modified, so there is no need to retransmit the
requested resources
'404':
description: no concept could be found with the requested URI
tags:
- Concept-specific methods
/{vocid}/broaderTransitive:
get:
summary: Broader transitive hierarchy for the requested concept
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: uri
in: query
description: URI of the concept whose broader transitive hierarchy to return
required: true
type: string
- name: lang
in: query
description: label language, e.g. "en" or "fi"
required: false
type: string
produces:
- application/ld+json
responses:
'200':
description: >-
the broader transitive hierarchy for the requested concept or an
empty array if there concept does not have broaders
schema:
$ref: '#/definitions/BroaderTransitiveResult'
'304':
description: >-
the resource was not modified, so there is no need to retransmit the
requested resources
'404':
description: no concept could be found with the requested URI
tags:
- Concept-specific methods
/{vocid}/narrower:
get:
summary: Narrower concepts of the requested concept
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: uri
in: query
description: URI of the concept whose narrower concept to return
required: true
type: string
- name: lang
in: query
description: label language, e.g. "en" or "fi"
required: false
type: string
produces:
- application/ld+json
responses:
'200':
description: >-
the narrower concept(s) of the requested concept or an empty array
if there are none
schema:
$ref: '#/definitions/NarrowerResult'
'304':
description: >-
the resource was not modified, so there is no need to retransmit the
requested resources
'404':
description: no concept could be found with the requested URI
tags:
- Concept-specific methods
/{vocid}/narrowerTransitive:
get:
summary: Narrower transitive hierarchy for the requested concept
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: uri
in: query
description: URI of the concept whose narrower transitive hierarchy to return
required: true
type: string
- name: lang
in: query
description: label language, e.g. "en" or "fi"
required: false
type: string
produces:
- application/ld+json
responses:
'200':
description: >-
the narrower transitive hierarchy for the requested concept or an
empty array if there concept does not have narrowers
schema:
$ref: '#/definitions/NarrowerTransitiveResult'
'304':
description: >-
the resource was not modified, so there is no need to retransmit the
requested resources
'404':
description: no concept could be found with the requested URI
tags:
- Concept-specific methods
/{vocid}/related:
get:
summary: Related concepts of the requested concept
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: uri
in: query
description: URI of the concept whose related concept to return
required: true
type: string
- name: lang
in: query
description: label language, e.g. "en" or "fi"
required: false
type: string
produces:
- application/ld+json
responses:
'200':
description: >-
the related concept(s) of the requested concept or an empty array if
there are none
schema:
$ref: '#/definitions/RelatedResult'
'304':
description: >-
the resource was not modified, so there is no need to retransmit the
requested resources
'404':
description: no concept could be found with the requested URI
tags:
- Concept-specific methods
/{vocid}/children:
get:
summary: Narrower concepts of the requested concept
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: uri
in: query
description: URI of the concept whose narrower concepts to return
required: true
type: string
- name: lang
in: query
description: label language, e.g. "en" or "fi"
required: false
type: string
produces:
- application/ld+json
responses:
'200':
description: >-
Returns the children of the requested concept. The data is intended
to be used in a hierarchical display.
schema:
$ref: '#/definitions/ChildrenResult'
'304':
description: >-
the resource was not modified, so there is no need to retransmit the
requested resources
'404':
description: no concept could be found with the requested URI
tags:
- Concept-specific methods
/{vocid}/groups:
get:
summary: Concept groups in the vocabulary
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: lang
in: query
description: label language, e.g. "en" or "fi"
required: false
type: string
produces:
- application/ld+json
responses:
'200':
description: concept groups of the vocabulary
schema:
$ref: '#/definitions/GroupResult'
'304':
description: >-
the resource was not modified, so there is no need to retransmit the
requested resources
'404':
description: no vocabulary could be found with the requested id
tags:
- Vocabulary-specific methods
/{vocid}/new:
get:
summary: New concepts in the vocabulary
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: lang
in: query
description: label language, e.g. "en" or "fi"
required: false
type: string
- name: offset
in: query
description: offset of the starting index
required: false
type: number
- name: limit
in: query
description: maximum number of concepts to return
required: false
type: number
produces:
- application/ld+json
responses:
'200':
description: list of most recently created concepts of the vocabulary
schema:
$ref: '#/definitions/changedConceptsResult'
'404':
description: no vocabulary could be found with the requested id
tags:
- Vocabulary-specific methods
/{vocid}/modified:
get:
summary: Modified concepts in the vocabulary
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: lang
in: query
description: label language, e.g. "en" or "fi"
required: false
type: string
- name: offset
in: query
description: offset of the starting index
required: false
type: number
- name: limit
in: query
description: maximum number of concepts to return
required: false
type: number
produces:
- application/ld+json
responses:
'200':
description: list of most recently created concepts of the vocabulary
schema:
$ref: '#/definitions/changedConceptsResult'
'404':
description: no vocabulary could be found with the requested id
tags:
- Vocabulary-specific methods
/{vocid}/groupMembers:
get:
summary: Members of the requested concept group
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: lang
in: query
description: label language, e.g. "en" or "fi"
required: false
type: string
produces:
- application/ld+json
responses:
'200':
description: concept groups of the vocabulary
schema:
$ref: '#/definitions/GroupMembers'
'304':
description: >-
the resource was not modified, so there is no need to retransmit the
requested resources
'404':
description: no concept group could be found with the requested URI
tags:
- Concept-specific methods
/{vocid}/hierarchy:
get:
summary: Hierarchical context of the requested concept
parameters:
- name: vocid
in: path
description: a Skosmos vocabulary identifier e.g. "stw" or "yso"
required: true
type: string
- name: uri
in: query
description: URI of the concept whose hierarchical context to return
required: true
type: string
- name: lang