-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMorphoSource-REST-API.yaml
More file actions
2484 lines (2421 loc) · 99.6 KB
/
MorphoSource-REST-API.yaml
File metadata and controls
2484 lines (2421 loc) · 99.6 KB
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
openapi: 3.1.0
x-stoplight:
id: rm6bqdolcidct
info:
title: MorphoSource REST API
version: 0.6.0
summary: MorphoSource REST API to retrieve metadata for repository records
contact:
name: Julie Winchester
url: 'https://www.morphosource.org'
email: julie.winchester@duke.edu
license:
name: CC BY-NC 4.0
url: 'https://creativecommons.org/licenses/by-nc/4.0/'
termsOfService: 'https://www.morphosource.org/terms'
description: |-
# MorphoSource REST API
[MorphoSource](https://www.morphosource.org) is a publicly accessible 3D data repository that enables museums, researchers, and scholars to upload, curate, and share 3D and 2D media representing physical objects of scholarly importance that can be found, viewed, and downloaded by other subject experts, educators, and the public. The MorphoSource REST API allows users to query and search repository records, including Media, Physical Objects, Organizations, and media collections like Projects and Teams. Users can also use the API to download MorphoSource media. Users who manage projects and teams can use the API to retrieve usage information for media in their media collections, including numbers of downloads, download requests, and other usage statistics.
The API is described with intuitive human-readable [documentation](https://morphosource.stoplight.io/docs/morphosource-api/rm6bqdolcidct-morpho-source-rest-api) powered by Stoplight. This documentation includes example requests and responses which can be very helpful when getting started with the API. We also make available an [OpenAPI 3 Schema specification document](https://github.com/MorphoSource/morphosource-api) that expresses and describes the API in ways that machines can interpret.
## Endpoints
This is a list of major API endpoints that are described in this documentation, with links to pages describing each endpoint.
### Media
| Endpoint | Description |
| --- | --- |
| [/api/media/{media-id}](https://morphosource.stoplight.io/docs/morphosource-api/b474e3d7c2ccc-get-individual-media-record) | Get individual media record |
| [/api/media/{media-id}/file-metadata](https://morphosource.stoplight.io/docs/morphosource-api/c7dcuud1iq44q-get-individual-media-file-metadata) | Get individual media file metadata |
| [/api/media/{media-id}/iiif/manifest](https://morphosource.stoplight.io/docs/morphosource-api/3clfct1x09z8k-get-individual-media-iiif-manifest) | Get individual media IIIF manifest |
| [/api/media](https://morphosource.stoplight.io/docs/morphosource-api/2d534286cca2e-search-media-records) | Search media records |
| [/api/download/{media-id}](https://morphosource.stoplight.io/docs/morphosource-api/stzmm22vruz2k-download-media-file) | Download media file |
### Physical Objects
| Endpoint | Description |
| --- | --- |
| [/api/physical-objects/{physical-object-id}](https://morphosource.stoplight.io/docs/morphosource-api/aea3fb04ec708-get-individual-physical-object-record) | Get individual physical object record |
| [/api/physical-objects](https://morphosource.stoplight.io/docs/morphosource-api/2da44118dab34-search-physical-object-records) | Search physical object records |
### Organizations
| Endpoint | Description |
| --- | --- |
| [/api/organizations/{organization-id}](https://morphosource.stoplight.io/docs/morphosource-api/a544f2a31073a-get-individual-organization-record) | Get individual organization record |
| [/api/organizations](https://morphosource.stoplight.io/docs/morphosource-api/fa3dc1d3c66be-search-organization-records) | Search organization records |
### Projects or Teams
| Endpoint | Description |
| --- | --- |
| [/api/projects/{project-or-team-id}](https://morphosource.stoplight.io/docs/morphosource-api/a14e662377b48-get-individual-project-or-team-record) | Get individual project or team records |
| [/api/projects](https://morphosource.stoplight.io/docs/morphosource-api/01a98fbf58a8b-search-project-or-team-records) | Search project or team records |
| [/api/projects/{project-or-team-id}/media](https://morphosource.stoplight.io/docs/morphosource-api/12c02c9cbcce0-get-media-in-project-or-team) | Get media in project or team |
| [/api/projects/{project-or-team-id}/biological-specimens](https://morphosource.stoplight.io/docs/morphosource-api/3bb4484b02180-get-biological-specimens-in-project-or-team) | Get biological specimens in project or team |
| [/api/projects/{project-or-team-id}/cultural-heritage-objects](https://morphosource.stoplight.io/docs/morphosource-api/4c194247a13ee-get-cultural-heritage-objects-in-project-or-team) | Get cultural heritage objects in project or team |
| [/api/projects/{project-or-team-id}/media-download-counts](https://morphosource.stoplight.io/docs/morphosource-api/01d554d45ad00-get-metadata-and-download-counts-of-media-in-project-or-team) | Get metadata and download counts of media in project or team |
| [/api/projects/{project-or-team-id}/media-downloads](https://morphosource.stoplight.io/docs/morphosource-api/ecc384615696f-get-downloads-of-media-in-project-or-team) | Get downloads of media in project or team |
| [/api/projects/{project-or-team-id}/media-requests](https://morphosource.stoplight.io/docs/morphosource-api/0e6860f269b72-get-requests-to-download-restricted-media-in-project-or-team) | Get requests to download restricted media in project or team |
| [/api/projects/{team-id}/view-only-media-projects](https://morphosource.stoplight.io/docs/morphosource-api/67b9b4443769a-get-projects-containing-media-in-a-team-but-not-owned-by-team) | Get projects containing media in a team but not owned by team |
## Other Resources
To better understand the metadata fields and terms used in the API, consult the [MorphoSource Terms Vocabulary](https://www.morphosource.org/terms/ms) and [MorphoSource Controlled Vocabularies](https://www.morphosource.org/terms/mscv) terms ontologies. These ontologies define and characterize the data model and metadata fields used by MorphoSource to record important attributes of media and physical object records, as well as the imaging and processing workflows that produce media.
## Attribution
The creation of this API documentation was supported by the National Science Foundation under Grant Number DBI-2149257. Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.
servers:
- url: 'https://www.morphosource.org'
description: MorphoSource
paths:
'/api/download/{media-id}':
post:
summary: Download media file
operationId: post-api-download-media-id
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
response:
type: object
x-stoplight:
id: 4ll5cxxqb2feb
properties:
media:
type: object
x-stoplight:
id: s4qe8mx5nyu88
properties:
id:
type: array
x-stoplight:
id: jetmccfenbrak
items:
x-stoplight:
id: shx8h1mrcm372
type: string
download_url:
type: array
x-stoplight:
id: 5xxewa82c5ja5
items:
x-stoplight:
id: nweu6wk70e3th
type: string
'400':
$ref: '#/components/responses/400-Bad-Request'
'401':
$ref: '#/components/responses/401-Authentication-Required'
'404':
$ref: '#/components/responses/404-Not-Found'
x-stoplight:
id: stzmm22vruz2k
requestBody:
$ref: '#/components/requestBodies/Download-Request'
security:
- API-Key: []
description: |-
Retrieves a file download URL for a single media if the user is authorized to download requested media. This endpoint can be used to achieve media file downloads using the API. Please note: this endpoint is significantly different from other routes provided by the API, so please read the description carefully. Also see the provided **Request Sample** for an example successful request.
To use this endpoint, users must identify themselves and provide information relating to how downloaded media will be used. The following information must be supplied:
- The media ID the user wants to download, provided as a URL path parameter.
- The API key linked to the downloading user's MorphoSource account, provided as an authorization header.
- A download use statement providing a free-text description of use intent at least 50 characters in length.
- A response to a use category survey, in which the user indicates one or more specific use categories that describe the download use intent. Only certain approved use categories are allowed, see **Body** section below for allowed values. Alternately, if the use category survey allowed values do not suitably describe a user's download intent, the user can instead provide a free-text `use_category_other` that permits custom use categories to be described. One of either `use_category` or `use_category_other` must be supplied, however.
- User should indicate with a boolean value (`true`) that they agree to all relevant terms for download use and reuse as specified by MorphoSource and the data contributor who uploaded the media. See the particular media page on MorphoSource or query media metadata via API in order to learn more about what use restriction terms, licenses, and agreements may apply.
If the request is successful, the response will include a direct download URL that can be used to download the media file. **Response Example** to the right demonstrates a response from a successful request.
Requests made to the direct download URL must still include the user's API key. The direct download URL identifies the requesting user specifically and is only to be used by the requesting user. See below for an example CURL usage to download a file from a direct download URL to a file name suggested by the API:
```
curl \
--url "$DOWNLOAD_URL" \
--header 'Authorization: $API_KEY' \
--remote-name \
--remote-header-name
```
tags:
- Media endpoints
parameters:
- schema:
type: string
name: media-id
in: path
required: true
'/api/media/{media-id}':
get:
summary: Get individual media record
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
response:
type: object
description: Contains media metadata object
properties:
media:
$ref: '#/components/schemas/Media'
examples: {}
'404':
$ref: '#/components/responses/404-Not-Found'
operationId: get-api-media-id
description: |-
Returns metadata for a single Media record.
API key is optional. Querying published media does not require an API key. An API key can be used to query private Media the user has specific access to view. If this route is used to query a Media that does not exist, a Media that is private and the request does not supply an API key, or a Media that is private and an API key is supplied but the user does not have access to view the Media, then a 404 Not Found response will be returned.
parameters: []
security:
- {}
- API-Key: []
tags:
- Media endpoints
parameters:
- schema:
type: string
minLength: 9
maxLength: 9
example: '000200043'
name: media-id
in: path
description: Unique media record ID. Should be a string of 9 numeric characters.
required: true
'/api/media/{media-id}/file-metadata':
parameters:
- schema:
type: string
minLength: 9
maxLength: 9
example: '000200043'
name: media-id
in: path
required: true
description: Unique media record ID. Should be a string of 9 numeric characters.
get:
summary: Get individual media file metadata
tags:
- Media endpoints
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
response:
type: object
x-stoplight:
id: h2yncaqli83kj
properties:
file_set:
$ref: '#/components/schemas/Media-File-Metadata'
x-stoplight:
id: 5rweg3gxhkvxn
'404':
$ref: '#/components/responses/404-Not-Found'
operationId: get-api-media-media-id-file-metadata
x-stoplight:
id: c7dcuud1iq44q
description: |-
Returns metadata specific to file object associated with a single Media record.
If the Media does not have an uploaded file, then an empty response will be returned: `{ "response": {} }`.
API key is optional. Querying published media does not require an API key. An API key can be used to query private Media the user has specific access to view. If this route is used to query a Media that does not exist, a Media that is private and the request does not supply an API key, or a Media that is private and an API key is supplied but the user does not have access to view the Media, then a 404 Not Found response will be returned.
security:
- {}
- API-Key: []
parameters: []
'/api/media/{media-id}/iiif/manifest':
parameters:
- schema:
type: string
minLength: 9
maxLength: 9
example: '000200043'
name: media-id
in: path
required: true
description: Unique media record ID. Should be a string of 9 numeric characters.
get:
summary: Get individual media IIIF manifest
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
response:
type: object
x-stoplight:
id: r10c7zpz6udda
properties:
media:
$ref: '#/components/schemas/Media-IIIF-Manifest'
x-stoplight:
id: 02k22ahm2orbi
'401':
$ref: '#/components/responses/401-Authentication-Required'
'404':
$ref: '#/components/responses/404-Not-Found'
operationId: get-api-media-media-id-iiif-manifest
x-stoplight:
id: 3clfct1x09z8k
tags:
- Media endpoints
security:
- {}
- API-Key: []
description: |
Returns URL for the IIIF Presentation API manifest document for Media. Manifest is a JSON document that uses the IIIF Presentation API to provide a contextualized 3D, 2D, or AV preview of the file associated with the Media in a format suitable for use in other IIIF-compatible viewers and tools.
To use this endpoint, you must provide an API key associated with an active MorphoSource user account. A 401 Unauthorized response will be returned if no API key is present or if the API key is not associated with a valid user.
Please note that IIIF Presentation manifests for private MorphoSource media will not be accessible if referenced or embedded in other viewers, only manifests of published media should be used for that use case.
/api/media:
get:
summary: Search media records
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
response:
type: object
description: Contains media metadata object
properties:
media:
type: array
items:
$ref: '#/components/schemas/Media'
facets:
type: array
items:
$ref: '#/components/schemas/Catalog-Facet'
pages:
$ref: '#/components/schemas/Catalog-Pages-Information'
examples: {}
operationId: get-api-media
description: |-
Searches for multiple Media records and returns metadata. A free text search query parameter is used to search across many different Media record fields. Results will be returned in paged format, with default results being returned for the first page of up to 1,000 results. Results can be filtered through the use of filter facets, which should always be supplied as query parameters in the form "f.<field_name>". See below for the list of applicable filter facet fields. This route provides equivalent functionality to the MorphoSource Media Search page (https://www.morphosource.org/catalog/media), the use of query parameters is very similar between that page and this endpoint. Experimenting with the features of the Media Search page may be instructive for use of this endpoint.
API key is optional. Searching published media does not require an API key. An API key can be used to search private media the user has specific access to view.
parameters:
- schema:
type: string
in: query
name: q
description: 'Search query. This is optional, and without a query all Media matching filter facet options will be shown. Omitting query and filter information can be used to query all Media the user has access to view'
- schema:
type: integer
default: 1
format: int32
in: query
name: page
description: Current results page. Displays number of results equal to per_page parameter at current page increment.
- schema:
type: integer
default: 10
maximum: 1000
minimum: 1
format: int32
in: query
name: per_page
description: Number of results to display. Maximum value of 1000 results per page.
- schema:
type: string
example: CT Image Series
in: query
name: f.media_type
description: Media Type
- schema:
type: string
example: MicroNanoXRayComputedTomography
in: query
name: f.modality
description: Modality
- schema:
type: string
example: Biological Specimen
in: query
name: f.object_type
description: Object Type
- schema:
type: string
example: Museum of Biological Specimens Collection of Vertebrates
in: query
name: f.organization
description: Organization
- schema:
type: string
example: University of Education Facility for Scanning Things
in: query
name: f.imaging_facility
description: Imaging Facility
- schema:
type: string
example: Open Download
in: query
name: f.publication_status
description: Publication Status
- schema:
type: string
example: 'http://rightsstatements.org/vocab/InC/1.0/'
in: query
name: f.rights_statement
description: Rights Statement
- schema:
type: string
example: 'https://creativecommons.org/licenses/by-nc/4.0/'
in: query
name: f.license
description: CC License
- schema:
type: string
example: Puma concolor
in: query
name: f.taxonomy_name
description: Taxonomy (Name)
- schema:
type: string
example: Felidae
in: query
name: f.taxonomy_gbif
description: Taxonomy (GBIF)
- schema:
type: string
in: query
name: f.tag
description: Tag
- schema:
type: string
in: query
name: f.team
description: Team Containing Media
- schema:
type: string
in: query
name: f.project
description: Project Containing Media
- schema:
type: string
in: query
name: f.media_list
description: Media List Containing Media
- schema:
type: string
in: query
name: f.seq_section_list
description: Sequential Section List Containing Media
- schema:
type: string
in: query
name: f.owner
description: Data Manager
- schema:
type: string
in: query
name: f.depositor
description: Data Uploader
- schema:
type: string
in: query
name: f.sponsor
description: Data Sponsor
security:
- {}
- API-Key: []
tags:
- Media endpoints
parameters: []
'/api/physical-objects/{physical-object-id}':
get:
summary: Get individual physical object record
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
response:
type: object
description: Contains physical object metadata object
properties:
biological_specimen || cultural_heritage_object:
$ref: '#/components/schemas/Physical-Object'
examples: {}
'404':
$ref: '#/components/responses/404-Not-Found'
operationId: get-api-physical-object-id
description: |-
Returns metadata for a single Physical Object (Biological Specimen or Cultural Heritage Object) record.
It is possible to include an API key, but by default all Physical Object records are public. Therefore, this is generally unnecessary.
parameters: []
security:
- {}
- API-Key: []
tags:
- Physical object endpoints
parameters:
- schema:
type: string
example: '000200025'
name: physical-object-id
in: path
required: true
description: Unique physical object record ID. Should be a string of 9 numeric characters.
/api/physical-objects:
get:
summary: Search physical object records
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
response:
type: object
description: Contains media metadata object
properties:
physical_objects:
type: array
items:
$ref: '#/components/schemas/Physical-Object'
facets:
type: array
items:
$ref: '#/components/schemas/Catalog-Facet'
pages:
$ref: '#/components/schemas/Catalog-Pages-Information'
examples: {}
operationId: get-api-physical-objects
description: |-
Searches for multiple Physical Object (Biological Specimen or Cultural Heritage Object) records and returns metadata. A free text search query parameter is used to search across many different Physical Object record fields. Results will be returned in paged format, with default results being returned for the first page of up to 1,000 results. Results can be filtered through the use of filter facets, which should always be supplied as query parameters in the form "f.<field_name>". See below for the list of applicable filter facet fields. This route provides equivalent functionality to the MorphoSource Object Search page (https://www.morphosource.org/catalog/objects), the use of query parameters is very similar between that page and this endpoint. Experimenting with the features of the Object Search page may be instructive for use of this endpoint.
It is possible to include an API key, but by default all Physical Object records are public. Therefore, this is generally unnecessary.
parameters:
- schema:
type: string
in: query
name: q
description: 'Search query. This is optional, and without a query all Physical Objects matching filter facet options will be shown. Omitting query and filter information can be used to query all Physical Objects.'
- schema:
type: integer
default: 1
in: query
name: page
description: Current results page. Displays number of results equal to per_page parameter at current page increment.
- schema:
type: integer
default: 10
minimum: 1
maximum: 1000
in: query
name: per_page
description: Number of results to display. Maximum value of 1000 results per page.
- schema:
type: string
example: Biological Specimen
in: query
name: f.object_type
description: Object Type
- schema:
type: string
in: query
name: f.creator
description: Collector/Creator
- schema:
type: string
example: Museum of Biological Specimens Collection of Vertebrates
in: query
name: f.organization
description: Organization
- schema:
type: string
example: Puma concolor
in: query
name: f.taxonomy_name
description: Taxonomy (Name)
- schema:
type: string
example: Felidae
in: query
name: f.taxonomy_gbif
description: Taxonomy (GBIF)
- schema:
type: string
example: CT Image Series
in: query
name: f.media_type
description: Media Type
- schema:
type: string
in: query
name: f.media_tag
description: Media Tag
- schema:
type: string
in: query
name: f.team
description: Team Containing Media of Object
- schema:
type: string
in: query
name: f.project
description: Project Containing Media of Object
- schema:
type: string
in: query
name: f.media_list
description: Media List Containing Media of Object
- schema:
type: string
in: query
name: f.seq_section_list
description: Sequential Section List Containing Media of Object
security:
- {}
- API-Key: []
tags:
- Physical object endpoints
requestBody:
content: {}
parameters: []
'/api/organizations/{organization-id}':
get:
summary: Get individual organization record
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
response:
type: object
description: Contains organization metadata object
properties:
organization:
$ref: '#/components/schemas/Organization'
examples: {}
'404':
$ref: '#/components/responses/404-Not-Found'
operationId: get-api-organization-id
description: |-
Returns metadata for a single Organization (a museum, institutional, or departmental collection of physical objects) record.
It is possible to include an API key, but by default all Organization records are public. Therefore, this is generally unnecessary.
parameters: []
security:
- {}
- API-Key: []
tags:
- Organization endpoints
parameters:
- schema:
type: string
example: '000200127'
name: organization-id
in: path
required: true
description: Unique organization record ID. Should be a string of 9 numeric characters.
/api/organizations:
get:
summary: Search organization records
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
response:
type: object
properties:
organizations:
type: array
items:
$ref: '#/components/schemas/Organization'
facets:
type: array
items:
$ref: '#/components/schemas/Catalog-Facet'
pages:
$ref: '#/components/schemas/Catalog-Pages-Information'
examples: {}
operationId: get-api-organizations
description: |-
Searches for multiple Organization (a museum, institutional, or departmental collection of physical objects) records and returns metadata.
It is possible to include an API key, but by default all organization records are public. Therefore, this is generally unnecessary.
parameters:
- schema:
type: string
example: all_fields
in: query
name: search_field
description: Must be "all_fields" to use search query
- schema:
type: string
in: query
name: q
description: 'Search query. This is optional, and without a query all Organizations matching filter facet options will be shown. Omitting query and filter information can be used to query all Organizations.'
- schema:
type: integer
default: 1
in: query
name: page
description: Current results page. Displays number of results equal to per_page parameter at current page increment.
- schema:
type: integer
default: 10
minimum: 1
maximum: 1000
in: query
name: per_page
description: Number of results to display. Maximum value of 1000 results per page.
- schema:
type: string
in: query
name: f.organization_type
description: Organization Type
- schema:
type: string
in: query
name: f.institution_name
description: Institution Name
- schema:
type: string
in: query
name: f.institution_code
description: Institution Code
- schema:
type: string
in: query
name: f.country
description: Country
- schema:
type: string
in: query
name: f.state_province
description: State/Province
- schema:
type: string
in: query
name: f.city
description: City
security:
- {}
- API-Key: []
tags:
- Organization endpoints
parameters: []
'/api/projects/{project-or-team-id}':
get:
summary: Get individual project or team record
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
response:
type: object
description: Contains organization metadata object
properties:
collection:
$ref: '#/components/schemas/Project-or-Team'
examples: {}
'404':
$ref: '#/components/responses/404-Not-Found'
operationId: get-api-project-id
description: |-
Returns metadata for a single Project or Team record.
API key is optional. Querying published Projects or Teams does not require an API key. An API key can be used to query private Projects or Teams the user has specific access to view. If this route is used to query a Project or Team that does not exist, a Project or Team that is private and the request does not supply an API key, or a Project or Team that is private and an API key is supplied but the user does not have access to view the Media, then a 404 Not Found response will be returned.
parameters: []
security:
- {}
- API-Key: []
tags:
- Project or team endpoints
parameters:
- schema:
type: string
example: '000200022'
name: project-or-team-id
in: path
required: true
description: Unique project or team record ID. Should be a string of 9 numeric characters.
/api/projects:
get:
summary: Search project or team records
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
response:
type: object
properties:
collections:
type: array
items:
$ref: '#/components/schemas/Project-or-Team'
facets:
type: array
items:
$ref: '#/components/schemas/Catalog-Facet'
pages:
$ref: '#/components/schemas/Catalog-Pages-Information'
examples: {}
operationId: get-api-projects
description: |-
Searches for multiple Project or Team records and returns metadata.
API key is optional. Searching published Projects or Teams does not require an API key. An API key can be used to search private Projects or Teams the user has specific access to view.
parameters:
- schema:
type: string
in: query
name: q
description: 'Search query. This is optional, and without a query all Projects and Teams matching filter facet options will be shown. Omitting query and filter information can be used to query all Projects or Teams the user has access to view'
- schema:
type: integer
default: 1
in: query
name: page
description: Current results page. Displays number of results equal to per_page parameter at current page increment.
- schema:
type: integer
minimum: 1
maximum: 1000
default: 10
in: query
name: per_page
description: Number of results to display. Maximum value of 1000 results per page.
- schema:
type: string
in: query
name: f.type
description: Project or Team
- schema:
type: string
in: query
name: f.organization
description: Linked Organization
security:
- {}
- API-Key: []
tags:
- Project or team endpoints
parameters: []
'/api/projects/{project-or-team-id}/media':
get:
summary: Get media in project or team
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
response:
type: object
properties:
media:
type: array
items:
$ref: '#/components/schemas/Media'
examples: {}
'401':
$ref: '#/components/responses/401-Authentication-Required'
'404':
$ref: '#/components/responses/404-Not-Found'
operationId: get-api-project-media
description: |-
Returns metadata for media records in a project or team.
To use this endpoint, you must be a manager for the project or team and provide your API key.
parameters: []
security:
- API-Key: []
tags:
- Project or team endpoints
- Records in project or team endpoints
parameters:
- schema:
type: string
example: '000200022'
name: project-or-team-id
in: path
required: true
description: Unique project or team record ID. Should be a string of 9 numeric characters.
'/api/projects/{project-or-team-id}/biological-specimens':
get:
summary: Get biological specimens in project or team
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
response:
type: object
properties:
objects:
type: array
items:
$ref: '#/components/schemas/Physical-Object'
examples: {}
'401':
$ref: '#/components/responses/401-Authentication-Required'
'404':
$ref: '#/components/responses/404-Not-Found'
operationId: get-api-project-biological-specimens
description: |-
Returns metadata for biological specimen records in a project or team.
To use this endpoint, you must be a manager for the project or team and provide your API key.
parameters: []
security:
- API-Key: []
tags:
- Project or team endpoints
- Records in project or team endpoints
parameters:
- schema:
type: string
example: '000200022'
name: project-or-team-id
in: path
required: true
description: Unique project or team record ID. Should be a string of 9 numeric characters.
'/api/projects/{project-or-team-id}/cultural-heritage-objects':
get:
summary: Get cultural heritage objects in project or team
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
response:
type: object
properties:
objects:
type: array
items:
$ref: '#/components/schemas/Physical-Object'
facets:
type: array
items:
$ref: '#/components/schemas/Catalog-Facet'
pages:
$ref: '#/components/schemas/Catalog-Pages-Information'
examples: {}
'401':
$ref: '#/components/responses/401-Authentication-Required'
'404':
$ref: '#/components/responses/404-Not-Found'
operationId: get-api-project-cultural-heritage-objects
description: |-
Returns metadata for cultural heritage object records in a project or team.
To use this endpoint, you must be a manager for the project or team and provide your API key.
parameters: []
security:
- API-Key: []
tags:
- Project or team endpoints
- Records in project or team endpoints
parameters:
- schema:
type: string
example: '000200022'
name: project-or-team-id
in: path
required: true
description: Unique project or team record ID. Should be a string of 9 numeric characters.
'/api/projects/{project-or-team-id}/media-download-counts':
get:
summary: Get metadata and download counts of media in project or team
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
response:
type: object
description: Contains organization metadata object
properties:
media_with_download_counts:
type: array
items:
type: object
properties:
id:
type: array
items:
type: string