213 get:
214 operationId: getInstitutionMapCluster
215 summary: Not implemented.
216 description: This is not implemented.
217 deprecated: true
218 parameters:
266 get:
267 operationId: getItemsIdAip
268 summary: Returns the Archive Information Package (AIP) of a DDB item
269 description: |
270 An AIP contains all available information of an item including a persistent identifier. All AIPs consist of the following components: *binaries*, *children*, *edm*, *indexing-profile*, *parent*, *source* and *view*.
271 deprecated: true
266 get:
267 operationId: getItemsIdAip
268 summary: Returns the Archive Information Package (AIP) of a DDB item
269 description: |
270 An AIP contains all available information of an item including a persistent identifier. All AIPs consist of the following components: *binaries*, *children*, *edm*, *indexing-profile*, *parent*, *source* and *view*.
271 deprecated: true
511 responses:
512 '200':
513 description: Success.
514 content:
515 application/xml:
516 schema:
1352 - spell_check
1353 - sort_field
1354 description: Name of the facet which should be searched.
1355 # Inherit from /search/person
1356 - $ref: '#/components/parameters/search_query'
1357 - $ref: '#/components/parameters/search_person_facet'
1673 - spell_check
1674 - sort_field
1675 description: Name of the facet which should be searched.
1676 # Inherit from /search/organization
1677 - $ref: '#/components/parameters/search_query'
1678 - $ref: '#/components/parameters/search_organization_facet'
2150 schema:
2151 type: string
2152 description: |
2153 If *objecttype_fct* is selected in `facet` then this query parameter should have a query value.
2154 search_provider_fct:
2155 in: query
2848 schema:
2849 type: string
2850 description: |
2851 If *id* is selected in `facet` then this query parameter should have a query value.
2852 search_person_preferredName:
2853 in: query
3023 schema:
3024 type: string
3025 description: |
3026 If *suggest_field* is selected in `facet` then this query parameter should have a query value.
3027 search_person_wildcard_fulltext:
3028 in: query
3037 schema:
3038 type: string
3039 description: |
3040 If *last_update* is selected in `facet` then this query parameter should have a query value.
3041 search_person_spell_check:
3042 in: query
3044 schema:
3045 type: string
3046 description: |
3047 If *spell_check* is selected in `facet` then this query parameter should have a query value.
3048 search_person_sort_field:
3049 in: query
3051 schema:
3052 type: string
3053 description: |
3054 If *sort_field* is selected in `facet` then this query parameter should have a query value.
3055 search_organization_facet:
3056 in: query
3173 schema:
3174 type: string
3175 description: |
3176 If *id* is selected in `facet` then this query parameter should have a query value.
3177 search_organization_variant_id:
3178 in: query
3180 schema:
3181 type: string
3182 description: |
3183 If *variant_id* is selected in `facet` then this query parameter should have a query value.
3184 search_organization_ddb_organization_id:
3185 in: query
3194 schema:
3195 type: string
3196 description: |
3197 If *thumbnail* is selected in `facet` then this query parameter should have a query value.
3198 search_organization_type:
3199 in: query
3201 schema:
3202 type: string
3203 description: |
3204 If *type* is selected in `facet` then this query parameter should have a query value.
3205 search_organization_count:
3206 in: query
3208 schema:
3209 type: string
3210 description: |
3211 If *count* is selected in `facet` then this query parameter should have a query value.
3212 search_organization_count_sec_01:
3213 in: query
3215 schema:
3216 type: string
3217 description: |
3218 If *count_sec_01* is selected in `facet` then this query parameter should have a query value.
3219 search_organization_count_sec_02:
3220 in: query
3222 schema:
3223 type: string
3224 description: |
3225 If *count_sec_02* is selected in `facet` then this query parameter should have a query value.
3226 search_organization_count_sec_03:
3227 in: query
3229 schema:
3230 type: string
3231 description: |
3232 If *count_sec_03* is selected in `facet` then this query parameter should have a query value.
3233 search_organization_count_sec_04:
3234 in: query
3236 schema:
3237 type: string
3238 description: |
3239 If *count_sec_04* is selected in `facet` then this query parameter should have a query value.
3240 search_organization_count_sec_05:
3241 in: query
3243 schema:
3244 type: string
3245 description: |
3246 If *count_sec_05* is selected in `facet` then this query parameter should have a query value.
3247 search_organization_count_sec_06:
3248 in: query
3250 schema:
3251 type: string
3252 description: |
3253 If *count_sec_06* is selected in `facet` then this query parameter should have a query value.
3254 search_organization_count_sec_07:
3255 in: query
3257 schema:
3258 type: string
3259 description: |
3260 If *count_sec_07* is selected in `facet` then this query parameter should have a query value.
3261 search_organization_label:
3262 in: query
3264 schema:
3265 type: string
3266 description: |
3267 If *label* is selected in `facet` then this query parameter should have a query value.
3268 search_organization_description:
3269 in: query
3271 schema:
3272 type: string
3273 description: |
3274 If *description* is selected in `facet` then this query parameter should have a query value.
3275 search_organization_subsector_fct:
3276 in: query
3285 schema:
3286 type: string
3287 description: |
3288 If *sector_fct* is selected in `facet` then this query parameter should have a query value.
3289 search_organization_topic_fct:
3290 in: query
3292 schema:
3293 type: string
3294 description: |
3295 If *topic_fct* is selected in `facet` then this query parameter should have a query value.
3296 search_organization_state_fct:
3297 in: query
3299 schema:
3300 type: string
3301 description: |
3302 If *state_fct* is selected in `facet` then this query parameter should have a query value.
3303 search_organization_city_fct:
3304 in: query
3348 schema:
3349 type: string
3350 description: |
3351 If *preferredName* is selected in `facet` then this query parameter should have a query value.
3352 search_organization_variantName:
3353 in: query
3355 schema:
3356 type: string
3357 description: |
3358 If *variantName* is selected in `facet` then this query parameter should have a query value.
3359 search_organization_topic:
3360 in: query
3418 schema:
3419 type: string
3420 description: |
3421 If *revision_id* is selected in `facet` then this query parameter should have a query value.
3422 search_organization_dataset_id:
3423 in: query
3425 schema:
3426 type: string
3427 description: |
3428 If *dataset_id* is selected in `facet` then this query parameter should have a query value.
3429 search_organization_atoz:
3430 in: query
3439 schema:
3440 type: string
3441 description: |
3442 If *subsector* is selected in `facet` then this query parameter should have a query value.
3443 search_organization_hasItems:
3444 in: query
3446 schema:
3447 type: string
3448 description: |
3449 If *hasItems* is selected in `facet` then this query parameter should have a query value.
3450 search_organization_geocode:
3451 in: query
3453 schema:
3454 type: string
3455 description: |
3456 If *geocode* is selected in `facet` then this query parameter should have a query value.
3457 search_organization_geocode_0_coordinate:
3458 in: query
3460 schema:
3461 type: string
3462 description: |
3463 If *geocode_0_coordinate* is selected in `facet` then this query parameter should have a query value.
3464 search_organization_geocode_1_coordinate:
3465 in: query
3467 schema:
3468 type: string
3469 description: |
3470 If *geocode_1_coordinate* is selected in `facet` then this query parameter should have a query value.
3471 search_organization_location_display_name:
3472 in: query
3495 schema:
3496 type: string
3497 description: |
3498 If *suggest_field* is selected in `facet` then this query parameter should have a query value.
3499 search_organization_wildcard_fulltext:
3500 in: query
3502 schema:
3503 type: string
3504 description: |
3505 If *wildcard_fulltext* is selected in `facet` then this query parameter should have a query value.
3506 search_organization_last_update:
3507 in: query
3509 schema:
3510 type: string
3511 description: |
3512 If *last_update* is selected in `facet` then this query parameter should have a query value.
3513 search_organization_spell_check:
3514 in: query
3516 schema:
3517 type: string
3518 description: |
3519 If *spell_check* is selected in `facet` then this query parameter should have a query value.
3520 search_organization_sort_field:
3521 in: query
3523 schema:
3524 type: string
3525 description: |
3526 If *sort_field* is selected in `facet` then this query parameter should have a query value.
3527 type:
3528 in: query
3548 responses:
3549 '200':
3550 description: Success.
3551 content:
3552 'application/xml':
3553 schema:
3560 type: object
3561 '200-rdfxml':
3562 description: Success.
3563 content:
3564 'application/rdf+xml':
3565 schema:
3569 type: object
3570 '200-jsononly':
3571 description: Success.
3572 content:
3573 'application/json':
3574 schema:
22servers:
23 - description: Production
24 url: https://api.deutsche-digitale-bibliothek.de/
25 - description: Testing Q1
26 url: https://api-q1.deutsche-digitale-bibliothek.de/
27 - description: Development (FIZ Karlsruhe)
24 url: https://api.deutsche-digitale-bibliothek.de/
25 - description: Testing Q1
26 url: https://api-q1.deutsche-digitale-bibliothek.de/
27 - description: Development (FIZ Karlsruhe)
28 url: https://dev-ddb.fiz-karlsruhe.de/api/
29paths:
26 url: https://api-q1.deutsche-digitale-bibliothek.de/
27 - description: Development (FIZ Karlsruhe)
28 url: https://dev-ddb.fiz-karlsruhe.de/api/
29paths:
30 '/binary/{uuid}':
31 get:
3538 Facet type. If not selected all facets will be delivered.
3539 uuid:
3540 in: path
3541 name: uuid
3542 required: true
3543 schema:
3538 Facet type. If not selected all facets will be delivered.
3539 uuid:
3540 in: path
3541 name: uuid
3542 required: true
3543 schema:
47 content:
48 application/octet-stream:
49 schema:
50 type: object
51 '*/*':
52 schema:
50 type: object
51 '*/*':
52 schema:
53 type: object
54 '403':
55 $ref: '#/components/responses/403'
111 | *sec_06* | Museum | http://ddb.vocnet.org/sparte/sparte006 |
112 | *sec_07* | Other | http://ddb.vocnet.org/sparte/sparte007 |
113 schema:
114 type: string
115 enum:
116 - sec_01
171 name: offset
172 required: false
173 schema:
174 type: integer
175 format: int32
176 default: 0
180 name: length
181 required: false
182 schema:
183 type: integer
184 format: int32
185 default: -1
220 name: zoomlevel
221 required: false
222 schema:
223 type: string
224 description: Not implemented.
225 responses:
348 required: false
349 description: EDM data can have different metadata profiles. DDB API can deliver DDB Linked Data profile in any case and in some cases Europeana EDM profile.
350 schema:
351 type: string
352 default: https://www.deutsche-digitale-bibliothek.de/ns/ddb-linkedData-profile
353 enum:
504 description: |
505 Returns the subcomponent `description` or `record` of the component `source`.
506 schema:
507 type: string
508 enum:
509 - record
514 content:
515 application/xml:
516 schema:
517 type: object
518 '303':
519 description: See Other. If the `source/record` is part of an the root DDB item. This only occurs, if the source is a hierarchical data format, like METS/MODS, METS/TEI, EAD(DDB), which won't or can't be split during the ingest process at DDB.
540 name: defaultOperator
541 description: Specifies the default operator for query expressions, overriding the default operator specified in the Solr schema.
542 schema:
543 type: string
544 nullable: true
545 enum:
819 name: facetName
820 required: true
821 schema:
822 type: string
823 enum:
824 - affiliate_fct
918 name: query
919 required: false
920 schema:
921 type: string
922 description: Term(s) to be searched in the selected facet. This must be compliant to the Solr Query Syntax.
923 # Inherit from /search
1073 name: indexname
1074 required: true
1075 schema:
1076 type: string
1077 enum:
1078 - search
1093 name: requesthandler
1094 required: true
1095 schema:
1096 type: string
1097 enum:
1098 - select
1109 name: q
1110 required: false
1111 schema:
1112 type: string
1113 nullable: true
1114 default: '*:*'
1148 in: query
1149 required: false
1150 schema:
1151 type: array
1152 items:
1153 type: string
1319 name: facetName
1320 required: true
1321 schema:
1322 type: string
1323 enum:
1324 - id
1490 content:
1491 '*/*':
1492 schema:
1493 type: string
1494 '403':
1495 $ref: '#/components/responses/403'
1619 name: facetName
1620 required: true
1621 schema:
1622 type: string
1623 enum:
1624 - id
1827 name: id
1828 required: true
1829 schema:
1830 type: string
1831 maxLength: 32
1832 minLength: 32
1837 name: query
1838 required: true
1839 schema:
1840 type: string
1841 nullable: true
1842 default: '*'
1847 name: facet
1848 required: false
1849 schema:
1850 type: array
1851 items:
1852 type: string
2043 in: query
2044 name: affiliate_fct
2045 schema:
2046 type: string
2047 description: |
2048 If *affiliate_fct* is selected in `facet` then this query parameter should have a query value.
2113 in: query
2114 name: digitalisattype_fct
2115 schema:
2116 type: string
2117 description: |
2118 If *digitalisattype_fct* is selected in `facet` then this query parameter should have a query value.
2120 in: query
2121 name: keywords_fct
2122 schema:
2123 type: string
2124 description: |
2125 If *keywords_fct* is selected in `facet` then this query parameter should have a query value.
2127 in: query
2128 name: language_fct
2129 schema:
2130 type: string
2131 description: |
2132 If *language_fct* is selected in `facet` then this query parameter should have a query value.
2134 in: query
2135 name: mimetype_fct
2136 schema:
2137 type: string
2138 description: |
2139 If *mimetype_fct* is selected in `facet` then this query parameter should have a query value.
2141 in: query
2142 name: objecttype_fct
2143 schema:
2144 type: string
2145 description: |
2146 If *objecttype_fct* is selected in `facet` then this query parameter should have a query value.
2148 in: query
2149 name: place_fct
2150 schema:
2151 type: string
2152 description: |
2153 If *objecttype_fct* is selected in `facet` then this query parameter should have a query value.
2155 in: query
2156 name: provider_fct
2157 schema:
2158 type: string
2159 description: |
2160 If *provider_fct* is selected in `facet` then this query parameter should have a query value.
2162 in: query
2163 name: sector_fct
2164 schema:
2165 type: string
2166 description: |
2167 If *sector_fct* is selected in `facet` then this query parameter should have a query value.
2169 in: query
2170 name: state_fct
2171 schema:
2172 type: string
2173 description: |
2174 If *state_fct* is selected in `facet` then this query parameter should have a query value.
2176 in: query
2177 name: time_begin_fct
2178 schema:
2179 type: string
2180 description: |
2181 If *time_begin_fct* is selected in `facet` then this query parameter should have a query value.
2183 in: query
2184 name: time_end_fct
2185 schema:
2186 type: string
2187 description: |
2188 If *time_end_fct* is selected in `facet` then this query parameter should have a query value.
2190 in: query
2191 name: time_fct
2192 schema:
2193 type: string
2194 description: |
2195 If *time_fct* is selected in `facet` then this query parameter should have a query value.
2197 in: query
2198 name: topic_fct
2199 schema:
2200 type: string
2201 description: |
2202 If *topic_fct* is selected in `facet` then this query parameter should have a query value.
2204 in: query
2205 name: type_fct
2206 schema:
2207 type: string
2208 enum:
2209 - '001'
2239 in: query
2240 name: affiliate_fct_involved
2241 schema:
2242 type: string
2243 description: |
2244 If *affiliate_fct_involved* is selected in `facet` then this query parameter should have a query value.
2246 in: query
2247 name: affiliate_fct_subject
2248 schema:
2249 type: string
2250 description: |
2251 If *affiliate_fct_subject* is selected in `facet` then this query parameter should have a query value.
2253 in: query
2254 name: aggregation_field
2255 schema:
2256 type: string
2257 description: |
2258 If *aggregation_field* is selected in `facet` then this query
2261 in: query
2262 name: aggregator_id
2263 schema:
2264 type: string
2265 description: |
2266 If *aggregator_id* is selected in `facet` then this query parameter should have a query value.
2268 in: query
2269 name: apd_abstracts
2270 schema:
2271 type: string
2272 description: |
2273 If *apd_abstracts* is selected in `facet` then this query parameter should have a query value.
2275 in: query
2276 name: apd_context
2277 schema:
2278 type: string
2279 description: |
2280 If *apd_context* is selected in `facet` then this query parameter should have a query value.
2282 in: query
2283 name: apd_document_type
2284 schema:
2285 type: string
2286 description: |
2287 If *apd_document_type* is selected in `facet` then this query
2290 in: query
2291 name: apd_keywords
2292 schema:
2293 type: string
2294 description: |
2295 If *apd_keywords* is selected in `facet` then this query parameter should have a query value.
2297 in: query
2298 name: apd_level_of_description
2299 schema:
2300 type: string
2301 description: |
2302 If *apd_level_of_description* is selected in `facet` then this query parameter should have a query value.
2304 in: query
2305 name: apd_material
2306 schema:
2307 type: string
2308 description: |
2309 If *apd_material* is selected in `facet` then this query parameter should have a query value.
2311 in: query
2312 name: apd_provenance
2313 schema:
2314 type: string
2315 description: |
2316 If *apd_provenance* is selected in `facet` then this query parameter should have a query value.
2318 in: query
2319 name: apd_reference_number
2320 schema:
2321 type: string
2322 description: |
2323 If *apd_reference_number* is selected in `facet` then this query parameter should have a query value.
2325 in: query
2326 name: apd_subject
2327 schema:
2328 type: string
2329 description: |
2330 If *apd_subject* is selected in `facet` then this query parameter should have a query value.
2332 in: query
2333 name: apd_xml_sort
2334 schema:
2335 type: string
2336 description: |
2337 If *apd_xml_sort* is selected in `facet` then this query parameter should have a query value.
2339 in: query
2340 name: atoz
2341 schema:
2342 type: string
2343 description: |
2344 If *atoz* is selected in `facet` then this query parameter should have
2347 in: query
2348 name: begin_time
2349 schema:
2350 type: string
2351 description: |
2352 If *begin_time* is selected in `facet` then this query parameter should have a query value.
2354 in: query
2355 name: category
2356 schema:
2357 type: string
2358 description: |
2359 If *category* is selected in `facet` then this query parameter should have a query value.
2361 in: query
2362 name: content
2363 schema:
2364 type: string
2365 description: |
2366 If *content* is selected in `facet` then this query parameter should have a query value.
2368 in: query
2369 name: context
2370 schema:
2371 type: string
2372 description: |
2373 If *context* is selected in `facet` then this query parameter should have a query value.
2375 in: query
2376 name: dataset_id
2377 schema:
2378 type: string
2379 description: |
2380 If *dataset_id* is selected in `facet` then this query parameter should have a query value.
2382 in: query
2383 name: dataset_label
2384 schema:
2385 type: string
2386 description: |
2387 If *dataset_label* is selected in `facet` then this query parameter should have a query value.
2389 in: query
2390 name: description
2391 schema:
2392 type: string
2393 description: |
2394 If *description* is selected in `facet` then this query parameter should have a query value.
2396 in: query
2397 name: digitalCopyType
2398 schema:
2399 type: string
2400 description: |
2401 If *digitalCopyType* is selected in `facet` then this query parameter should have a query value.
2403 in: query
2404 name: digitalisat
2405 schema:
2406 type: string
2407 description: |
2408 If *digitalisat* is selected in `facet` then this query parameter should have a query value.
2410 in: query
2411 name: end_time
2412 schema:
2413 type: string
2414 description: |
2415 If *end_time* is selected in `facet` then this query parameter should have a query value.
2417 in: query
2418 name: fulltext
2419 schema:
2420 type: string
2421 description: |
2422 If *fulltext* is selected in `facet` then this query parameter should have a query value.
2424 in: query
2425 name: fulltext_search
2426 schema:
2427 type: string
2428 description: |
2429 If *fulltext_search* is selected in `facet` then this query parameter should have a query value.
2431 in: query
2432 name: geocode
2433 schema:
2434 type: string
2435 description: |
2436 If *geocode* is selected in `facet` then this query parameter should have a query value.
2438 in: query
2439 name: geocode_0_coordinate
2440 schema:
2441 type: string
2442 description: |
2443 If *geocode_0_coordinate* is selected in `facet` then this query parameter should have a query value.
2445 in: query
2446 name: geocode_1_coordinate
2447 schema:
2448 type: string
2449 description: |
2450 If *geocode_1_coordinate* is selected in `facet` then this query parameter should have a query value.
2452 in: query
2453 name: grid_preview
2454 schema:
2455 type: string
2456 description: |
2457 If *grid_preview* is selected in `facet` then this query parameter should have a query value.
2459 in: query
2460 name: hasItems
2461 schema:
2462 type: string
2463 description: |
2464 If *hasItems* is selected in `facet` then this query parameter should have a query value.
2466 in: query
2467 name: id
2468 schema:
2469 type: string
2470 description: |
2471 If *id* is selected in `facet` then this query parameter should have a query value.
2473 in: query
2474 name: ingest_id
2475 schema:
2476 type: string
2477 description: |
2478 If *ingest_id* is selected in `facet` then this query parameter should have a query value.
2480 in: query
2481 name: institution_name
2482 schema:
2483 type: string
2484 description: |
2485 If *institution_name* is selected in `facet` then this query parameter should have a query value.
2494 in: query
2495 name: label
2496 schema:
2497 type: string
2498 description: |
2499 If *label* is selected in `facet` then this query parameter should have a query value.
2508 in: query
2509 name: last_update
2510 schema:
2511 type: string
2512 description: |
2513 If *last_update* is selected in `facet` then this query parameter should have a query value.
2515 in: query
2516 name: license
2517 schema:
2518 type: string
2519 description: |
2520 If *license* is selected in `facet` then this query parameter should have a query value.
2522 in: query
2523 name: license_group
2524 schema:
2525 type: string
2526 description: |
2527 If *license_group* is selected in `facet` then this query parameter should have a query value.
2529 in: query
2530 name: mapping_version
2531 schema:
2532 type: string
2533 description: |
2534 If *mapping_version* is selected in `facet` then this query parameter should have a query value.
2536 in: query
2537 name: md_format
2538 schema:
2539 type: string
2540 description: |
2541 If *md_format* is selected in `facet` then this query parameter should have a query value.
2557 in: query
2558 name: preview
2559 schema:
2560 type: string
2561 description: |
2562 If *preview* is selected in `facet` then this query parameter should have a query value.
2564 in: query
2565 name: preview_store
2566 schema:
2567 type: string
2568 description: |
2569 If *preview_store* is selected in `facet` then this query parameter should have a query value.
2578 in: query
2579 name: provider_id
2580 schema:
2581 type: string
2582 description: |
2583 If *provider_id* is selected in `facet` then this query parameter should have a query value.
2585 in: query
2586 name: ranking
2587 schema:
2588 type: string
2589 description: |
2590 If *ranking* is selected in `facet` then this query parameter should have a query value.
2592 in: query
2593 name: revision_id
2594 schema:
2595 type: string
2596 description: |
2597 If *revision_id* is selected in `facet` then this query parameter should have a query value.
2606 in: query
2607 name: signature
2608 schema:
2609 type: string
2610 description: |
2611 If *signature* is selected in `facet` then this query parameter should have a query value.
2613 in: query
2614 name: sort_field
2615 schema:
2616 type: string
2617 description: |
2618 If *sort_field* is selected in `facet` then this query parameter should have a query value.
2620 in: query
2621 name: source_format
2622 schema:
2623 type: string
2624 description: |
2625 If *source_format* is selected in `facet` then this query parameter should have a query value.
2627 in: query
2628 name: spell_check
2629 schema:
2630 type: string
2631 description: |
2632 If *spell_check* is selected in `facet` then this query parameter should have a query value.
2641 in: query
2642 name: subsector
2643 schema:
2644 type: string
2645 description: |
2646 If *subsector* is selected in `facet` then this query parameter should have a query value.
2648 in: query
2649 name: suggest_field
2650 schema:
2651 type: string
2652 description: |
2653 If *suggest_field* is selected in `facet` then this query parameter should have a query value.
2655 in: query
2656 name: suggest_field_apd
2657 schema:
2658 type: string
2659 description: |
2660 If *suggest_field_apd* is selected in `facet` then this query parameter should have a query value.
2662 in: query
2663 name: supplier_id
2664 schema:
2665 type: string
2666 description: |
2667 If *supplier_id* is selected in `facet` then this query parameter should have a query value.
2676 in: query
2677 name: title
2678 schema:
2679 type: string
2680 description: |
2681 If *title* is selected in `facet` then this query parameter should have a query value.
2690 in: query
2691 name: tp_category_id
2692 schema:
2693 type: string
2694 description: |
2695 If *tp_category_id* is selected in `facet` then this query parameter should have a query value.
2704 in: query
2705 name: view
2706 schema:
2707 type: string
2708 description: |
2709 If *view* is selected in `facet` then this query parameter should have a query value.
2712 name: facet.limit
2713 required: false
2714 schema:
2715 type: integer
2716 format: int32
2717 minimum: 0
2722 name: minDocs
2723 required: false
2724 schema:
2725 type: integer
2726 format: int32
2727 minimum: 0
2733 name: offset
2734 required: false
2735 schema:
2736 type: integer
2737 format: int32
2738 minimum: 0
2743 name: rows
2744 required: false
2745 schema:
2746 type: integer
2747 format: int32
2748 minimum: 0
2755 name: sort
2756 required: false
2757 schema:
2758 type: string
2759 description: |
2760 Defines the sorting order, which can be one of the following values. It requires the query parameter, otherwise the sort is always `random_<a_random_seed>`.
2767 name: cursorMark
2768 required: false
2769 schema:
2770 type: string
2771 description: |
2772 [Solr deep paging](https://lucene.apache.org/solr/guide/8_5/pagination-of-results.html). Pass `*` to start the first request.
1284 - Request_Header: []
1285 tags:
1286 - search/person
1287 '/search/person/facets':
1288 get:
1289 operationId: getSearchPersonFacets
1308 - Request_Header: []
1309 tags:
1310 - search/person
1311 '/search/person/facets/{facetName}':
1312 get:
1313 operationId: getSearchPersonFacetsFacetName
1408 - Request_Header: []
1409 tags:
1410 - search/person
1411 '/search/person/facets/maxpages':
1412 get:
1413 operationId: getSearchPersonFacetsMaxpages
1432 - Request_Header: []
1433 tags:
1434 - search/person
1435 '/search/person/sortcriteria':
1436 get:
1437 operationId: getSearchPersonSortcriteria
1454 - Request_Header: []
1455 tags:
1456 - search/person
1457 '/search/person/suggest':
1458 get:
1459 operationId: getSearchPersonSuggest
1478 - Request_Header: []
1479 tags:
1480 - search/person
1481 '/version':
1482 get:
1483 operationId: getVersion
1584 - Request_Header: []
1585 tags:
1586 - search/organization
1587 '/search/organization/facets':
1588 get:
1589 operationId: getSearchOrganizationFacets
1608 - Request_Header: []
1609 tags:
1610 - search/organization
1611 '/search/organization/facets/{facetName}':
1612 get:
1613 operationId: getSearchOrganizationFacetsFacetName
1750 - Request_Header: []
1751 tags:
1752 - search/organization
1753 '/search/organization/facets/maxpages':
1754 get:
1755 operationId: getSearchOrganizationFacetsMaxpages
1774 - Request_Header: []
1775 tags:
1776 - search/organization
1777 '/search/organization/sortcriteria':
1778 get:
1779 operationId: getSearchOrganizationSortcriteria
1796 - Request_Header: []
1797 tags:
1798 - search/organization
1799 '/search/organization/suggest':
1800 get:
1801 operationId: getSearchOrganizationSuggest
1820 - Request_Header: []
1821 tags:
1822 - search/organization
1823components:
1824 parameters:
1825 id:
1284 - Request_Header: []
1285 tags:
1286 - search/person
1287 '/search/person/facets':
1288 get:
1289 operationId: getSearchPersonFacets
1308 - Request_Header: []
1309 tags:
1310 - search/person
1311 '/search/person/facets/{facetName}':
1312 get:
1313 operationId: getSearchPersonFacetsFacetName
1408 - Request_Header: []
1409 tags:
1410 - search/person
1411 '/search/person/facets/maxpages':
1412 get:
1413 operationId: getSearchPersonFacetsMaxpages
1432 - Request_Header: []
1433 tags:
1434 - search/person
1435 '/search/person/sortcriteria':
1436 get:
1437 operationId: getSearchPersonSortcriteria
1454 - Request_Header: []
1455 tags:
1456 - search/person
1457 '/search/person/suggest':
1458 get:
1459 operationId: getSearchPersonSuggest
1478 - Request_Header: []
1479 tags:
1480 - search/person
1481 '/version':
1482 get:
1483 operationId: getVersion
1584 - Request_Header: []
1585 tags:
1586 - search/organization
1587 '/search/organization/facets':
1588 get:
1589 operationId: getSearchOrganizationFacets
1608 - Request_Header: []
1609 tags:
1610 - search/organization
1611 '/search/organization/facets/{facetName}':
1612 get:
1613 operationId: getSearchOrganizationFacetsFacetName
1750 - Request_Header: []
1751 tags:
1752 - search/organization
1753 '/search/organization/facets/maxpages':
1754 get:
1755 operationId: getSearchOrganizationFacetsMaxpages
1774 - Request_Header: []
1775 tags:
1776 - search/organization
1777 '/search/organization/sortcriteria':
1778 get:
1779 operationId: getSearchOrganizationSortcriteria
1796 - Request_Header: []
1797 tags:
1798 - search/organization
1799 '/search/organization/suggest':
1800 get:
1801 operationId: getSearchOrganizationSuggest
1820 - Request_Header: []
1821 tags:
1822 - search/organization
1823components:
1824 parameters:
1825 id:
22servers:
23 - description: Production
24 url: https://api.deutsche-digitale-bibliothek.de/
25 - description: Testing Q1
26 url: https://api-q1.deutsche-digitale-bibliothek.de/
27 - description: Development (FIZ Karlsruhe)
24 url: https://api.deutsche-digitale-bibliothek.de/
25 - description: Testing Q1
26 url: https://api-q1.deutsche-digitale-bibliothek.de/
27 - description: Development (FIZ Karlsruhe)
28 url: https://dev-ddb.fiz-karlsruhe.de/api/
29paths:
26 url: https://api-q1.deutsche-digitale-bibliothek.de/
27 - description: Development (FIZ Karlsruhe)
28 url: https://dev-ddb.fiz-karlsruhe.de/api/
29paths:
30 '/binary/{uuid}':
31 get:
213 get:
214 operationId: getInstitutionMapCluster
215 summary: Not implemented.
216 description: This is not implemented.
217 deprecated: true
218 parameters:
266 get:
267 operationId: getItemsIdAip
268 summary: Returns the Archive Information Package (AIP) of a DDB item
269 description: |
270 An AIP contains all available information of an item including a persistent identifier. All AIPs consist of the following components: *binaries*, *children*, *edm*, *indexing-profile*, *parent*, *source* and *view*.
271 deprecated: true
266 get:
267 operationId: getItemsIdAip
268 summary: Returns the Archive Information Package (AIP) of a DDB item
269 description: |
270 An AIP contains all available information of an item including a persistent identifier. All AIPs consist of the following components: *binaries*, *children*, *edm*, *indexing-profile*, *parent*, *source* and *view*.
271 deprecated: true
511 responses:
512 '200':
513 description: Success.
514 content:
515 application/xml:
516 schema:
1352 - spell_check
1353 - sort_field
1354 description: Name of the facet which should be searched.
1355 # Inherit from /search/person
1356 - $ref: '#/components/parameters/search_query'
1357 - $ref: '#/components/parameters/search_person_facet'
1673 - spell_check
1674 - sort_field
1675 description: Name of the facet which should be searched.
1676 # Inherit from /search/organization
1677 - $ref: '#/components/parameters/search_query'
1678 - $ref: '#/components/parameters/search_organization_facet'
2150 schema:
2151 type: string
2152 description: |
2153 If *objecttype_fct* is selected in `facet` then this query parameter should have a query value.
2154 search_provider_fct:
2155 in: query
2848 schema:
2849 type: string
2850 description: |
2851 If *id* is selected in `facet` then this query parameter should have a query value.
2852 search_person_preferredName:
2853 in: query
3023 schema:
3024 type: string
3025 description: |
3026 If *suggest_field* is selected in `facet` then this query parameter should have a query value.
3027 search_person_wildcard_fulltext:
3028 in: query
3037 schema:
3038 type: string
3039 description: |
3040 If *last_update* is selected in `facet` then this query parameter should have a query value.
3041 search_person_spell_check:
3042 in: query
3044 schema:
3045 type: string
3046 description: |
3047 If *spell_check* is selected in `facet` then this query parameter should have a query value.
3048 search_person_sort_field:
3049 in: query
3051 schema:
3052 type: string
3053 description: |
3054 If *sort_field* is selected in `facet` then this query parameter should have a query value.
3055 search_organization_facet:
3056 in: query
3173 schema:
3174 type: string
3175 description: |
3176 If *id* is selected in `facet` then this query parameter should have a query value.
3177 search_organization_variant_id:
3178 in: query
3180 schema:
3181 type: string
3182 description: |
3183 If *variant_id* is selected in `facet` then this query parameter should have a query value.
3184 search_organization_ddb_organization_id:
3185 in: query
3194 schema:
3195 type: string
3196 description: |
3197 If *thumbnail* is selected in `facet` then this query parameter should have a query value.
3198 search_organization_type:
3199 in: query
3201 schema:
3202 type: string
3203 description: |
3204 If *type* is selected in `facet` then this query parameter should have a query value.
3205 search_organization_count:
3206 in: query
3208 schema:
3209 type: string
3210 description: |
3211 If *count* is selected in `facet` then this query parameter should have a query value.
3212 search_organization_count_sec_01:
3213 in: query
3215 schema:
3216 type: string
3217 description: |
3218 If *count_sec_01* is selected in `facet` then this query parameter should have a query value.
3219 search_organization_count_sec_02:
3220 in: query
3222 schema:
3223 type: string
3224 description: |
3225 If *count_sec_02* is selected in `facet` then this query parameter should have a query value.
3226 search_organization_count_sec_03:
3227 in: query
3229 schema:
3230 type: string
3231 description: |
3232 If *count_sec_03* is selected in `facet` then this query parameter should have a query value.
3233 search_organization_count_sec_04:
3234 in: query
3236 schema:
3237 type: string
3238 description: |
3239 If *count_sec_04* is selected in `facet` then this query parameter should have a query value.
3240 search_organization_count_sec_05:
3241 in: query
3243 schema:
3244 type: string
3245 description: |
3246 If *count_sec_05* is selected in `facet` then this query parameter should have a query value.
3247 search_organization_count_sec_06:
3248 in: query
3250 schema:
3251 type: string
3252 description: |
3253 If *count_sec_06* is selected in `facet` then this query parameter should have a query value.
3254 search_organization_count_sec_07:
3255 in: query
3257 schema:
3258 type: string
3259 description: |
3260 If *count_sec_07* is selected in `facet` then this query parameter should have a query value.
3261 search_organization_label:
3262 in: query
3264 schema:
3265 type: string
3266 description: |
3267 If *label* is selected in `facet` then this query parameter should have a query value.
3268 search_organization_description:
3269 in: query
3271 schema:
3272 type: string
3273 description: |
3274 If *description* is selected in `facet` then this query parameter should have a query value.
3275 search_organization_subsector_fct:
3276 in: query
3285 schema:
3286 type: string
3287 description: |
3288 If *sector_fct* is selected in `facet` then this query parameter should have a query value.
3289 search_organization_topic_fct:
3290 in: query
3292 schema:
3293 type: string
3294 description: |
3295 If *topic_fct* is selected in `facet` then this query parameter should have a query value.
3296 search_organization_state_fct:
3297 in: query
3299 schema:
3300 type: string
3301 description: |
3302 If *state_fct* is selected in `facet` then this query parameter should have a query value.
3303 search_organization_city_fct:
3304 in: query
3348 schema:
3349 type: string
3350 description: |
3351 If *preferredName* is selected in `facet` then this query parameter should have a query value.
3352 search_organization_variantName:
3353 in: query
3355 schema:
3356 type: string
3357 description: |
3358 If *variantName* is selected in `facet` then this query parameter should have a query value.
3359 search_organization_topic:
3360 in: query
3418 schema:
3419 type: string
3420 description: |
3421 If *revision_id* is selected in `facet` then this query parameter should have a query value.
3422 search_organization_dataset_id:
3423 in: query
3425 schema:
3426 type: string
3427 description: |
3428 If *dataset_id* is selected in `facet` then this query parameter should have a query value.
3429 search_organization_atoz:
3430 in: query
3439 schema:
3440 type: string
3441 description: |
3442 If *subsector* is selected in `facet` then this query parameter should have a query value.
3443 search_organization_hasItems:
3444 in: query
3446 schema:
3447 type: string
3448 description: |
3449 If *hasItems* is selected in `facet` then this query parameter should have a query value.
3450 search_organization_geocode:
3451 in: query
3453 schema:
3454 type: string
3455 description: |
3456 If *geocode* is selected in `facet` then this query parameter should have a query value.
3457 search_organization_geocode_0_coordinate:
3458 in: query
3460 schema:
3461 type: string
3462 description: |
3463 If *geocode_0_coordinate* is selected in `facet` then this query parameter should have a query value.
3464 search_organization_geocode_1_coordinate:
3465 in: query
3467 schema:
3468 type: string
3469 description: |
3470 If *geocode_1_coordinate* is selected in `facet` then this query parameter should have a query value.
3471 search_organization_location_display_name:
3472 in: query
3495 schema:
3496 type: string
3497 description: |
3498 If *suggest_field* is selected in `facet` then this query parameter should have a query value.
3499 search_organization_wildcard_fulltext:
3500 in: query
3502 schema:
3503 type: string
3504 description: |
3505 If *wildcard_fulltext* is selected in `facet` then this query parameter should have a query value.
3506 search_organization_last_update:
3507 in: query
3509 schema:
3510 type: string
3511 description: |
3512 If *last_update* is selected in `facet` then this query parameter should have a query value.
3513 search_organization_spell_check:
3514 in: query
3516 schema:
3517 type: string
3518 description: |
3519 If *spell_check* is selected in `facet` then this query parameter should have a query value.
3520 search_organization_sort_field:
3521 in: query
3523 schema:
3524 type: string
3525 description: |
3526 If *sort_field* is selected in `facet` then this query parameter should have a query value.
3527 type:
3528 in: query
3548 responses:
3549 '200':
3550 description: Success.
3551 content:
3552 'application/xml':
3553 schema:
3560 type: object
3561 '200-rdfxml':
3562 description: Success.
3563 content:
3564 'application/rdf+xml':
3565 schema:
3569 type: object
3570 '200-jsononly':
3571 description: Success.
3572 content:
3573 'application/json':
3574 schema:
3538 Facet type. If not selected all facets will be delivered.
3539 uuid:
3540 in: path
3541 name: uuid
3542 required: true
3543 schema:
3538 Facet type. If not selected all facets will be delivered.
3539 uuid:
3540 in: path
3541 name: uuid
3542 required: true
3543 schema:
47 content:
48 application/octet-stream:
49 schema:
50 type: object
51 '*/*':
52 schema:
50 type: object
51 '*/*':
52 schema:
53 type: object
54 '403':
55 $ref: '#/components/responses/403'
111 | *sec_06* | Museum | http://ddb.vocnet.org/sparte/sparte006 |
112 | *sec_07* | Other | http://ddb.vocnet.org/sparte/sparte007 |
113 schema:
114 type: string
115 enum:
116 - sec_01
171 name: offset
172 required: false
173 schema:
174 type: integer
175 format: int32
176 default: 0
180 name: length
181 required: false
182 schema:
183 type: integer
184 format: int32
185 default: -1
220 name: zoomlevel
221 required: false
222 schema:
223 type: string
224 description: Not implemented.
225 responses:
348 required: false
349 description: EDM data can have different metadata profiles. DDB API can deliver DDB Linked Data profile in any case and in some cases Europeana EDM profile.
350 schema:
351 type: string
352 default: https://www.deutsche-digitale-bibliothek.de/ns/ddb-linkedData-profile
353 enum:
504 description: |
505 Returns the subcomponent `description` or `record` of the component `source`.
506 schema:
507 type: string
508 enum:
509 - record
514 content:
515 application/xml:
516 schema:
517 type: object
518 '303':
519 description: See Other. If the `source/record` is part of an the root DDB item. This only occurs, if the source is a hierarchical data format, like METS/MODS, METS/TEI, EAD(DDB), which won't or can't be split during the ingest process at DDB.
540 name: defaultOperator
541 description: Specifies the default operator for query expressions, overriding the default operator specified in the Solr schema.
542 schema:
543 type: string
544 nullable: true
545 enum:
819 name: facetName
820 required: true
821 schema:
822 type: string
823 enum:
824 - affiliate_fct
918 name: query
919 required: false
920 schema:
921 type: string
922 description: Term(s) to be searched in the selected facet. This must be compliant to the Solr Query Syntax.
923 # Inherit from /search
1073 name: indexname
1074 required: true
1075 schema:
1076 type: string
1077 enum:
1078 - search
1093 name: requesthandler
1094 required: true
1095 schema:
1096 type: string
1097 enum:
1098 - select
1109 name: q
1110 required: false
1111 schema:
1112 type: string
1113 nullable: true
1114 default: '*:*'
1148 in: query
1149 required: false
1150 schema:
1151 type: array
1152 items:
1153 type: string
1319 name: facetName
1320 required: true
1321 schema:
1322 type: string
1323 enum:
1324 - id
1490 content:
1491 '*/*':
1492 schema:
1493 type: string
1494 '403':
1495 $ref: '#/components/responses/403'
1619 name: facetName
1620 required: true
1621 schema:
1622 type: string
1623 enum:
1624 - id
1827 name: id
1828 required: true
1829 schema:
1830 type: string
1831 maxLength: 32
1832 minLength: 32
1837 name: query
1838 required: true
1839 schema:
1840 type: string
1841 nullable: true
1842 default: '*'
1847 name: facet
1848 required: false
1849 schema:
1850 type: array
1851 items:
1852 type: string
2043 in: query
2044 name: affiliate_fct
2045 schema:
2046 type: string
2047 description: |
2048 If *affiliate_fct* is selected in `facet` then this query parameter should have a query value.
2113 in: query
2114 name: digitalisattype_fct
2115 schema:
2116 type: string
2117 description: |
2118 If *digitalisattype_fct* is selected in `facet` then this query parameter should have a query value.
2120 in: query
2121 name: keywords_fct
2122 schema:
2123 type: string
2124 description: |
2125 If *keywords_fct* is selected in `facet` then this query parameter should have a query value.
2127 in: query
2128 name: language_fct
2129 schema:
2130 type: string
2131 description: |
2132 If *language_fct* is selected in `facet` then this query parameter should have a query value.
2134 in: query
2135 name: mimetype_fct
2136 schema:
2137 type: string
2138 description: |
2139 If *mimetype_fct* is selected in `facet` then this query parameter should have a query value.
2141 in: query
2142 name: objecttype_fct
2143 schema:
2144 type: string
2145 description: |
2146 If *objecttype_fct* is selected in `facet` then this query parameter should have a query value.
2148 in: query
2149 name: place_fct
2150 schema:
2151 type: string
2152 description: |
2153 If *objecttype_fct* is selected in `facet` then this query parameter should have a query value.
2155 in: query
2156 name: provider_fct
2157 schema:
2158 type: string
2159 description: |
2160 If *provider_fct* is selected in `facet` then this query parameter should have a query value.
2162 in: query
2163 name: sector_fct
2164 schema:
2165 type: string
2166 description: |
2167 If *sector_fct* is selected in `facet` then this query parameter should have a query value.
2169 in: query
2170 name: state_fct
2171 schema:
2172 type: string
2173 description: |
2174 If *state_fct* is selected in `facet` then this query parameter should have a query value.
2176 in: query
2177 name: time_begin_fct
2178 schema:
2179 type: string
2180 description: |
2181 If *time_begin_fct* is selected in `facet` then this query parameter should have a query value.
2183 in: query
2184 name: time_end_fct
2185 schema:
2186 type: string
2187 description: |
2188 If *time_end_fct* is selected in `facet` then this query parameter should have a query value.
2190 in: query
2191 name: time_fct
2192 schema:
2193 type: string
2194 description: |
2195 If *time_fct* is selected in `facet` then this query parameter should have a query value.
2197 in: query
2198 name: topic_fct
2199 schema:
2200 type: string
2201 description: |
2202 If *topic_fct* is selected in `facet` then this query parameter should have a query value.
2204 in: query
2205 name: type_fct
2206 schema:
2207 type: string
2208 enum:
2209 - '001'
2239 in: query
2240 name: affiliate_fct_involved
2241 schema:
2242 type: string
2243 description: |
2244 If *affiliate_fct_involved* is selected in `facet` then this query parameter should have a query value.
2246 in: query
2247 name: affiliate_fct_subject
2248 schema:
2249 type: string
2250 description: |
2251 If *affiliate_fct_subject* is selected in `facet` then this query parameter should have a query value.
2253 in: query
2254 name: aggregation_field
2255 schema:
2256 type: string
2257 description: |
2258 If *aggregation_field* is selected in `facet` then this query
2261 in: query
2262 name: aggregator_id
2263 schema:
2264 type: string
2265 description: |
2266 If *aggregator_id* is selected in `facet` then this query parameter should have a query value.
2268 in: query
2269 name: apd_abstracts
2270 schema:
2271 type: string
2272 description: |
2273 If *apd_abstracts* is selected in `facet` then this query parameter should have a query value.
2275 in: query
2276 name: apd_context
2277 schema:
2278 type: string
2279 description: |
2280 If *apd_context* is selected in `facet` then this query parameter should have a query value.
2282 in: query
2283 name: apd_document_type
2284 schema:
2285 type: string
2286 description: |
2287 If *apd_document_type* is selected in `facet` then this query
2290 in: query
2291 name: apd_keywords
2292 schema:
2293 type: string
2294 description: |
2295 If *apd_keywords* is selected in `facet` then this query parameter should have a query value.
2297 in: query
2298 name: apd_level_of_description
2299 schema:
2300 type: string
2301 description: |
2302 If *apd_level_of_description* is selected in `facet` then this query parameter should have a query value.
2304 in: query
2305 name: apd_material
2306 schema:
2307 type: string
2308 description: |
2309 If *apd_material* is selected in `facet` then this query parameter should have a query value.
2311 in: query
2312 name: apd_provenance
2313 schema:
2314 type: string
2315 description: |
2316 If *apd_provenance* is selected in `facet` then this query parameter should have a query value.
2318 in: query
2319 name: apd_reference_number
2320 schema:
2321 type: string
2322 description: |
2323 If *apd_reference_number* is selected in `facet` then this query parameter should have a query value.
2325 in: query
2326 name: apd_subject
2327 schema:
2328 type: string
2329 description: |
2330 If *apd_subject* is selected in `facet` then this query parameter should have a query value.
2332 in: query
2333 name: apd_xml_sort
2334 schema:
2335 type: string
2336 description: |
2337 If *apd_xml_sort* is selected in `facet` then this query parameter should have a query value.
2339 in: query
2340 name: atoz
2341 schema:
2342 type: string
2343 description: |
2344 If *atoz* is selected in `facet` then this query parameter should have
2347 in: query
2348 name: begin_time
2349 schema:
2350 type: string
2351 description: |
2352 If *begin_time* is selected in `facet` then this query parameter should have a query value.
2354 in: query
2355 name: category
2356 schema:
2357 type: string
2358 description: |
2359 If *category* is selected in `facet` then this query parameter should have a query value.
2361 in: query
2362 name: content
2363 schema:
2364 type: string
2365 description: |
2366 If *content* is selected in `facet` then this query parameter should have a query value.
2368 in: query
2369 name: context
2370 schema:
2371 type: string
2372 description: |
2373 If *context* is selected in `facet` then this query parameter should have a query value.
2375 in: query
2376 name: dataset_id
2377 schema:
2378 type: string
2379 description: |
2380 If *dataset_id* is selected in `facet` then this query parameter should have a query value.
2382 in: query
2383 name: dataset_label
2384 schema:
2385 type: string
2386 description: |
2387 If *dataset_label* is selected in `facet` then this query parameter should have a query value.
2389 in: query
2390 name: description
2391 schema:
2392 type: string
2393 description: |
2394 If *description* is selected in `facet` then this query parameter should have a query value.
2396 in: query
2397 name: digitalCopyType
2398 schema:
2399 type: string
2400 description: |
2401 If *digitalCopyType* is selected in `facet` then this query parameter should have a query value.
2403 in: query
2404 name: digitalisat
2405 schema:
2406 type: string
2407 description: |
2408 If *digitalisat* is selected in `facet` then this query parameter should have a query value.
2410 in: query
2411 name: end_time
2412 schema:
2413 type: string
2414 description: |
2415 If *end_time* is selected in `facet` then this query parameter should have a query value.
2417 in: query
2418 name: fulltext
2419 schema:
2420 type: string
2421 description: |
2422 If *fulltext* is selected in `facet` then this query parameter should have a query value.
2424 in: query
2425 name: fulltext_search
2426 schema:
2427 type: string
2428 description: |
2429 If *fulltext_search* is selected in `facet` then this query parameter should have a query value.
2431 in: query
2432 name: geocode
2433 schema:
2434 type: string
2435 description: |
2436 If *geocode* is selected in `facet` then this query parameter should have a query value.
2438 in: query
2439 name: geocode_0_coordinate
2440 schema:
2441 type: string
2442 description: |
2443 If *geocode_0_coordinate* is selected in `facet` then this query parameter should have a query value.
2445 in: query
2446 name: geocode_1_coordinate
2447 schema:
2448 type: string
2449 description: |
2450 If *geocode_1_coordinate* is selected in `facet` then this query parameter should have a query value.
2452 in: query
2453 name: grid_preview
2454 schema:
2455 type: string
2456 description: |
2457 If *grid_preview* is selected in `facet` then this query parameter should have a query value.
2459 in: query
2460 name: hasItems
2461 schema:
2462 type: string
2463 description: |
2464 If *hasItems* is selected in `facet` then this query parameter should have a query value.
2466 in: query
2467 name: id
2468 schema:
2469 type: string
2470 description: |
2471 If *id* is selected in `facet` then this query parameter should have a query value.
2473 in: query
2474 name: ingest_id
2475 schema:
2476 type: string
2477 description: |
2478 If *ingest_id* is selected in `facet` then this query parameter should have a query value.
2480 in: query
2481 name: institution_name
2482 schema:
2483 type: string
2484 description: |
2485 If *institution_name* is selected in `facet` then this query parameter should have a query value.
2494 in: query
2495 name: label
2496 schema:
2497 type: string
2498 description: |
2499 If *label* is selected in `facet` then this query parameter should have a query value.
2508 in: query
2509 name: last_update
2510 schema:
2511 type: string
2512 description: |
2513 If *last_update* is selected in `facet` then this query parameter should have a query value.
2515 in: query
2516 name: license
2517 schema:
2518 type: string
2519 description: |
2520 If *license* is selected in `facet` then this query parameter should have a query value.
2522 in: query
2523 name: license_group
2524 schema:
2525 type: string
2526 description: |
2527 If *license_group* is selected in `facet` then this query parameter should have a query value.
2529 in: query
2530 name: mapping_version
2531 schema:
2532 type: string
2533 description: |
2534 If *mapping_version* is selected in `facet` then this query parameter should have a query value.
2536 in: query
2537 name: md_format
2538 schema:
2539 type: string
2540 description: |
2541 If *md_format* is selected in `facet` then this query parameter should have a query value.
2557 in: query
2558 name: preview
2559 schema:
2560 type: string
2561 description: |
2562 If *preview* is selected in `facet` then this query parameter should have a query value.
2564 in: query
2565 name: preview_store
2566 schema:
2567 type: string
2568 description: |
2569 If *preview_store* is selected in `facet` then this query parameter should have a query value.
2578 in: query
2579 name: provider_id
2580 schema:
2581 type: string
2582 description: |
2583 If *provider_id* is selected in `facet` then this query parameter should have a query value.
2585 in: query
2586 name: ranking
2587 schema:
2588 type: string
2589 description: |
2590 If *ranking* is selected in `facet` then this query parameter should have a query value.
2592 in: query
2593 name: revision_id
2594 schema:
2595 type: string
2596 description: |
2597 If *revision_id* is selected in `facet` then this query parameter should have a query value.
2606 in: query
2607 name: signature
2608 schema:
2609 type: string
2610 description: |
2611 If *signature* is selected in `facet` then this query parameter should have a query value.
2613 in: query
2614 name: sort_field
2615 schema:
2616 type: string
2617 description: |
2618 If *sort_field* is selected in `facet` then this query parameter should have a query value.
2620 in: query
2621 name: source_format
2622 schema:
2623 type: string
2624 description: |
2625 If *source_format* is selected in `facet` then this query parameter should have a query value.
2627 in: query
2628 name: spell_check
2629 schema:
2630 type: string
2631 description: |
2632 If *spell_check* is selected in `facet` then this query parameter should have a query value.
2641 in: query
2642 name: subsector
2643 schema:
2644 type: string
2645 description: |
2646 If *subsector* is selected in `facet` then this query parameter should have a query value.
2648 in: query
2649 name: suggest_field
2650 schema:
2651 type: string
2652 description: |
2653 If *suggest_field* is selected in `facet` then this query parameter should have a query value.
2655 in: query
2656 name: suggest_field_apd
2657 schema:
2658 type: string
2659 description: |
2660 If *suggest_field_apd* is selected in `facet` then this query parameter should have a query value.
2662 in: query
2663 name: supplier_id
2664 schema:
2665 type: string
2666 description: |
2667 If *supplier_id* is selected in `facet` then this query parameter should have a query value.
2676 in: query
2677 name: title
2678 schema:
2679 type: string
2680 description: |
2681 If *title* is selected in `facet` then this query parameter should have a query value.
2690 in: query
2691 name: tp_category_id
2692 schema:
2693 type: string
2694 description: |
2695 If *tp_category_id* is selected in `facet` then this query parameter should have a query value.
2704 in: query
2705 name: view
2706 schema:
2707 type: string
2708 description: |
2709 If *view* is selected in `facet` then this query parameter should have a query value.
2712 name: facet.limit
2713 required: false
2714 schema:
2715 type: integer
2716 format: int32
2717 minimum: 0
2722 name: minDocs
2723 required: false
2724 schema:
2725 type: integer
2726 format: int32
2727 minimum: 0
2733 name: offset
2734 required: false
2735 schema:
2736 type: integer
2737 format: int32
2738 minimum: 0
2743 name: rows
2744 required: false
2745 schema:
2746 type: integer
2747 format: int32
2748 minimum: 0
2755 name: sort
2756 required: false
2757 schema:
2758 type: string
2759 description: |
2760 Defines the sorting order, which can be one of the following values. It requires the query parameter, otherwise the sort is always `random_<a_random_seed>`.
2767 name: cursorMark
2768 required: false
2769 schema:
2770 type: string
2771 description: |
2772 [Solr deep paging](https://lucene.apache.org/solr/guide/8_5/pagination-of-results.html). Pass `*` to start the first request.