Przejdź do treści Przejdź do głównej nawigacji Przejdź do stopki

Profile Instytucji (institution-profile-controller)

institution-profile-controllerREST API związane z profilami instytucji

 

DELETE
/v1​/institutionProfile​/publications
Usunięcie oświadczeń w ramach instytucji zalogowanego użytkownika

OPIS:
Końcówka umożliwia usunięcie pojedynczego oświadczenia lub wielu oświadczeń w ramach instytucji zalogowanego użytkownika. Oświadczenia mogą być usuwane dla jednej lub wielu wskazanych publikacji.

W celu usunięcia oświadczeń niezbędne jest wprowadzenie X-App-Id, X-App-Token oraz X-User-Token w nagłówkach (headers). Usunięcie danych z Profilu Instytucji wymaga autoryzacji, analizie poddawane są wprowadzone tokeny – sprawdzane jest posiadanie roli Importera Publikacji dla podmiotu, z którego usuwane są dane (Importer najwyższego rzędu lub Importer Instytucji podrzędnej).

W ciele żądania konieczne jest wskazanie:

publicationId – ID publikacji, dla których oświadczenia mają zostać usunięte – możliwe jest podanie jednej lub wielu publikacji;

statementsOfPersons –  ze wskazaniem PersonID – ID osób, których oświadczenia mają zostać usunięte ze wskazanej publikacji (możliwe jest wskazanie jednej lub wielu osób).

ZASTOSOWANIE:
opis w przygotowaniu

 

GET
/v1/institutionProfile/publications/page
Pobieranie strony z publikacjami instytucji użytkownika

OPIS:
Końcówka umożliwia pobranie listy publikacji znajdujących się w Profilu Instytucji (są to wszystkie publikacje, które wezmą udział w procesie ewaluacji) użytkownika wykonującego żądanie. Aby pobrać listę publikacji z Profilu Instytucji niezbędne jest wprowadzenie X-App-Id, X-App-Token oraz X-User-Token w nagłówkach (headers). X-User-Token, czyli token użytkownika jest wymagany w przypadku tej końcówki, ponieważ pobranie danych o publikacjach z danego podmiotu wymaga dodatkowej autoryzacji – analizie poddawane są wprowadzone tokeny – sprawdzane jest posiadanie roli Importera Publikacji dla podmiotu, z którego pobierane są dane (Importer najwyższego rzędu lub Importer Instytucji podrzędnej).

Żądanie zwróci pełne dane wszystkich publikacji, które znajdują się w Profilu Instytucji zautoryzowanego użytkownika. Dla poszczególnych publikacji wyniki żądania zawierają między innymi: dane autorów (oraz inne role osób, o ile występują) oraz ich numery ORCID (jeśli są powiązani z ORCID i POL-on), objectId publikacji, typ publikacji, tytuł, DOI lub URL, rok wydania, informację o Open Access, abstrakt, informacje o czasopiśmie, wydawnictwie lub konferencji, afiliacje osób, itd. W tej końcówce nie ma informacji o dyscyplinach oświadczeń osób.

ZASTOSOWANIE:
opis w przygotowaniu

 

GET
/v1/institutionProfile/publications/page/statements
Pobieranie strony z oświadczeniami instytucji użytkownika

OPIS:
Końcówka umożliwia pobranie listy oświadczeń znajdujących się w Profilu Instytucji użytkownika wykonującego żądanie. Aby pobrać listę publikacji z Profilu Instytucji niezbędne jest wprowadzenie X-App-Id, X-App-Token oraz X-User-Token w nagłówkach (headers). X-User-Token, czyli token użytkownika jest wymagany w przypadku tej końcówki, ponieważ pobranie danych o publikacjach z danego podmiotu wymaga dodatkowej autoryzacji – analizie poddawane są wprowadzone tokeny – sprawdzane jest posiadanie roli Importera Publikacji dla podmiotu, z którego pobierane są dane (Importer najwyższego rzędu lub Importer Instytucji podrzędnej).

Żądanie zwróci listę wszystkich oświadczeń z Profilu Instytucji zautoryzowanego użytkownika. Na informacje o poszczególnych oświadczeniach składa się id oświadczenia (id), object ID instytucji (institutionId), object ID osoby (personId), object ID publikacji (publicationId), data dodania oświadczenia, dyscyplina oświadczona, informacja czy publikacja znajduje się na koncie ORCID osoby oraz rola osoby w publikacji.

ZASTOSOWANIE:
opis w przygotowaniu

 

DELETE
​/v1​/institutionProfile​/publications​/{id}
Usunięcie oświadczeń o danej publikacji w ramach instytucji zalogowanego użytkownika

OPIS:
Końcówka umożliwia usunięcie pojedynczego oświadczenia, wielu oświadczeń lub wszystkich oświadczeń z konkretnej publikacji w ramach instytucji zalogowanego użytkownika.

W celu usunięcia oświadczeń niezbędne jest wprowadzenie X-App-Id, X-App-Token, X-User-Token w nagłówkach (headers). Dodatkowo należy wskazać ID publikacji w żądaniu, dla której mają być usunięte oświadczenia. Usunięcie danych z Profilu Instytucji wymaga autoryzacji, analizie poddawane są wprowadzone tokeny – sprawdzane jest posiadanie roli Importera Publikacji dla podmiotu, z którego usuwane są dane (Importer najwyższego rzędu lub Importer Instytucji podrzędnej).

W ciele żądania konieczne jest wskazanie, czy chcemy usunąć konkretne oświadczenia dla danej publikacji, czy wszystkie oświadczenia: flaga true lub false oraz podać tablicę statementsOfPersons – ze wskazaniem PersonID – ID osób, których oświadczenia mają zostać usunięte z publikacji (możliwe jest wskazanie jednej lub wybranych osób (flaga false) lub wszystkich osób flaga – true).

ZASTOSOWANIE:
opis w przygotowaniu