{"openapi":"3.1.0","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"https://disscover.dissco.eu","description":"Generated server url"}],"paths":{"/virtual-collection/v1":{"get":{"tags":["virtual-collection-controller"],"summary":"Get paginated virtual collections","operationId":"getVirtualCollections","parameters":[{"name":"pageNumber","in":"query","description":"Desired page number","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Desired page size","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Virtual Collections successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualCollectionResponseList"}}}}}},"post":{"tags":["virtual-collection-controller"],"summary":"Create virtual collection","description":"Creates a new virtual collection. Only users who have registered their ORCID may create annotations.\n","operationId":"createVirtualCollection","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualCollectionRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"201":{"description":"Virtual Collection successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualCollectionResponseSingle"}}}}}}},"/digital-specimen/v1/{prefix}/{suffix}/mas":{"get":{"tags":["digital-specimen-controller"],"summary":"Get MASs that may be run on the given digital specimen","description":"Retrieves a list of Machine Annotation Services (MASs) suitable for processing a given\ndigital specimen, based on the MASs' respective filter criteria.\n","operationId":"getMassForDigitalSpecimen","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Digital media MASs successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationResponseList"}}}}}},"post":{"tags":["digital-specimen-controller"],"summary":"Schedule Machine Annotation Services","description":"Schedules applicable MASs on a given digital media.\nOnly users who have provided their ORCID may schedule MASs.\n","operationId":"scheduleMassForDigitalSpecimen","parameters":[{"name":"prefix","in":"path","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MasSchedulingRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"MAS successfully scheduled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MjrResponseList"}}}}}}},"/digital-media/v1/{prefix}/{suffix}/mas":{"get":{"tags":["digital-media-controller"],"summary":"Get MASs that may be run on the given digital media","description":"Retrieves a list of Machine Annotation Services (MASs) suitable for processing a given\ndigital media, based on the MASs' respective filter criteria.\n","operationId":"getMassForDigitalMediaObject","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Digital media MASs successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationResponseList"}}}}}},"post":{"tags":["digital-media-controller"],"summary":"Schedule Machine Annotation Services","description":"Schedules applicable MASs on a given digital media.\nOnly users who have provided their ORCID may schedule MASs.\n","operationId":"scheduleMassForDigitalMediaObject","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MasSchedulingRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"409":{"description":"Conflict","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"202":{"description":"MAS successfully scheduled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MjrResponseList"}}}}}}},"/annotation/v1":{"get":{"tags":["annotation-controller"],"summary":"Get annotations, paginated","operationId":"getAnnotations","parameters":[{"name":"pageNumber","in":"query","description":"Desired page number","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Desired page size","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Annotations retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationResponseList"}}}}}},"post":{"tags":["annotation-controller"],"summary":"Create annotation","description":"Create an annotation on a digital specimen or digital media. Only users who have\nregistered their ORCID may create annotations.\n","operationId":"createAnnotation","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"201":{"description":"Annotation successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationResponseSingle"}}}}}}},"/annotation/v1/batch":{"get":{"tags":["annotation-controller"],"summary":"Given a set of search parameters, calculates how many objects would be annotated in a batch annotation event","description":"Given a set of search parameters, calculates how many objects would be annotated in a batch annotation event.\nThis is a prerequisite for applying batch annotations. This can only be requested by users with the \"batch annotations\" permission.\n","operationId":"getCountForBatchAnnotations","requestBody":{"description":"Annotation adhering to JSON:API standard","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAnnotationCountRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Projected Annotation count calculated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAnnotationCountResponse"}}}}}},"post":{"tags":["annotation-controller"],"summary":"Apply an annotation to all objects that match a given criteria","description":"Given a set of search parameters, applies an annotation to all objects that match this criteria.\nThe first annotation created, which is the annotation on the provided target, is returned.\nSubsequent annotations are scheduled. This is only possible for users with the \"batch annotations\" permission.\n","operationId":"createAnnotationBatch","requestBody":{"description":"Annotation batch request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchAnnotationRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"201":{"description":"Batching scheduled; initial annotation returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationResponseSingle"}}}}}}},"/virtual-collection/v1/{prefix}/{suffix}":{"get":{"tags":["virtual-collection-controller"],"summary":"Get latest virtual collection by id","operationId":"getVirtualCollectionById","parameters":[{"name":"prefix","in":"path","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Virtual Collection successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualCollectionResponseSingle"}}}}}},"delete":{"tags":["virtual-collection-controller"],"summary":"Tombstone a given virtual collection","description":"Tombstone a given virtual collection. Users may only tombstone virtual collections they created.\n","operationId":"tombstoneVirtualCollection","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"204":{"description":"Virtual Collection successfully tombstoned"}}},"patch":{"tags":["virtual-collection-controller"],"summary":"Update existing virtual collection","description":"Update an existing virtual collection. Users may only update virtual collection they have created.\n","operationId":"updateVirtualCollection","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualCollectionRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Virtual Collection successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualCollectionResponseSingle"}}}}}}},"/annotation/v1/{prefix}/{suffix}":{"get":{"tags":["annotation-controller"],"summary":"Get annotation by id","operationId":"getAnnotation","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Annotation retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationResponseSingle"}}}}}},"delete":{"tags":["annotation-controller"],"summary":"Tombstone a given annotation","description":"Tombstone a given annotation. Users may only tombstone annotations they created.\n","operationId":"tombstoneAnnotation","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"204":{"description":"Annotation successfully tombstoned"}}},"patch":{"tags":["annotation-controller"],"summary":"Update existing annotation","description":"Update an existing annotation. Users may only update annotations they have created.\n","operationId":"updateAnnotation","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Annotation successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationResponseSingle"}}}}}}},"/virtual-collection/v1/{prefix}/{suffix}/{version}":{"get":{"tags":["virtual-collection-controller"],"summary":"Get virtual collection by ID and desired version","operationId":"getVirtualCollectionByVersion","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","description":"Desired version","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Virtual Collection successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualCollectionResponseSingle"}}}}}}},"/virtual-collection/v1/{prefix}/{suffix}/versions":{"get":{"tags":["virtual-collection-controller"],"summary":"Get all versions for a given virtual collection","operationId":"getVirtualCollectionVersions","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Virtual Collection versions successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionResponse"}}}}}}},"/virtual-collection/v1/creator":{"get":{"tags":["virtual-collection-controller"],"summary":"Get paginated virtual collections for an authenticated user","operationId":"getVirtualCollectionsForUser","parameters":[{"name":"pageNumber","in":"query","description":"Desired page number","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Desired page size","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Virtual collections successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VirtualCollectionResponseList"}}}}}}},"/mjr/v1/{masIdPrefix}/{masIdSuffix}/{jobIdPrefix}/{jobIdSuffix}/running":{"get":{"tags":["mas-job-record-controller"],"summary":"Mark job as running","description":"Utility function for Machine Annotation Services to update job status to \"running\".\n","operationId":"markMjrAsRunning","parameters":[{"name":"masIdPrefix","in":"path","description":"Prefix of ID of MAS","required":true,"schema":{"type":"string"}},{"name":"masIdSuffix","in":"path","description":"Suffix of ID of MAS","required":true,"schema":{"type":"string"}},{"name":"jobIdPrefix","in":"path","description":"Prefix of ID of Job","required":true,"schema":{"type":"string"}},{"name":"jobIdSuffix","in":"path","description":"Suffix of ID of Job","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"MAS Job Record successfully retrieved"}}}},"/mjr/v1/{jobIdPrefix}/{jobIdSuffix}":{"get":{"tags":["mas-job-record-controller"],"summary":"Get MAS Job Record by ID","description":"Retrieves record of running, scheduled, or completed Machine Annotation Service job\n","operationId":"getMasJobRecord","parameters":[{"name":"jobIdPrefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"jobIdSuffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"MAS Job Record successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MjrResponseSingle"}}}}}}},"/mjr/v1/creator":{"get":{"tags":["mas-job-record-controller"],"summary":"Get MAS Job Record by creator","description":"Retrieves record of running, scheduled, or completed Machine Annotation Service job\n","operationId":"getMasJobRecordsForCreator","parameters":[{"name":"pageNumber","in":"query","description":"Desired page number","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Desired page size","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"state","in":"query","description":"Optional filter on job status","required":false,"schema":{"type":"string","enum":["SCHEDULED","RUNNING","FAILED","COMPLETED","NOTIFICATION_FAILED","QUEUED"]}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"MAS Job Record successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MjrResponseList"}}}}}}},"/elvis/specimen/{prefix}/{suffix}":{"get":{"tags":["elvis-controller"],"summary":"Get specimen from DiSSCo DOI","description":"Given a DOI, retrieves specimen information according to ELViS parameters.\n","operationId":"getSpecimenByDoi","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"responses":{"404":{"description":"Not Found"},"200":{"description":"Specimen successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ElvisSpecimen"}}}}}}},"/elvis/specimen/suggest/inventoryNumber":{"get":{"tags":["elvis-controller"],"summary":"Searches DiSSCo specimens for relevant identifiers","description":"Searches DiSSCo specimens for relevant identifiers. The inputted searchValue is checked against the following ODS terms:\n- ods:physicalSpecimenId, the local collection number, which is mapped to catalogNumber in the response\n- dcterms:identifier, the DiSSCo DOI, which is mapped to inventoryNumber in the response\n\nThis endpoint searches both above fields for desired inputted value. It accepts partial matches, implementing a wildcard search.\nNote: When searching, do not include the DOI proxy (i.e. \"https://doi.org/\") in the input\n","operationId":"suggestInventoryNumber","parameters":[{"name":"searchValue","in":"query","description":"searchValue","required":true,"schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Desired page number","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Desired page size","required":false,"schema":{"type":"integer","format":"int32","default":20}}],"responses":{"404":{"description":"Not Found"},"400":{"description":"Bad Request"},"200":{"description":"Specimen successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InventoryNumberSuggestionResponse"}}}}}}},"/digital-specimen/v1":{"get":{"tags":["digital-specimen-controller"],"summary":"Get paginated digital specimen","operationId":"getSpecimen","parameters":[{"name":"pageNumber","in":"query","description":"Desired page number","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Desired page size","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Digital specimens successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalSpecimenResponseList"}}}}}}},"/digital-specimen/v1/{prefix}/{suffix}":{"get":{"tags":["digital-specimen-controller"],"summary":"Get digital specimen by ID","operationId":"getSpecimenById","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Digital specimen successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalSpecimenResponseSingle"}}}}}}},"/digital-specimen/v1/{prefix}/{suffix}/{version}":{"get":{"tags":["digital-specimen-controller"],"summary":"Get digital specimen by ID and version","operationId":"getSpecimenByVersion","parameters":[{"name":"prefix","in":"path","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Digital specimen successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalSpecimenResponseSingle"}}}}}}},"/digital-specimen/v1/{prefix}/{suffix}/{version}/full":{"get":{"tags":["digital-specimen-controller"],"summary":"Get full digital specimen by ID and version","description":"Returns full version of a given digital specimen, including digital media associated with the specimen and annotations.\n","operationId":"getSpecimenByVersionFull","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Digital specimen successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalSpecimenResponseFull"}}}}}}},"/digital-specimen/v1/{prefix}/{suffix}/versions":{"get":{"tags":["digital-specimen-controller"],"summary":"Get all versions for a given digital specimen","operationId":"getSpecimenVersions","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Digital specimen versions successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionResponse"}}}}}}},"/digital-specimen/v1/{prefix}/{suffix}/original-data":{"get":{"tags":["digital-specimen-controller"],"summary":"Get original digital media data","description":"DiSSCo provides harmonised data according to the OpenDS specification.\nThis endpoint provides the unharmonised data as it appears in the source system.\n","operationId":"getOriginalDataForSpecimen","parameters":[{"name":"prefix","in":"path","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Original Data successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonApiWrapper"}}}}}}},"/digital-specimen/v1/{prefix}/{suffix}/mjr":{"get":{"tags":["digital-specimen-controller"],"summary":"Get MAS jobs for digital media","description":"Retrieves a list of Machine Annotation Service Job Records (MJRs).\nThese are scheduled, running, or completed machine annotation service jobs.\nPagination is offered.\n","operationId":"getMasJobRecordsForSpecimen","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}},{"name":"state","in":"query","description":"Optional filter on job status","required":false,"schema":{"type":"string","enum":["SCHEDULED","RUNNING","FAILED","COMPLETED","NOTIFICATION_FAILED","QUEUED"]}},{"name":"pageNumber","in":"query","description":"Desired page number","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Desired page size","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"MAS Job records successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MjrResponseList"}}}}}}},"/digital-specimen/v1/{prefix}/{suffix}/full":{"get":{"tags":["digital-specimen-controller"],"summary":"Get full digital specimen by ID","description":"Returns full version of a given digital specimen, including digital media associated with the specimen and annotations.\n","operationId":"getSpecimenByIdFull","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Digital specimen successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalSpecimenResponseFull"}}}}}}},"/digital-specimen/v1/{prefix}/{suffix}/digital-media":{"get":{"tags":["digital-specimen-controller"],"summary":"Get digital media for a given digital specimen","operationId":"getSpecimenDigitalMedia","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Digital specimen media successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalMediaResponseList"}}}}}}},"/digital-specimen/v1/{prefix}/{suffix}/annotations":{"get":{"tags":["digital-specimen-controller"],"summary":"Get annotations for a given digital specimen","operationId":"getSpecimenAnnotations","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Digital specimen annotations successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationResponseList"}}}}}}},"/digital-specimen/v1/taxonomy/aggregation":{"get":{"tags":["digital-specimen-controller"],"summary":"Aggregate digital specimens on taxonomy","description":"Accepts key-value pairs of terns to aggregate on.\n","operationId":"taxonAggregation","parameters":[{"name":"params","in":"query","description":"Taxonomic aggregation terms","required":true,"schema":{"$ref":"#/components/schemas/MultiValueMapStringString"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Taxonomic aggregations successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregationResponse"}}}}}}},"/digital-specimen/v1/search":{"get":{"tags":["digital-specimen-controller"],"summary":"Search for digital specimen","description":"The Specimen Search endpoint allows for comprehensive filtering using standard key-value pairs, a free-text search, and field existence checks.\n\n`1. Search for exact matches (with optional wildcard * support) using the following parameters:\n* country\n* countryCode\n* midsLevel\n* physicalSpecimenID\n* typeStatus\n* organisatonID\n* organisationName\n* sourceSystemID\n* sourceSystemName\n* specimenName\n* datasetName\n* collectionCode\n* identifiedBy\n* basisOfRecord\n* livingOrPreserved\n* habitat\n* virtualCollectionId\n\n2. Use the q parameter for a full-text search across various fields\n\n3. Filter results based on whether a specific field exists (true) or does not exist (false) on a specimen record\n* hasLongitude\n* hasKingdom\n* hasGenus\n* hasLocality\n* hasFamily\n* hasSpecies\n* hasOrder\n* hasClass\n* hasLatitude\n* hasPhylum\n* hasCountry\n\nAn example of all three types of queries: /search?q=Sabellaria+bellis&topicDiscipline=Zoology&midsLevel=1&hasCountry=true\n","operationId":"search","parameters":[{"name":"params","in":"query","description":"Search parameters","required":true,"schema":{"$ref":"#/components/schemas/MultiValueMapStringString"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Search results successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalSpecimenResponseList"}}}}}}},"/digital-specimen/v1/searchTermValue":{"get":{"tags":["digital-specimen-controller"],"summary":"Aggregate digital specimens using search terms","operationId":"searchTermValue","parameters":[{"name":"term","in":"query","description":"Term to search on","required":true,"schema":{"type":"string"}},{"name":"value","in":"query","description":"Value of term","required":true,"schema":{"type":"string"}},{"name":"sort","in":"query","description":"Whether or not to sort","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Aggregations successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregationResponse"}}}}}}},"/digital-specimen/v1/latest":{"get":{"tags":["digital-specimen-controller"],"summary":"Get latest paginated digital specimens","operationId":"getLatestSpecimen","parameters":[{"name":"pageNumber","in":"query","description":"Desired page number","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Desired page size","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Digital specimens successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalSpecimenResponseList"}}}}}}},"/digital-specimen/v1/discipline":{"get":{"tags":["digital-specimen-controller"],"summary":"Aggregate digital specimens on topic discipline","operationId":"discipline","responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Aggregations successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregationResponse"}}}}}}},"/digital-specimen/v1/aggregation":{"get":{"tags":["digital-specimen-controller"],"summary":"Aggregate digital specimens","description":"Accepts key-value pairs of terns to aggregate on. If no aggregation terms are set, returns\naggregations on all aggregatable terms.\n","operationId":"aggregation","parameters":[{"name":"params","in":"query","description":"Aggregation terms","required":true,"schema":{"$ref":"#/components/schemas/MultiValueMapStringString"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Aggregations successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AggregationResponse"}}}}}}},"/digital-media/v1":{"get":{"tags":["digital-media-controller"],"summary":"Get paginated digital media","operationId":"getDigitalMediaObjects","parameters":[{"name":"pageNumber","in":"query","description":"Prefix of target ID","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Suffix of target ID","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Digital media successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalMediaResponseList"}}}}}}},"/digital-media/v1/{prefix}/{suffix}":{"get":{"tags":["digital-media-controller"],"summary":"Get digital media by ID","operationId":"getDigitalMediaObjectById","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Digital media successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalMediaResponseSingle"}}}}}}},"/digital-media/v1/{prefix}/{suffix}/{version}":{"get":{"tags":["digital-media-controller"],"summary":"Get digital media by ID and desired version","operationId":"getDigitalMediaObjectByVersion","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","description":"Desired version","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Digital media successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DigitalMediaResponseSingle"}}}}}}},"/digital-media/v1/{prefix}/{suffix}/versions":{"get":{"tags":["digital-media-controller"],"summary":"Get all versions for a given digital media","operationId":"getDigitalMediaVersions","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Digital media versions successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionResponse"}}}}}}},"/digital-media/v1/{prefix}/{suffix}/original-data":{"get":{"tags":["digital-media-controller"],"summary":"Get original digital media data","description":"DiSSCo provides harmonised data according to the OpenDS specification.\nThis endpoint provides the unharmonised data as it appears in the source system.\n","operationId":"getOriginalDataForMedia","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Original Data successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonApiWrapper"}}}}}}},"/digital-media/v1/{prefix}/{suffix}/mjr":{"get":{"tags":["digital-media-controller"],"summary":"Get MAS jobs for digital media","description":"Retrieves a list of Machine Annotation Service Job Records (MJRs).\nThese are scheduled, running, or completed machine annotation service jobs.\nPagination is offered.\n","operationId":"getMasJobRecordForMedia","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}},{"name":"state","in":"query","description":"Optional filter on job status","required":false,"schema":{"type":"string","enum":["SCHEDULED","RUNNING","FAILED","COMPLETED","NOTIFICATION_FAILED","QUEUED"]}},{"name":"pageNumber","in":"query","description":"Desired page number","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Desired page size","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"MAS Job records successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MjrResponseList"}}}}}}},"/digital-media/v1/{prefix}/{suffix}/annotations":{"get":{"tags":["digital-media-controller"],"summary":"Get annotations for a given digital media","operationId":"getMediaAnnotationsById","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Digital media annotations successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationResponseList"}}}}}}},"/annotation/v1/{prefix}/{suffix}/{version}":{"get":{"tags":["annotation-controller"],"summary":"Get annotation by ID and desired version","operationId":"getAnnotationByVersion","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}},{"name":"version","in":"path","description":"Desired version","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Annotation successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationResponseSingle"}}}}}}},"/annotation/v1/{prefix}/{suffix}/versions":{"get":{"tags":["annotation-controller"],"summary":"Get all versions for a given annotation","operationId":"getAnnotationVersions","parameters":[{"name":"prefix","in":"path","description":"Prefix of target ID","required":true,"schema":{"type":"string"}},{"name":"suffix","in":"path","description":"Suffix of target ID","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Annotation versions successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VersionResponse"}}}}}}},"/annotation/v1/creator":{"get":{"tags":["annotation-controller"],"summary":"Get all annotations for an authenticated user","operationId":"getAnnotationsForUser","parameters":[{"name":"pageNumber","in":"query","description":"Desired page number","required":false,"schema":{"type":"integer","format":"int32","default":1}},{"name":"pageSize","in":"query","description":"Desired page size","required":false,"schema":{"type":"integer","format":"int32","default":10}}],"responses":{"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"422":{"description":"Unprocessable Entity","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"502":{"description":"Bad Gateway","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ExceptionResponseWrapper"}}}},"200":{"description":"Annotations successfully retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnotationResponseList"}}}}}}}},"components":{"schemas":{"ExceptionResponse":{"type":"object","properties":{"status":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"}}},"ExceptionResponseWrapper":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ExceptionResponse"}}}},"Agent":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string","enum":["schema:Person","schema:Organization","schema:SoftwareApplication","prov:Person","prov:SoftwareAgent"]},"schema:identifier":{"type":"string"},"schema:name":{"type":"string"},"ods:hasRoles":{"type":"array","items":{"$ref":"#/components/schemas/OdsHasRole"}},"schema:email":{"type":"string"},"schema:url":{"type":"string"},"ods:hasIdentifiers":{"type":"array","items":{"$ref":"#/components/schemas/Identifier"}}}},"Identifier":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string"},"dcterms:title":{"type":"string"},"dcterms:type":{"type":"string","enum":["ARK","arXiv","bibcode","DOI","EAN13","EISSN","Handle","IGSN","ISBN","ISSN","ISTC","LISSN","LSID","PMID","PURL","UPC","URL","URN","w3id","UUID","Other","Locally unique identifier"]},"dcterms:identifier":{"type":"string"},"dcterms:format":{"type":"array","items":{"type":"string"}},"dcterms:subject":{"type":"array","items":{"type":"string"}},"ods:isPartOfLabel":{"type":"boolean"},"ods:gupriLevel":{"type":"string","enum":["LocallyUniqueStable","GloballyUniqueStable","GloballyUniqueStableResolvable","GloballyUniqueStablePersistentResolvable","GloballyUniqueStablePersistentResolvableFDOCompliant"]},"ods:identifierStatus":{"type":"string","enum":["Preferred","Alternative","Superseded"]}}},"OdsHasPredicate":{"type":"object","properties":{"ods:predicateType":{"type":"string","enum":["equals","and","or","not","in"]},"ods:predicateKey":{"type":"string"},"ods:predicateValue":{},"ods:predicateValues":{"type":"array","items":{}}}},"OdsHasRelatedPID":{"type":"object","properties":{"@type":{"type":"string"},"dcterms:identifier":{"type":"string"},"schema:identifier":{"type":"string"},"ods:relationshipType":{"type":"string"}}},"OdsHasRole":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string"},"schema:roleName":{"type":"string"},"schema:startDate":{"type":"string"},"schema:endDate":{"type":"string"},"schema:position":{"type":"integer","format":"int32"}}},"TargetDigitalObjectFilter":{"type":"object","properties":{"ods:predicateType":{"type":"string","enum":["equals","and","or","not","in"]},"ods:predicateKey":{"type":"string"},"ods:predicateValue":{},"ods:predicateValues":{"type":"array","items":{}},"ods:hasPredicates":{"type":"array","items":{"$ref":"#/components/schemas/OdsHasPredicate"}}}},"TombstoneMetadata":{"type":"object","properties":{"@type":{"type":"string"},"ods:tombstoneDate":{"type":"string","format":"date-time"},"ods:tombstoneText":{"type":"string"},"ods:hasAgents":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}},"ods:hasRelatedPIDs":{"type":"array","items":{"$ref":"#/components/schemas/OdsHasRelatedPID"}}}},"VirtualCollectionRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/VirtualCollectionRequestData"}}},"VirtualCollectionRequestData":{"type":"object","properties":{"type":{"type":"string","description":"Type of request. For virtual collection, must be \"ods:VirtualCollection\"","enum":["https://doi.org/21.T11148/894b1e6cad57e921764e","https://doi.org/21.T11148/bbad8c4e101e8af01115","https://doi.org/21.T11148/cf458ca9ee1d44a5608f","https://doi.org/21.T11148/417a4f472f60f7974c12","https://doi.org/21.T11148/ce794a6f4df42eb7e77e","https://doi.org/21.T11148/a369e128df5ef31044d4","https://doi.org/21.T11148/2ac65a933b7a0361b651","https://doi.org/21.T11148/532ce6796e2828dd2be6"]},"attributes":{"$ref":"#/components/schemas/VirtualCollectionRequest","description":"Desired virtual collection"}}},"JsonApiLinks":{"type":"object","properties":{"self":{"type":"string"}}},"VirtualCollection":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string"},"dcterms:identifier":{"type":"string"},"ods:fdoType":{"type":"string"},"ods:status":{"type":"string","enum":["Draft","Active","Tombstone"]},"schema:version":{"type":"integer","format":"int32"},"ltc:collectionName":{"type":"string"},"ltc:description":{"type":"string"},"ltc:basisOfScheme":{"type":"string","enum":["Reference Collection","Community Collection"]},"schema:dateCreated":{"type":"string","format":"date-time"},"schema:dateModified":{"type":"string","format":"date-time"},"schema:contentURL":{"type":"string"},"schema:creator":{"$ref":"#/components/schemas/Agent"},"ods:hasTargetDigitalObjectFilter":{"$ref":"#/components/schemas/TargetDigitalObjectFilter"},"ods:hasTombstoneMetadata":{"$ref":"#/components/schemas/TombstoneMetadata"}}},"VirtualCollectionResponseData":{"type":"object","properties":{"id":{"type":"string","description":"Handle of the virtual collection"},"type":{"type":"string","description":"Type of the object, in this case \"ods:VirtualCollection\""},"attributes":{"$ref":"#/components/schemas/VirtualCollection","description":"Annotation"}}},"VirtualCollectionResponseSingle":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/JsonApiLinks","description":"Links object, self-referencing"},"data":{"$ref":"#/components/schemas/VirtualCollectionResponseData"}}},"MasJobRequest":{"type":"object","properties":{"masId":{"type":"string"},"batching":{"type":"boolean"}}},"MasSchedulingAttributes":{"type":"object","properties":{"mass":{"type":"array","items":{"$ref":"#/components/schemas/MasJobRequest"}}}},"MasSchedulingData":{"type":"object","properties":{"type":{"type":"string"},"attributes":{"$ref":"#/components/schemas/MasSchedulingAttributes"}}},"MasSchedulingRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MasSchedulingData"}}},"JsonApiLinksFull":{"type":"object","properties":{"self":{"type":"string"},"first":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"}}},"JsonApiMeta":{"type":"object","properties":{"totalRecords":{"type":"integer","format":"int64"}}},"MasJobRecord":{"type":"object","properties":{"jobId":{"type":"string"},"state":{"type":"string","enum":["SCHEDULED","RUNNING","FAILED","COMPLETED","NOTIFICATION_FAILED","QUEUED"]},"masId":{"type":"string"},"targetId":{"type":"string"},"targetType":{"type":"string","enum":["DIGITAL_SPECIMEN","MEDIA_OBJECT"]},"orcid":{"type":"string"},"batchingRequested":{"type":"boolean"},"timeToLive":{"type":"integer","format":"int32"}}},"MjrResponseData":{"type":"object","properties":{"id":{"type":"string","description":"ID of the resource"},"type":{"type":"string","description":"Type of the resource"},"attributes":{"$ref":"#/components/schemas/MasJobRecord"}}},"MjrResponseList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MjrResponseData"}},"links":{"$ref":"#/components/schemas/JsonApiLinksFull","description":"Links object, for pagination"},"meta":{"$ref":"#/components/schemas/JsonApiMeta","description":"Response metadata"}}},"AnnotationBody":{"type":"object","properties":{"@type":{"type":"string"},"oa:value":{"type":"array","items":{"type":"string"}},"dcterms:references":{"type":"string"},"ods:score":{"type":"number","format":"double"}}},"AnnotationProcessingRequest":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string"},"dcterms:identifier":{"type":"string"},"oa:motivation":{"type":"string","enum":["ods:adding","ods:deleting","oa:assessing","oa:editing","oa:commenting"]},"oa:motivatedBy":{"type":"string"},"oa:hasTarget":{"$ref":"#/components/schemas/AnnotationTarget"},"oa:hasBody":{"$ref":"#/components/schemas/AnnotationBody"},"dcterms:creator":{"$ref":"#/components/schemas/Agent"},"dcterms:created":{"type":"string","format":"date-time"},"ods:placeInBatch":{"type":"integer","format":"int32"},"ods:batchID":{"type":"string","format":"uuid"}}},"AnnotationRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AnnotationRequestData"}}},"AnnotationRequestData":{"type":"object","properties":{"type":{"type":"string","description":"Type of request. For annotations, must be \"ods:Annotation\"","enum":["https://doi.org/21.T11148/894b1e6cad57e921764e","https://doi.org/21.T11148/bbad8c4e101e8af01115","https://doi.org/21.T11148/cf458ca9ee1d44a5608f","https://doi.org/21.T11148/417a4f472f60f7974c12","https://doi.org/21.T11148/ce794a6f4df42eb7e77e","https://doi.org/21.T11148/a369e128df5ef31044d4","https://doi.org/21.T11148/2ac65a933b7a0361b651","https://doi.org/21.T11148/532ce6796e2828dd2be6"]},"attributes":{"$ref":"#/components/schemas/AnnotationProcessingRequest","description":"Desired annotation"}}},"AnnotationTarget":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string"},"dcterms:identifier":{"type":"string"},"ods:fdoType":{"type":"string"},"oa:hasSelector":{"$ref":"#/components/schemas/OaHasSelector"}}},"OaHasSelector":{},"Annotation":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string"},"dcterms:identifier":{"type":"string"},"ods:fdoType":{"type":"string"},"ods:status":{"type":"string","enum":["Draft","Active","Tombstone"]},"ods:jobID":{"type":"string"},"ods:version":{"type":"integer","format":"int32"},"oa:motivation":{"type":"string","enum":["ods:adding","ods:deleting","oa:assessing","oa:editing","oa:commenting"]},"oa:motivatedBy":{"type":"string"},"oa:hasTarget":{"$ref":"#/components/schemas/AnnotationTarget"},"oa:hasBody":{"$ref":"#/components/schemas/AnnotationBody"},"dcterms:creator":{"$ref":"#/components/schemas/Agent"},"dcterms:created":{"type":"string","format":"date-time"},"dcterms:modified":{"type":"string","format":"date-time"},"dcterms:issued":{"type":"string","format":"date-time"},"as:generator":{"$ref":"#/components/schemas/Agent"},"ods:hasAggregateRating":{"$ref":"#/components/schemas/OdsHasAggregateRating"},"ods:batchID":{"type":"string","format":"uuid"},"ods:placeInBatch":{"type":"integer","format":"int32"},"ods:mergingDecisionStatus":{"type":"string","enum":["Pending","Rejected","Approved"]},"ods:mergingStateChangeDate":{"type":"string","format":"date-time"},"ods:hasMergingStateChangedBy":{"$ref":"#/components/schemas/Agent"},"ods:hasTombstoneMetadata":{"$ref":"#/components/schemas/TombstoneMetadata"}}},"AnnotationResponseData":{"type":"object","properties":{"id":{"type":"string","description":"Handle of the annotation"},"type":{"type":"string","description":"Type of the object, in this case \"ods:Annotation\""},"attributes":{"$ref":"#/components/schemas/Annotation","description":"Annotation"}}},"AnnotationResponseSingle":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/JsonApiLinks","description":"Links object, self-referencing"},"data":{"$ref":"#/components/schemas/AnnotationResponseData"}}},"OdsHasAggregateRating":{"type":"object","properties":{"@type":{"type":"string"},"schema:ratingCount":{"type":"integer","format":"int32"},"schema:ratingValue":{"type":"number","format":"double"}}},"AnnotationEventRequest":{"type":"object","properties":{"annotationRequests":{"type":"array","items":{"$ref":"#/components/schemas/AnnotationProcessingRequest"}},"batchMetadata":{"type":"array","items":{"$ref":"#/components/schemas/BatchMetadata"}}}},"BatchAnnotationRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BatchAnnotationRequestData"}}},"BatchAnnotationRequestData":{"type":"object","properties":{"type":{"type":"string","description":"Type of request, in this case \"ods:Annotation\"","enum":["https://doi.org/21.T11148/894b1e6cad57e921764e","https://doi.org/21.T11148/bbad8c4e101e8af01115","https://doi.org/21.T11148/cf458ca9ee1d44a5608f","https://doi.org/21.T11148/417a4f472f60f7974c12","https://doi.org/21.T11148/ce794a6f4df42eb7e77e","https://doi.org/21.T11148/a369e128df5ef31044d4","https://doi.org/21.T11148/2ac65a933b7a0361b651","https://doi.org/21.T11148/532ce6796e2828dd2be6"]},"attributes":{"$ref":"#/components/schemas/AnnotationEventRequest"}}},"BatchMetadata":{"type":"object","properties":{"placeInBatch":{"type":"integer","format":"int32"},"searchParams":{"type":"array","items":{"$ref":"#/components/schemas/SearchParam"}}}},"SearchParam":{"type":"object","properties":{"inputField":{"type":"string"},"inputValue":{"type":"string"}}},"VirtualCollectionResponseList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VirtualCollectionResponseData"}},"links":{"$ref":"#/components/schemas/JsonApiLinksFull","description":"Links object, for pagination"},"meta":{"$ref":"#/components/schemas/JsonApiMeta","description":"Response metadata"}}},"VersionResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/VersionResponseData"},"links":{"$ref":"#/components/schemas/JsonApiLinks","description":"Links object, self-referencing"}}},"VersionResponseAttributes":{"type":"object","properties":{"versions":{"type":"array","items":{"type":"integer","format":"int32"}}}},"VersionResponseData":{"type":"object","properties":{"id":{"type":"string","description":"Handle of the target annotation"},"type":{"type":"string","description":"Type of response"},"attributes":{"$ref":"#/components/schemas/VersionResponseAttributes","description":"Versions of the target object"}}},"MjrResponseSingle":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MjrResponseData"},"links":{"$ref":"#/components/schemas/JsonApiLinks","description":"Links object, self-referencing"}}},"ElvisSpecimen":{"type":"object","description":"Schema for ELViS specimen.\n\nIf no value for a given term is present, an empty string is returned.\n\nWhere possible, taxonomic terms come from the \"accepted Identification\". If there is no accepted Identification, the first Identification is used.\nSome Identifications contain have multiple taxonomies. This occurs when a specimen contains multiple subjects (e.g. a rock with multiple fossils).\nIn this case, the response includes the first two taxonomies then \"and x more\" is appended.\n","properties":{"inventoryNumber":{"type":"string","description":"dcterms:identifier, the DOI of the specimen"},"title":{"type":"string","description":"Concatenation of ods:specimenName physicalSpecimenID, ods:OrganisationName"},"collectionCode":{"type":"string","description":"dwc:collectionCode"},"catalogNumber":{"type":"string","description":"dwc:physicalSpecimenID"},"institutionCode":{"type":"string","description":"ods:organisationCode"},"basisOfRecord":{"type":"string","description":"dwc:basisOfRecord"},"URI":{"type":"string","description":"DOI that resolves to human-readable specimen landing page on DiSSCo"},"scientificName":{"type":"string","description":"dwc:scientificName"},"scientificNameAuthorship":{"type":"string","description":"dwc:scientificNameAuthorship"},"specificEpithet":{"type":"string","description":"dwc:specificEpithet"},"family":{"type":"string","description":"dwc:family"},"genus":{"type":"string","description":"dwc:genus"},"vernacularName":{"type":"string","description":"dwc:vernacularName"}}},"InventoryNumberSuggestion":{"type":"object","description":"Suggestions for key identifiers","properties":{"catalogNumber":{"type":"string","description":"ods:physicalSpecimenId"},"inventoryNumber":{"type":"string","description":"dcterms:identifier"}}},"InventoryNumberSuggestionResponse":{"type":"object","properties":{"total":{"type":"integer","format":"int64","example":3},"inventoryNumbers":{"type":"array","items":{"$ref":"#/components/schemas/InventoryNumberSuggestion"}}}},"Assertion":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string"},"dwc:measurementID":{"type":"string"},"dwc:parentMeasurementID":{"type":"string"},"dwc:measurementType":{"type":"string"},"dwciri:measurementType":{"type":"string"},"dwc:measurementDeterminedDate":{"type":"string"},"dwc:measurementValue":{"type":"string"},"dwciri:measurementValue":{"type":"string"},"dwc:measurementAccuracy":{"type":"string"},"dwc:measurementUnit":{"type":"string"},"dwciri:measurementUnit":{"type":"string"},"dwc:measurementMethod":{"type":"string"},"dwciri:measurementMethod":{"type":"string"},"dwc:measurementRemarks":{"type":"string"},"ods:hasAgents":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}},"ods:hasCitations":{"type":"array","items":{"$ref":"#/components/schemas/Citation"}}}},"ChronometricAge":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string"},"chrono:chronometricAgeID":{"type":"string"},"chrono:verbatimChronometricAge":{"type":"string"},"chrono:uncalibratedChronometricAge":{"type":"string"},"chrono:chronometricAgeConversionProtocol":{"type":"string"},"chrono:earliestChronometricAge":{"type":"integer","format":"int32"},"chrono:earliestChronometricAgeReferenceSystem":{"type":"string"},"chrono:latestChronometricAge":{"type":"integer","format":"int32"},"chrono:latestChronometricAgeReferenceSystem":{"type":"string"},"chrono:chronometricAgeProtocol":{"type":"string"},"chrono:chronometricAgeUncertaintyInYears":{"type":"integer","format":"int32"},"chrono:chronometricAgeUncertaintyMethod":{"type":"string"},"chrono:materialDated":{"type":"string"},"chrono:materialDatedID":{"type":"string"},"chrono:materialDatedRelationship":{"type":"string"},"chrono:chronometricAgeDeterminedDate":{"type":"string"},"chrono:chronometricAgeReferences":{"type":"string"},"chrono:chronometricAgeRemarks":{"type":"string"},"ods:hasAgents":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}}}},"Citation":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string"},"dcterms:identifier":{"type":"string"},"dcterms:type":{"type":"string"},"dcterms:date":{"type":"string"},"dcterms:title":{"type":"string"},"ods:pageNumber":{"type":"string"},"dcterms:description":{"type":"string"},"dcterms:bibliographicCitation":{"type":"string"},"ods:isPeerReviewed":{"type":"boolean"},"ods:hasAgents":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}}}},"DigitalSpecimen":{"type":"object","properties":{"@id":{"type":"string"},"@type":{},"dcterms:identifier":{"type":"string"},"ods:version":{"type":"integer","format":"int32"},"ods:status":{"type":"string","enum":["Draft","Active","Tombstone"]},"dcterms:modified":{"type":"string"},"dcterms:created":{"type":"string","format":"date-time"},"ods:fdoType":{"type":"string"},"ods:midsLevel":{"type":"integer","format":"int32"},"ods:normalisedPhysicalSpecimenID":{"type":"string"},"ods:physicalSpecimenID":{"type":"string"},"ods:physicalSpecimenIDType":{"type":"string","enum":["Resolvable","Global","Local"]},"ods:isKnownToContainMedia":{"type":"boolean"},"ods:sourceSystemID":{"type":"string"},"ods:sourceSystemName":{"type":"string"},"ods:livingOrPreserved":{"type":"string","enum":["Living","Preserved"]},"ods:metadataLanguages":{"type":"array","items":{"type":"string"}},"dcterms:license":{"type":"string"},"dwc:basisOfRecord":{"type":"string"},"ods:organisationCode":{"type":"string"},"ods:organisationID":{"type":"string"},"ods:organisationName":{"type":"string"},"dwc:collectionCode":{"type":"string"},"dwc:collectionID":{"type":"string"},"ods:topicOrigin":{"type":"string","enum":["Natural","Human-made","Mixed origin","Unclassified"]},"ods:topicDomain":{"type":"string","enum":["Life","Environment","Earth System","Extraterrestrial","Cultural Artefacts","Archive Material","Unclassified"]},"ods:topicDiscipline":{"type":"string","enum":["Anthropology","Botany","Astrogeology","Geology","Microbiology","Palaeontology","Zoology","Ecology","Other Biodiversity","Other Geodiversity","Unclassified"]},"ods:topicCategory":{"type":"string"},"ods:specimenName":{"type":"string"},"dwc:informationWithheld":{"type":"string"},"dwc:preparations":{"type":"string"},"dwc:disposition":{"type":"string"},"ods:isMarkedAsType":{"type":"boolean"},"dwc:dataGeneralizations":{"type":"string"},"ods:ownerOrganisationCode":{"type":"string"},"dwc:datasetName":{"type":"string"},"dwc:datasetID":{"type":"string"},"dcterms:accessRights":{"type":"string"},"dcterms:rightsHolder":{"type":"string"},"dwc:organismID":{"type":"string"},"dwc:organismName":{"type":"string"},"dwc:organismScope":{"type":"string"},"dwc:organismRemarks":{"type":"string"},"dwc:organismQuantity":{"type":"string"},"dwc:organismQuantityType":{"type":"string"},"dwc:verbatimLabel":{"type":"string"},"dwc:dynamicProperties":{"type":"string"},"ods:hasSpecimenParts":{"type":"array","items":{"$ref":"#/components/schemas/SpecimenPart"}},"ods:hasAssertions":{"type":"array","items":{"$ref":"#/components/schemas/Assertion"}},"ods:hasEntityRelationships":{"type":"array","items":{"$ref":"#/components/schemas/EntityRelationship"}},"ods:hasIdentifications":{"type":"array","items":{"$ref":"#/components/schemas/Identification"}},"ods:hasIdentifiers":{"type":"array","items":{"$ref":"#/components/schemas/Identifier"}},"ods:hasCitations":{"type":"array","items":{"$ref":"#/components/schemas/Citation"}},"ods:hasAgents":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}},"ods:hasEvents":{"type":"array","items":{"$ref":"#/components/schemas/Event"}},"ods:hasChronometricAges":{"type":"array","items":{"$ref":"#/components/schemas/ChronometricAge"}},"ods:hasTombstoneMetadata":{"$ref":"#/components/schemas/TombstoneMetadata"}}},"DigitalSpecimenResponseData":{"type":"object","properties":{"id":{"type":"string","description":"DOI of the Digital Specimen"},"type":{"type":"string","description":"Fdo type of the object"},"attributes":{"$ref":"#/components/schemas/DigitalSpecimen"}}},"DigitalSpecimenResponseList":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DigitalSpecimenResponseData"},"links":{"$ref":"#/components/schemas/JsonApiLinksFull","description":"Links object, for pagination"},"meta":{"$ref":"#/components/schemas/JsonApiMeta","description":"Response metadata"}}},"EntityRelationship":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string"},"dwc:relationshipOfResource":{"type":"string"},"dwc:relationshipOfResourceID":{"type":"string"},"dwc:relatedResourceID":{"type":"string"},"ods:relatedResourceURI":{"type":"string","format":"uri"},"dwc:relationshipEstablishedDate":{"type":"string","format":"date-time"},"dwc:relationshipRemarks":{"type":"string"},"ods:hasAgents":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}}}},"Event":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string"},"dwc:behavior":{"type":"string"},"dwc:eventType":{"type":"string"},"dwc:sex":{"type":"string"},"dwc:lifeStage":{"type":"string"},"dwc:reproductiveCondition":{"type":"string"},"dwc:caste":{"type":"string"},"dwc:vitality":{"type":"string"},"dwc:establishmentMeans":{"type":"string"},"dwc:pathway":{"type":"string"},"dwc:degreeOfEstablishment":{"type":"string"},"dwc:georeferenceVerificationStatus":{"type":"string"},"dwc:fieldNumber":{"type":"string"},"dwc:eventDate":{"type":"string"},"dwc:eventTime":{"type":"string"},"dwc:endDayOfYear":{"type":"integer","format":"int32"},"dwc:startDayOfYear":{"type":"integer","format":"int32"},"dwc:verbatimEventDate":{"type":"string"},"dwc:year":{"type":"integer","format":"int32"},"dwc:month":{"type":"integer","format":"int32"},"dwc:day":{"type":"integer","format":"int32"},"dwc:habitat":{"type":"string"},"eco:protocolDescriptions":{"type":"string"},"dwc:sampleSizeValue":{"type":"number","format":"double"},"dwc:sampleSizeUnit":{"type":"string"},"dwc:samplingProtocol":{"type":"string"},"dwc:samplingEffort":{"type":"string"},"dwc:fieldNotes":{"type":"string"},"dwc:eventRemarks":{"type":"string"},"ods:hasAssertions":{"type":"array","items":{"$ref":"#/components/schemas/Assertion"}},"ods:hasAgents":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}},"ods:hasLocation":{"$ref":"#/components/schemas/Location"}}},"GeologicalContext":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string"},"dwc:earliestEonOrLowestEonothem":{"type":"string"},"dwc:latestEonOrHighestEonothem":{"type":"string"},"dwc:earliestEraOrLowestErathem":{"type":"string"},"dwc:latestEraOrHighestErathem":{"type":"string"},"dwc:earliestPeriodOrLowestSystem":{"type":"string"},"dwc:latestPeriodOrHighestSystem":{"type":"string"},"dwc:earliestEpochOrLowestSeries":{"type":"string"},"dwc:latestEpochOrHighestSeries":{"type":"string"},"dwc:earliestAgeOrLowestStage":{"type":"string"},"dwc:latestAgeOrHighestStage":{"type":"string"},"dwc:lowestBiostratigraphicZone":{"type":"string"},"dwc:highestBiostratigraphicZone":{"type":"string"},"dwc:lithostratigraphicTerms":{"type":"string"},"dwc:group":{"type":"string"},"dwc:formation":{"type":"string"},"dwc:member":{"type":"string"},"dwc:bed":{"type":"string"}}},"Georeference":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string"},"dwc:verbatimCoordinates":{"type":"string"},"dwc:decimalLatitude":{"type":"number","format":"double"},"dwc:verbatimLatitude":{"type":"string"},"dwc:decimalLongitude":{"type":"number","format":"double"},"dwc:verbatimLongitude":{"type":"string"},"dwc:verbatimCoordinateSystem":{"type":"string"},"dwc:geodeticDatum":{"type":"string"},"dwc:coordinateUncertaintyInMeters":{"type":"number","format":"double"},"dwc:coordinatePrecision":{"type":"number","format":"double"},"dwc:pointRadiusSpatialFit":{"type":"number","format":"double"},"dwc:footprintWKT":{"type":"string"},"dwc:footprintSRS":{"type":"string"},"dwc:verbatimSRS":{"type":"string"},"dwc:footprintSpatialFit":{"type":"integer","format":"int32"},"dwc:georeferencedDate":{"type":"string"},"dwc:georeferenceProtocol":{"type":"string"},"dwc:georeferenceSources":{"type":"string"},"dwc:georeferenceRemarks":{"type":"string"},"ods:hasAgents":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}}}},"Identification":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string"},"dwc:identificationID":{"type":"string"},"ods:identificationType":{"type":"string","enum":["TaxonIdentification"]},"dwc:verbatimIdentification":{"type":"string"},"dwc:typeStatus":{"type":"string"},"dwc:dateIdentified":{"type":"string"},"ods:isVerifiedIdentification":{"type":"boolean"},"dwc:identificationRemarks":{"type":"string"},"dwc:identificationQualifier":{"type":"string"},"ods:hasAgents":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}},"ods:hasCitations":{"type":"array","items":{"$ref":"#/components/schemas/Citation"}},"ods:hasTaxonIdentifications":{"type":"array","items":{"$ref":"#/components/schemas/TaxonIdentification"}}}},"Location":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string"},"dwc:locationID":{"type":"string"},"dwc:continent":{"type":"string"},"dwc:waterBody":{"type":"string"},"dwc:islandGroup":{"type":"string"},"dwc:island":{"type":"string"},"dwc:country":{"type":"string"},"dwc:countryCode":{"type":"string"},"dwc:stateProvince":{"type":"string"},"dwc:county":{"type":"string"},"dwc:municipality":{"type":"string"},"dwc:locality":{"type":"string"},"dwc:verbatimLocality":{"type":"string"},"dwc:minimumElevationInMeters":{"type":"number","format":"double"},"dwc:higherGeographyID":{"type":"string"},"dwc:higherGeography":{"type":"string"},"dwc:maximumElevationInMeters":{"type":"number","format":"double"},"dwc:verbatimElevation":{"type":"string"},"dwc:minimumDistanceAboveSurfaceInMeters":{"type":"number","format":"double"},"dwc:maximumDistanceAboveSurfaceInMeters":{"type":"number","format":"double"},"dwc:minimumDepthInMeters":{"type":"number","format":"double"},"dwc:maximumDepthInMeters":{"type":"number","format":"double"},"dwc:verbatimDepth":{"type":"string"},"dwc:verticalDatum":{"type":"string"},"dwc:locationAccordingTo":{"type":"string"},"dwc:locationRemarks":{"type":"string"},"ods:hasGeoreference":{"$ref":"#/components/schemas/Georeference"},"ods:hasGeologicalContext":{"$ref":"#/components/schemas/GeologicalContext"}}},"SpecimenPart":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string"},"dwc:materialEntityID":{"type":"string"},"dwc:recordNumber":{"type":"string"},"dwc:preparations":{"type":"string"},"ods:isMarkedAsType":{"type":"boolean"},"ods:topicOrigin":{"type":"string","enum":["Natural","Human-made","Mixed origin","Unclassified"]},"ods:topicDomain":{"type":"string","enum":["Life","Environment","Earth System","Extraterrestrial","Cultural Artefacts","Archive Material","Unclassified"]},"ods:topicDiscipline":{"type":"string","enum":["Anthropology","Botany","Astrogeology","Geology","Microbiology","Palaeontology","Zoology","Ecology","Other Biodiversity","Other Geodiversity","Unclassified"]},"ods:topicCategory":{"type":"string"},"ods:specimenName":{"type":"string"},"dwc:organismID":{"type":"string"},"dwc:organismName":{"type":"string"},"dwc:organismScope":{"type":"string"},"dwc:organismRemarks":{"type":"string"},"dwc:organismQuantity":{"type":"string"},"dwc:organismQuantityType":{"type":"string"},"ods:hasIdentifications":{"type":"array","items":{"$ref":"#/components/schemas/Identification"}},"ods:hasAssertions":{"type":"array","items":{"$ref":"#/components/schemas/Assertion"}},"ods:hasIdentifiers":{"type":"array","items":{"$ref":"#/components/schemas/Identifier"}},"ods:hasEvents":{"type":"array","items":{"$ref":"#/components/schemas/Event"}},"ods:hasAgents":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}},"ods:hasChronometricAges":{"type":"array","items":{"$ref":"#/components/schemas/ChronometricAge"}}}},"TaxonIdentification":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string"},"dwc:taxonID":{"type":"string"},"dwc:scientificName":{"type":"string"},"dwc:scientificNameID":{"type":"string"},"ods:scientificNameHTMLLabel":{"type":"string"},"ods:genusHTMLLabel":{"type":"string"},"dwc:scientificNameAuthorship":{"type":"string"},"dwc:namePublishedInYear":{"type":"string"},"dwc:taxonRank":{"type":"string"},"dwc:verbatimTaxonRank":{"type":"string"},"dwc:taxonRemarks":{"type":"string"},"dwc:kingdom":{"type":"string"},"dwc:phylum":{"type":"string"},"dwc:class":{"type":"string"},"dwc:order":{"type":"string"},"dwc:family":{"type":"string"},"dwc:subfamily":{"type":"string"},"dwc:genus":{"type":"string"},"dwc:specificEpithet":{"type":"string"},"dwc:taxonomicStatus":{"type":"string"},"dwc:nomenclaturalCode":{"type":"string"},"dwc:vernacularName":{"type":"string"},"dwc:subgenus":{"type":"string"},"dwc:acceptedNameUsage":{"type":"string"},"dwc:acceptedNameUsageID":{"type":"string"},"dwc:cultivarEpithet":{"type":"string"},"dwc:genericName":{"type":"string"},"dwc:infragenericEpithet":{"type":"string"},"dwc:infraspecificEpithet":{"type":"string"},"dwc:nomenclaturalStatus":{"type":"string"},"dwc:originalNameUsage":{"type":"string"},"dwc:subtribe":{"type":"string"},"dwc:superfamily":{"type":"string"},"dwc:tribe":{"type":"string"}}},"DigitalSpecimenResponseSingle":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DigitalSpecimenResponseData"},"links":{"$ref":"#/components/schemas/JsonApiLinksFull","description":"Links object, self-referencing"}}},"DigitalMedia":{"type":"object","properties":{"@id":{"type":"string"},"@type":{"type":"string"},"dcterms:identifier":{"type":"string"},"ods:fdoType":{"type":"string"},"ods:version":{"type":"integer","format":"int32"},"ods:status":{"type":"string","enum":["Draft","Active","Tombstone"]},"dcterms:modified":{"type":"string"},"dcterms:created":{"type":"string","format":"date-time"},"dcterms:type":{"type":"string","enum":["Collection","Dataset","Event","Image","InteractiveResource","MovingImage","PhysicalObject","Service","Software","Sound","StillImage","Text"]},"ac:accessURI":{"type":"string"},"ods:sourceSystemID":{"type":"string"},"ods:sourceSystemName":{"type":"string"},"ods:organisationID":{"type":"string"},"ods:organisationName":{"type":"string"},"dcterms:format":{"type":"string"},"ac:metadataLanguage":{"type":"string"},"ac:metadataLanguageLiteral":{"type":"string"},"ac:subtype":{"type":"string"},"ac:subtypeLiteral":{"type":"string"},"dcterms:title":{"type":"string"},"dcterms:language":{"type":"string"},"dcterms:description":{"type":"string"},"dcterms:rights":{"type":"string"},"xmpRights:UsageTerms":{"type":"string"},"xmpRights:WebStatement":{"type":"string"},"dcterms:available":{"type":"string"},"ac:comments":{"type":"string"},"dcterms:source":{"type":"string"},"Iptc4xmpExt:CVterm":{"type":"string"},"ac:subjectCategoryVocabulary":{"type":"string"},"ac:variant":{"type":"string"},"ac:variantLiteral":{"type":"string"},"ac:variantDescription":{"type":"string"},"exif:PixelYDimension":{"type":"integer","format":"int32"},"exif:PixelXDimension":{"type":"integer","format":"int32"},"ac:tag":{"type":"array","items":{"type":"string"}},"xmp:CreateDate":{"type":"string"},"ac:timeOfDay":{"type":"string"},"ac:subjectOrientation":{"type":"string"},"ac:subjectOrientationLiteral":{"type":"string"},"ac:subjectPart":{"type":"string"},"ac:subjectPartLiteral":{"type":"string"},"ac:captureDevice":{"type":"string"},"ac:digitizationDate":{"type":"string"},"ac:frameRate":{"type":"number","format":"double"},"ac:resourceCreationTechnique":{"type":"string"},"ods:hasAssertions":{"type":"array","items":{"$ref":"#/components/schemas/Assertion"}},"ods:hasCitations":{"type":"array","items":{"$ref":"#/components/schemas/Citation"}},"ods:hasIdentifiers":{"type":"array","items":{"$ref":"#/components/schemas/Identifier"}},"ods:hasEntityRelationships":{"type":"array","items":{"$ref":"#/components/schemas/EntityRelationship"}},"ods:hasAgents":{"type":"array","items":{"$ref":"#/components/schemas/Agent"}},"ods:hasTombstoneMetadata":{"$ref":"#/components/schemas/TombstoneMetadata"}}},"DigitalSpecimenResponseAttributesFull":{"type":"object","properties":{"digitalSpecimen":{"$ref":"#/components/schemas/DigitalSpecimen"},"digitalMedia":{"type":"array","items":{"$ref":"#/components/schemas/DigitalMedia"}},"annotations":{"type":"array","items":{"$ref":"#/components/schemas/Annotation"}}}},"DigitalSpecimenResponseDataFull":{"type":"object","properties":{"attributes":{"$ref":"#/components/schemas/DigitalSpecimenResponseAttributesFull"}}},"DigitalSpecimenResponseFull":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DigitalSpecimenResponseDataFull"},"links":{"$ref":"#/components/schemas/JsonApiLinksFull","description":"Links object, for pagination"},"meta":{"$ref":"#/components/schemas/JsonApiMeta","description":"Response metadata"}}},"JsonApiData":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"$ref":"#/components/schemas/JsonNode"}}},"JsonApiWrapper":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/JsonApiData"},"links":{"$ref":"#/components/schemas/JsonApiLinks"},"meta":{"$ref":"#/components/schemas/JsonApiMeta"}}},"JsonNode":{},"AnnotationResponseList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AnnotationResponseData"}},"links":{"$ref":"#/components/schemas/JsonApiLinksFull","description":"Links object, for pagination"},"meta":{"$ref":"#/components/schemas/JsonApiMeta","description":"Response metadata"}}},"DigitalMediaResponseData":{"type":"object","properties":{"id":{"type":"string","description":"DOI of the Digital Media"},"type":{"type":"string","description":"Fdo type of the object"},"attributes":{"$ref":"#/components/schemas/DigitalMedia"}}},"DigitalMediaResponseList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DigitalMediaResponseData"}},"links":{"$ref":"#/components/schemas/JsonApiLinksFull","description":"Links object, for pagination"},"meta":{"$ref":"#/components/schemas/JsonApiMeta","description":"Response metadata"}}},"MultiValueMapStringString":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"properties":{"all":{"type":"object","additionalProperties":{"type":"string"},"writeOnly":true},"empty":{"type":"boolean"}}},"AggregationResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AggregationResponseData"},"links":{"$ref":"#/components/schemas/JsonApiLinks","description":"Links object, self-referencing"}}},"AggregationResponseData":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"attributes":{"$ref":"#/components/schemas/JsonNode"}}},"DigitalMediaResponseSingle":{"type":"object","properties":{"links":{"$ref":"#/components/schemas/JsonApiLinks","description":"Links object, self-referencing"},"data":{"$ref":"#/components/schemas/DigitalMediaResponseData"}}},"BatchAnnotationCountRequest":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BatchAnnotationCountRequestData"}}},"BatchAnnotationCountRequestAttributes":{"type":"object","properties":{"batchMetadata":{"$ref":"#/components/schemas/BatchMetadata"},"annotationTargetType":{"type":"string","description":"Type of target, either https://doi.org/21.T11148/894b1e6cad57e921764e (digital specimen) or https://doi.org21.T11148/bbad8c4e101e8af01115 (digital media)","enum":["https://doi.org/21.T11148/894b1e6cad57e921764e","https://doi.org21.T11148/bbad8c4e101e8af01115"]}}},"BatchAnnotationCountRequestData":{"type":"object","properties":{"type":{"type":"string","description":"Type of request, in this case \"batchAnnotationCountRequest\""},"attributes":{"$ref":"#/components/schemas/BatchAnnotationCountRequestAttributes"}}},"BatchAnnotationCountResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BatchAnnotationCountResponseData"}}},"BatchAnnotationCountResponseAttributes":{"type":"object","properties":{"objectAffected":{"type":"integer","format":"int64","description":"Number of objects affected by given search parameters"},"batchMetadata":{"$ref":"#/components/schemas/BatchMetadata","description":"Provided search parameters"}}},"BatchAnnotationCountResponseData":{"type":"object","properties":{"type":{"type":"string","description":"Type of response. In this case, \"batchAnnotationCount\""},"attributes":{"$ref":"#/components/schemas/BatchAnnotationCountResponseAttributes"}}}}}}