{"swagger":"2.0","info":{"description":"CESSDA Vocabularies Service API Documentation","version":"3.6.1","title":"CVS API","termsOfService":"https://www.cessda.eu/Acceptable-Use-Policy","contact":{"name":"CESSDA Support","email":"support@cessda.eu"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"host":"vocabularies.cessda.eu","basePath":"/","tags":[{"name":"urn-resolver","description":"Urn Resolver"},{"name":"vocabulary-resource-v-2","description":"Vocabulary Resource V 2"}],"paths":{"/urn/{urn}":{"get":{"tags":["urn-resolver"],"summary":"findUrnResolver","operationId":"findUrnResolverUsingGET","produces":["*/*"],"parameters":[{"name":"lang","in":"query","description":"lang","required":false,"type":"string"},{"name":"urn","in":"path","description":"urn","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/v2/codes/{vocabulary}/{versionNumber}/{language}":{"get":{"tags":["vocabulary-resource-v-2"],"summary":"Get a Code in JSON format","operationId":"getCodeJsonUsingGET","produces":["application/json"],"parameters":[{"name":"language","in":"path","description":"The language","required":true,"type":"string","x-example":"en"},{"name":"versionNumber","in":"path","description":"The version number","required":true,"type":"string","x-example":"4.0"},{"name":"vocabulary","in":"path","description":"The vocabulary","required":true,"type":"string","x-example":"TopicClassification"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/ConceptDTO"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/v2/search/codes":{"get":{"tags":["vocabulary-resource-v-2"],"summary":"Searching the vocabularies codes that produces JSON-LD based on Skosmos format","operationId":"getAllVocabulariesCodeUsingGET","produces":["application/ld+json"],"parameters":[{"name":"agency","in":"query","description":"The agency","required":false,"type":"string","allowEmptyValue":false,"x-example":"CESSDA"},{"name":"lang","in":"query","description":"The language","required":true,"type":"string","allowEmptyValue":false,"x-example":"en"},{"name":"query","in":"query","description":"The query, e.g. Economics or with wildcard eco*","required":true,"type":"string","allowEmptyValue":false,"x-example":"Economics"},{"name":"size","in":"query","description":"The maximum size of codes returned, default 20 maximum 100","required":false,"type":"integer","format":"int32","allowEmptyValue":false,"x-example":20},{"name":"vocab","in":"query","description":"The vocabulary","required":true,"type":"string","allowEmptyValue":false,"x-example":"TopicClassification"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/v2/vocabularies-published":{"get":{"tags":["vocabulary-resource-v-2"],"summary":"Get list of the agencies and the published controlled vocabularies with the details of the rest API link. The rest API links need a specific content type e.g. JSON, PDF","operationId":"getAllVocabulariesUsingGET","produces":["application/json"],"responses":{"200":{"description":"OK","schema":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"}}}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}},"/v2/vocabularies/{vocabulary}/{versionNumberSl}":{"get":{"tags":["vocabulary-resource-v-2"],"summary":"Get a Vocabulary in PDF file","operationId":"getVocabularyPdfUsingGET","produces":["application/ld+json","text/html","application/pdf","application/json","application/rdf+xml","application/vnd.openxmlformats-officedocument.wordprocessingml.document"],"parameters":[{"name":"languageVersion","in":"query","description":"included language version, e.g. en-4.0_de-4.0.1, separated by _","required":false,"type":"string","allowEmptyValue":false,"x-example":"en-4.0"},{"name":"versionNumberSl","in":"path","description":"The version number of Source language","required":true,"type":"string","x-example":"4.0"},{"name":"vocabulary","in":"path","description":"The vocabulary","required":true,"type":"string","x-example":"TopicClassification"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Resource"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"deprecated":false}}},"definitions":{"Aggr":{"type":"object","properties":{"buckets":{"type":"array","items":{"$ref":"#/definitions/Bucket"}},"field":{"type":"string"},"filteredBuckets":{"type":"array","items":{"$ref":"#/definitions/Bucket"}},"type":{"type":"string"},"values":{"type":"array","items":{"type":"string"}}},"title":"Aggr"},"Bucket":{"type":"object","properties":{"k":{"type":"string"},"v":{"type":"integer","format":"int64"}},"title":"Bucket"},"CodeDTO":{"type":"object","properties":{"definitionBg":{"type":"string"},"definitionBs":{"type":"string"},"definitionCs":{"type":"string"},"definitionDa":{"type":"string"},"definitionDe":{"type":"string"},"definitionEl":{"type":"string"},"definitionEn":{"type":"string"},"definitionEs":{"type":"string"},"definitionEt":{"type":"string"},"definitionFi":{"type":"string"},"definitionFr":{"type":"string"},"definitionHr":{"type":"string"},"definitionHu":{"type":"string"},"definitionIt":{"type":"string"},"definitionJa":{"type":"string"},"definitionLt":{"type":"string"},"definitionMk":{"type":"string"},"definitionNl":{"type":"string"},"definitionNo":{"type":"string"},"definitionPl":{"type":"string"},"definitionPt":{"type":"string"},"definitionRo":{"type":"string"},"definitionRu":{"type":"string"},"definitionSk":{"type":"string"},"definitionSl":{"type":"string"},"definitionSq":{"type":"string"},"definitionSr":{"type":"string"},"definitionSv":{"type":"string"},"deprecated":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"languages":{"type":"array","items":{"type":"string"}},"notation":{"type":"string","minLength":0,"maxLength":240},"parent":{"type":"string","minLength":0,"maxLength":240},"position":{"type":"integer","format":"int32"},"publicationDate":{"type":"string","format":"date"},"replacedById":{"type":"integer","format":"int64"},"replacedByNotation":{"type":"string"},"replacedByUri":{"type":"string"},"titleBg":{"type":"string"},"titleBs":{"type":"string"},"titleCs":{"type":"string"},"titleDa":{"type":"string"},"titleDe":{"type":"string"},"titleEl":{"type":"string"},"titleEn":{"type":"string"},"titleEs":{"type":"string"},"titleEt":{"type":"string"},"titleFi":{"type":"string"},"titleFr":{"type":"string"},"titleHr":{"type":"string"},"titleHu":{"type":"string"},"titleIt":{"type":"string"},"titleJa":{"type":"string"},"titleLt":{"type":"string"},"titleMk":{"type":"string"},"titleNl":{"type":"string"},"titleNo":{"type":"string"},"titlePl":{"type":"string"},"titlePt":{"type":"string"},"titleRo":{"type":"string"},"titleRu":{"type":"string"},"titleSk":{"type":"string"},"titleSl":{"type":"string"},"titleSq":{"type":"string"},"titleSr":{"type":"string"},"titleSv":{"type":"string"},"uri":{"type":"string","minLength":0,"maxLength":240},"versionId":{"type":"integer","format":"int64"},"versionNumber":{"$ref":"#/definitions/VersionNumber"},"vocabularyId":{"type":"integer","format":"int64"}},"title":"CodeDTO"},"CommentDTO":{"type":"object","properties":{"content":{"type":"string"},"dateTime":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"},"info":{"type":"string"},"userId":{"type":"integer","format":"int64"},"versionId":{"type":"integer","format":"int64"}},"title":"CommentDTO"},"ConceptDTO":{"type":"object","required":["notation"],"properties":{"definition":{"type":"string"},"deprecated":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"introducedInVersionId":{"type":"integer","format":"int64"},"notation":{"type":"string","minLength":0,"maxLength":240},"parent":{"type":"string","minLength":0,"maxLength":240},"position":{"type":"integer","format":"int32"},"previousConcept":{"type":"integer","format":"int64"},"replacedById":{"type":"integer","format":"int64"},"replacedByNotation":{"type":"string"},"replacedByUri":{"type":"string"},"slConcept":{"type":"integer","format":"int64"},"title":{"type":"string"},"uri":{"type":"string"},"validFrom":{"type":"string","format":"date"},"validUntil":{"type":"string","format":"date"},"validUntilVersionId":{"type":"integer","format":"int64"},"versionId":{"type":"integer","format":"int64"}},"title":"ConceptDTO"},"CvResult":{"type":"object","properties":{"aggrs":{"type":"array","items":{"$ref":"#/definitions/Aggr"}},"first":{"type":"boolean"},"last":{"type":"boolean"},"number":{"type":"integer","format":"int32"},"numberOfElements":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"},"totalPage":{"type":"integer","format":"int32"},"vocabularies":{"type":"array","items":{"$ref":"#/definitions/VocabularyDTO"}}},"title":"CvResult"},"File":{"type":"object","properties":{"absolute":{"type":"boolean"},"absoluteFile":{"$ref":"#/definitions/File"},"absolutePath":{"type":"string"},"canonicalFile":{"$ref":"#/definitions/File"},"canonicalPath":{"type":"string"},"directory":{"type":"boolean"},"file":{"type":"boolean"},"freeSpace":{"type":"integer","format":"int64"},"hidden":{"type":"boolean"},"name":{"type":"string"},"parent":{"type":"string"},"parentFile":{"$ref":"#/definitions/File"},"path":{"type":"string"},"totalSpace":{"type":"integer","format":"int64"},"usableSpace":{"type":"integer","format":"int64"}},"title":"File"},"InputStream":{"type":"object","title":"InputStream"},"MapOfstringAndMapOfstringAndMapOfstringAndstring":{"type":"object","title":"MapOfstringAndMapOfstringAndMapOfstringAndstring","additionalProperties":{"$ref":"#/definitions/Map"}},"MapOfstringAndMapOfstringAndstring":{"type":"object","title":"MapOfstringAndMapOfstringAndstring","additionalProperties":{"$ref":"#/definitions/Map"}},"MapOfstringAndobject":{"type":"object","title":"MapOfstringAndobject","additionalProperties":{"type":"object"}},"MapOfstringAndstring":{"type":"object","title":"MapOfstringAndstring","additionalProperties":{"type":"string"}},"Resource":{"type":"object","properties":{"description":{"type":"string"},"file":{"$ref":"#/definitions/File"},"filename":{"type":"string"},"inputStream":{"$ref":"#/definitions/InputStream"},"open":{"type":"boolean"},"readable":{"type":"boolean"},"uri":{"$ref":"#/definitions/URI"},"url":{"$ref":"#/definitions/URL"}},"title":"Resource"},"URI":{"type":"object","properties":{"absolute":{"type":"boolean"},"authority":{"type":"string"},"fragment":{"type":"string"},"host":{"type":"string"},"opaque":{"type":"boolean"},"path":{"type":"string"},"port":{"type":"integer","format":"int32"},"query":{"type":"string"},"rawAuthority":{"type":"string"},"rawFragment":{"type":"string"},"rawPath":{"type":"string"},"rawQuery":{"type":"string"},"rawSchemeSpecificPart":{"type":"string"},"rawUserInfo":{"type":"string"},"scheme":{"type":"string"},"schemeSpecificPart":{"type":"string"},"userInfo":{"type":"string"}},"title":"URI"},"URL":{"type":"object","properties":{"authority":{"type":"string"},"content":{"type":"object"},"defaultPort":{"type":"integer","format":"int32"},"file":{"type":"string"},"host":{"type":"string"},"path":{"type":"string"},"port":{"type":"integer","format":"int32"},"protocol":{"type":"string"},"query":{"type":"string"},"ref":{"type":"string"},"userInfo":{"type":"string"}},"title":"URL"},"VersionDTO":{"type":"object","required":["itemType","status"],"properties":{"canonicalUri":{"type":"string"},"citation":{"type":"string"},"comments":{"type":"array","items":{"$ref":"#/definitions/CommentDTO"}},"concepts":{"type":"array","items":{"$ref":"#/definitions/ConceptDTO"}},"copyright":{"type":"string"},"creationDate":{"type":"string","format":"date"},"creator":{"type":"integer","format":"int64"},"ddiUsage":{"type":"string"},"definition":{"type":"string"},"discussionNotes":{"type":"string"},"id":{"type":"integer","format":"int64"},"initialVersion":{"type":"integer","format":"int64"},"itemType":{"type":"string","enum":["SL","TL"]},"language":{"type":"string","minLength":0,"maxLength":20},"lastModified":{"type":"string","format":"date-time"},"lastStatusChangeDate":{"type":"string","format":"date"},"license":{"type":"string"},"licenseId":{"type":"integer","format":"int64"},"licenseLink":{"type":"string"},"licenseLogo":{"type":"string"},"licenseName":{"type":"string"},"notation":{"type":"string","minLength":0,"maxLength":240},"notes":{"type":"string"},"number":{"$ref":"#/definitions/VersionNumber"},"previousVersion":{"type":"integer","format":"int64"},"publicationDate":{"type":"string","format":"date"},"publisher":{"type":"integer","format":"int64"},"status":{"type":"string","enum":["DRAFT","REVIEW","READY_TO_TRANSLATE","PUBLISHED","READY_TO_PUBLISH","PUBLISHED_RESTRICT","WITHDRAWN"]},"title":{"type":"string"},"translateAgency":{"type":"string"},"translateAgencyLink":{"type":"string"},"uri":{"type":"string"},"uriSl":{"type":"string"},"versionChanges":{"type":"string"},"versionHistories":{"type":"array","items":{"$ref":"#/definitions/MapOfstringAndobject"}},"versionNotes":{"type":"string"},"vocabularyId":{"type":"integer","format":"int64"}},"title":"VersionDTO"},"VersionNumber":{"type":"object","properties":{"majorNumber":{"type":"integer","format":"int32"},"minorNumber":{"type":"integer","format":"int32"},"patchNumber":{"type":"integer","format":"int32"}},"title":"VersionNumber"},"VocabularyDTO":{"type":"object","required":["agencyId","agencyName","notation","sourceLanguage","status","versionNumber"],"properties":{"agencyId":{"type":"integer","format":"int64"},"agencyLink":{"type":"string"},"agencyLogo":{"type":"string"},"agencyName":{"type":"string"},"archived":{"type":"boolean"},"codes":{"type":"array","items":{"$ref":"#/definitions/CodeDTO"}},"definitionBg":{"type":"string"},"definitionBs":{"type":"string"},"definitionCs":{"type":"string"},"definitionDa":{"type":"string"},"definitionDe":{"type":"string"},"definitionEl":{"type":"string"},"definitionEn":{"type":"string"},"definitionEs":{"type":"string"},"definitionEt":{"type":"string"},"definitionFi":{"type":"string"},"definitionFr":{"type":"string"},"definitionHr":{"type":"string"},"definitionHu":{"type":"string"},"definitionIt":{"type":"string"},"definitionJa":{"type":"string"},"definitionLt":{"type":"string"},"definitionMk":{"type":"string"},"definitionNl":{"type":"string"},"definitionNo":{"type":"string"},"definitionPl":{"type":"string"},"definitionPt":{"type":"string"},"definitionRo":{"type":"string"},"definitionRu":{"type":"string"},"definitionSk":{"type":"string"},"definitionSl":{"type":"string"},"definitionSq":{"type":"string"},"definitionSr":{"type":"string"},"definitionSv":{"type":"string"},"discoverable":{"type":"boolean"},"id":{"type":"integer","format":"int64"},"initialPublication":{"type":"integer","format":"int64"},"languages":{"type":"array","items":{"type":"string"}},"languagesPublished":{"type":"array","items":{"type":"string"}},"lastModified":{"type":"string","format":"date-time"},"notation":{"type":"string","minLength":0,"maxLength":240},"notes":{"type":"string"},"previousPublication":{"type":"integer","format":"int64"},"publicationDate":{"type":"string","format":"date"},"selectedLang":{"type":"string"},"sourceLanguage":{"type":"string","minLength":0,"maxLength":20},"status":{"type":"string","enum":["DRAFT","REVIEW","READY_TO_TRANSLATE","PUBLISHED","READY_TO_PUBLISH","PUBLISHED_RESTRICT","WITHDRAWN"]},"statuses":{"type":"array","items":{"type":"string"}},"titleAll":{"type":"string"},"titleBg":{"type":"string"},"titleBs":{"type":"string"},"titleCs":{"type":"string"},"titleDa":{"type":"string"},"titleDe":{"type":"string"},"titleEl":{"type":"string"},"titleEn":{"type":"string"},"titleEs":{"type":"string"},"titleEt":{"type":"string"},"titleFi":{"type":"string"},"titleFr":{"type":"string"},"titleHr":{"type":"string"},"titleHu":{"type":"string"},"titleIt":{"type":"string"},"titleJa":{"type":"string"},"titleLt":{"type":"string"},"titleMk":{"type":"string"},"titleNl":{"type":"string"},"titleNo":{"type":"string"},"titlePl":{"type":"string"},"titlePt":{"type":"string"},"titleRo":{"type":"string"},"titleRu":{"type":"string"},"titleSk":{"type":"string"},"titleSl":{"type":"string"},"titleSq":{"type":"string"},"titleSr":{"type":"string"},"titleSv":{"type":"string"},"uri":{"type":"string","minLength":0,"maxLength":240},"versionBg":{"type":"string","minLength":0,"maxLength":20},"versionBs":{"type":"string","minLength":0,"maxLength":20},"versionCs":{"type":"string","minLength":0,"maxLength":20},"versionDa":{"type":"string","minLength":0,"maxLength":20},"versionDe":{"type":"string","minLength":0,"maxLength":20},"versionEl":{"type":"string","minLength":0,"maxLength":20},"versionEn":{"type":"string","minLength":0,"maxLength":20},"versionEs":{"type":"string","minLength":0,"maxLength":20},"versionEt":{"type":"string","minLength":0,"maxLength":20},"versionFi":{"type":"string","minLength":0,"maxLength":20},"versionFr":{"type":"string","minLength":0,"maxLength":20},"versionHr":{"type":"string","minLength":0,"maxLength":20},"versionHu":{"type":"string","minLength":0,"maxLength":20},"versionIt":{"type":"string","minLength":0,"maxLength":20},"versionJa":{"type":"string","minLength":0,"maxLength":20},"versionLt":{"type":"string","minLength":0,"maxLength":20},"versionMk":{"type":"string","minLength":0,"maxLength":20},"versionNl":{"type":"string","minLength":0,"maxLength":20},"versionNo":{"type":"string","minLength":0,"maxLength":20},"versionNumber":{"$ref":"#/definitions/VersionNumber"},"versionPl":{"type":"string","minLength":0,"maxLength":20},"versionPt":{"type":"string","minLength":0,"maxLength":20},"versionRo":{"type":"string","minLength":0,"maxLength":20},"versionRu":{"type":"string","minLength":0,"maxLength":20},"versionSk":{"type":"string","minLength":0,"maxLength":20},"versionSl":{"type":"string","minLength":0,"maxLength":20},"versionSq":{"type":"string","minLength":0,"maxLength":20},"versionSr":{"type":"string","minLength":0,"maxLength":20},"versionSv":{"type":"string","minLength":0,"maxLength":20},"versions":{"type":"array","items":{"$ref":"#/definitions/VersionDTO"}},"withdrawn":{"type":"boolean"}},"title":"VocabularyDTO"}}}