{"openapi":"3.1.0","info":{"title":"Offentlig API for akvakulturforskning","description":"API som tilgjengeliggjør all akvakulturforskning fra innehavere med forskningstillatelser, m.m. OBS: Dette API'et kan bli endret uten forvarsel.","termsOfService":"https://www.fiskeridir.no/Tall-og-analyse/Lisens-for-bruk-av-Fiskeridirektoratets-data","contact":{"name":"Fiskeridirektoratet","url":"https://www.fiskeridir.no/Om-oss/kontakt-oss","email":"postmottak@fiskeridir.no"},"license":{"name":"Lisens for bruk av Fiskeridirektoratets data","url":"https://www.fiskeridir.no/Tall-og-analyse/Lisens-for-bruk-av-Fiskeridirektoratets-data"},"version":"1.0.0"},"servers":[{"url":"https://api.fiskeridir.no/aqua-research-project-api-public","description":"Generated server url"}],"tags":[{"name":"Forskningsprosjekter","description":"Finn data om forskningsprosjekter for akvakultur."},{"name":"Forskningsrapport filer","description":"Last ned filer tilknyttet forskningsrapporter."}],"paths":{"/api/v1/research-report-file/{reportNumber}/{fileId}":{"get":{"tags":["Forskningsrapport filer"],"summary":"Last ned fil tilknyttet en forskningsrapport","operationId":"downloadResearchReportFile","parameters":[{"name":"reportNumber","in":"path","required":true,"schema":{"type":"string"}},{"name":"fileId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{}}},"404":{"description":"Not found","content":{"application/vnd.hal+json":{"schema":{"type":"string","format":"binary"}}}}}}},"/api/v1/research-projects":{"get":{"tags":["Forskningsprosjekter"],"summary":"Søk etter forskningsprosjekter","operationId":"getResearchProjects","parameters":[{"name":"createdAfter","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"categories","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["FEED","NUTRITION","FISH_HEALTH","BREED","GENETICS","TECHNOLOGY","OPERATIONS","ECOLOGY","WELFARE","OTHER","PHARMACEUTICAL","SALMON_LICE"]}}},{"name":"researchLicenseNumbers","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"organizationOrgNo","in":"query","description":"OrgNo for endten innehaver eller forskningsinstitusjon","required":false,"schema":{"type":"string","maxLength":255,"minLength":0}},{"name":"legalOwnerOrgNo","in":"query","description":"OrgNo for innehaver","required":false,"schema":{"type":"string","maxLength":255,"minLength":0}},{"name":"researchInstitutionOrgNo","in":"query","description":"OrgNo for forskningsinstitusjon","required":false,"schema":{"type":"string","maxLength":255,"minLength":0}},{"name":"projectNo","in":"query","required":false,"schema":{"type":"string","maxLength":37,"minLength":0}},{"name":"showOnlyActiveProjects","in":"query","description":"Vis pågående prosjekter eller ikke","required":false,"schema":{"type":"boolean"}},{"name":"searchText","in":"query","description":"Fri tekst søk, som søker mot prosjketnavn, prosjektnummer, innehaver og forskningsinstitusjonen tilknytta prosjekt. Skiller ikke mellom små og store bokstaver.","required":false,"schema":{"type":"string","maxLength":255,"minLength":0}},{"name":"page","in":"query","description":"Zero-based page index (0..N)","required":false,"schema":{"type":"integer","default":0,"minimum":0}},{"name":"size","in":"query","description":"The size of the page to be returned","required":false,"schema":{"type":"integer","default":100,"minimum":1}},{"name":"sort","in":"query","description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"schema":{"type":"array","default":["created,ASC"],"items":{"type":"string"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchProjectOverviewResponsePage"}}}}}}},"/api/v1/research-project/{projectNumber}":{"get":{"tags":["Forskningsprosjekter"],"summary":"Finn forskningsprosjekt ved hjelp av prosjekt nummeret","operationId":"getResearchProject","parameters":[{"name":"projectNumber","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResearchProject"}}}}}}}},"components":{"schemas":{"ResearchProjectOverview":{"type":"object","description":"Grunnleggende informasjon om et forskningsprosjekt.","properties":{"projectNumber":{"type":"string","description":"Prosjektnummer. Dette fungerer som et eksternt referansenummer man eksempelvis kan søke opp prosjekter med."},"name":{"type":"string","description":"Prosjektnavn"},"description":{"type":"string","description":"Beskrivelse av forskningsprosjektet."},"licenseOwnerOrgNo":{"type":"string","description":"Organisasjonsnummeret til tillatelsesinnehaver."},"licenseOwnerOrgName":{"type":"string","description":"Organisasjonssnavn til tillatelsesinnehaver."},"researchInstitutionOrgNo":{"type":"string","description":"Organisasjonsnummeret til forskningsinstitusjonen tilknyttet prosjektet."},"researchInstitutionOrgName":{"type":"string","description":"Organisasjonsnavnet til forskningsinstitusjonen tilknyttet prosjektet."},"researchLicenses":{"type":"array","description":"Liste med forskningstillatelser tilknyttet prosjektet.","items":{"type":"string"}},"categories":{"type":"array","description":"Liste med fagfelt tilknyttet prosjektet.","items":{"type":"string","description":"Fagfelt man kan forske på.\n* _FEED_: Fôr.\n* _NUTRITION_: Ernæring.\n* _FISH_HEALTH_: Fiskehelse.\n* _BREED_: Avl.\n* _GENETICS_: Genetikk.\n* _TECHNOLOGY_: Teknologi.\n* _OPERATIONS_: Drift.\n* _ECOLOGY_: Økologi.\n* _WELFARE_: Velferd.\n* _OTHER_: Annet.\n* _PHARMACEUTICAL_: Legemiddelutvikling.\n* _SALMON_LICE_: Lakselus.","enum":["FEED","NUTRITION","FISH_HEALTH","BREED","GENETICS","TECHNOLOGY","OPERATIONS","ECOLOGY","WELFARE","OTHER","PHARMACEUTICAL","SALMON_LICE"]}}},"required":["categories","description","licenseOwnerOrgName","licenseOwnerOrgNo","name","researchInstitutionOrgName","researchInstitutionOrgNo","researchLicenses"]},"ResearchProjectOverviewResponsePage":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/ResearchProjectOverview"}},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"page":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"sort":{"type":"array","items":{"type":"string"}}}},"ResearchProject":{"type":"object","description":"Detaljert informasjon om et forskningsprosjekt.","properties":{"projectNumber":{"type":"string","description":"Prosjektnummer. Dette fungerer som et eksternt referansenummer man eksempelvis kan søke opp prosjekter med."},"name":{"type":"string","description":"Prosjektnavn"},"startDate":{"type":"string","format":"date","description":"Startdato for forskningsprosjektet."},"endDate":{"type":"string","format":"date","description":"Sluttdato for forskningsprosjektet."},"description":{"type":"string","description":"Beskrivelse av forskningsprosjektet."},"licenseOwnerOrgNo":{"type":"string","description":"Organisasjonsnummeret til tillatelsesinnehaver."},"licenseOwnerOrgName":{"type":"string","description":"Organisasjonssnavn til tillatelsesinnehaver."},"researchInstitutionOrgNo":{"type":"string","description":"Organisasjonsnummeret til forskningsinstitusjonen tilknyttet prosjektet."},"researchInstitutionOrgName":{"type":"string","description":"Organisasjonsnavnet til forskningsinstitusjonen tilknyttet prosjektet."},"researchLicenses":{"type":"array","description":"Liste med forskningstillatelser tilknyttet prosjektet.","items":{"type":"string"}},"categories":{"type":"array","description":"Liste med fagfelt tilknyttet prosjektet.","items":{"type":"string","description":"Fagfelt man kan forske på.\n* _FEED_: Fôr.\n* _NUTRITION_: Ernæring.\n* _FISH_HEALTH_: Fiskehelse.\n* _BREED_: Avl.\n* _GENETICS_: Genetikk.\n* _TECHNOLOGY_: Teknologi.\n* _OPERATIONS_: Drift.\n* _ECOLOGY_: Økologi.\n* _WELFARE_: Velferd.\n* _OTHER_: Annet.\n* _PHARMACEUTICAL_: Legemiddelutvikling.\n* _SALMON_LICE_: Lakselus.","enum":["FEED","NUTRITION","FISH_HEALTH","BREED","GENETICS","TECHNOLOGY","OPERATIONS","ECOLOGY","WELFARE","OTHER","PHARMACEUTICAL","SALMON_LICE"]}},"reports":{"type":"array","description":"Liste med rapporter som er offentliggjort.","items":{"$ref":"#/components/schemas/ResearchReport"}}},"required":["categories","description","licenseOwnerOrgName","licenseOwnerOrgNo","name","projectNumber","researchInstitutionOrgName","researchInstitutionOrgNo","researchLicenses"]},"ResearchReport":{"type":"object","description":"Forskningsrapport","properties":{"reportNumber":{"type":"string","description":"Rapportnummer. Dette fungerer som et eksternt referansenummer."},"submittedDate":{"type":"string","format":"date-time","description":"Dato rapporten ble innsendt."},"reportingYear":{"type":"string","description":"Året rapporten gjelder for. "},"reportType":{"type":"string","description":"Type rapport.","enum":["YEARLY","FINAL"]},"files":{"type":"array","description":"Liste med filer som eksisterer for rapporten.","items":{"$ref":"#/components/schemas/ResearchReportFile"}},"formSchema":{"additionalProperties":true,"description":"Skjemadefinisjon. Definisjon kan endres til enhver tid."},"formData":{"additionalProperties":true,"description":"Skjemaverdier. Definisjon kan endres til enhver tid."}}},"ResearchReportFile":{"type":"object","description":"Forskningsrapport-fil","properties":{"fileId":{"type":"string","description":"Unik ID for hver fil."},"fileName":{"type":"string","description":"Filnavn."},"isMainFile":{"type":"boolean","description":"Boolsk variabel som er sann dersom dette er hovedfilen for rapporten."}}}}}}