(WK) Instrukcja Do API REST

Machine Translated by Google
Instrukcja do API REST iBuildera

Spis treści
Logowanie (uzyskanie ApiToken) ......................................... ................................................................ ............................
2
Pobranie danych bieżących użytkownika (w tym UserID) .............................................. .......................................... 2
Pobranie list portalu portalu (dostęp tylko dla administratorów)............................................ ............................... 2
NBD-475 / NBD-476........................................... ................................................................ ............................................. 3
Wyszukiwanie pełnotekstowe (wynik prosty)............................................ ................................................................ 3 Wyszukiwanie
pełnotekstowe (wynik rozszerzony)........................................... ........................................ 3 Wyszukiwanie według słownika (wynik
prosty) .............................................................. ............................................. 7 Wyszukiwanie według słownika (wynik
rozszerzony) ................................................................................ ................................... 8

NBD-477........................................................... ................................................................ ................................................................ ......... 9
Pobranie pól do filtrowania zaawansowanego .............................................. ............................................... 9

Filtrowanie zaawansowane ................................................................ ................................................................ ........................... 11
Zliczanie dokumentów........................................................... ................................................................ ............................. 12
NBD-478........................................................... ................................................................ ................................................................ ...... 13
Wyszukiwanie dokumentów wg ID............................................................ ................................................................ ............... 13
wyszukiwanie dokumentów wg sygnatury............................ ................................................................ .............. 13

NBD-479........................................................... ................................................................ ................................................................ ...... 14
Lista różnych rodzajów dokumentów .......................................... ................................................................ .......... 14 Pobranie
podobnego rodzaju dokumentu .............................................. ................................................................ .............. 14

NBD-480........................................................... ................................................................ ................................................................ ...... 18
Lista miejsc publikacji, których użytkowników ma prawo do udostępniania i edycji ........................................... ..... 18 Lista
miejsc publikacji, do których użytkownika ma prawo przeglądania (do filtrowania)........................... ...... 18 Pobranie danych
miejsca publikacji .............................................. ................................................................ ................... 18

NBD-481........................................................... ................................................................ ................................................................ ...... 20
Dodawanie dokumentu................................................................ ................................................................ ............................. 20
NBD-482........................................................... ................................................................ ................................................................ ...... 21
Edycja dokumentu ......................................................... ................................................................ .......................................... 21

NBD-483........................................................... ................................................................ ................................................................ ...... 22
wniosek dokumentu ......................................................... ................................................................ ............................. 22
Anulowanie dokumentu........................................................... ................................................................ ............................ 22
Słownik wartości ................................................................................ ................................................................ ....................................... 23
Ważność w requestach do wyszukiwania (ocena obowiązywania)........................................... ........................... 23 FieldType w
obiektach relacji z polami dokumentu (typ pola)........... ........................................................ 23 PublishType w zgłoszeniu listy
podania i rozszerzonej (szczegóły) .............................................................. ............................ 23
Strona 1 z 23
Logowanie (uzyskanie ApiToken)

POST /api/framework/v1/login/loginUser
{
"Nazwa użytkownika": "administrator",
"Hasło": "test",
„Identyfikator urządzenia”: „LBD”
Wyniki zapytania są źródłem informacji na temat kierunku prowadzenia oraz ApiToken, który należy
przekazywać w nagłówku (Header) każdego normalnego (pod znakiem ApiToken). Przykładowy wynik:
{
"Status": prawda,
"ApiToken": "F5B5E027BBAD4CC10B22B604251EF8BEE8BB3C0935C166069EAB07E52A40A62…",
}
Pobranie danych bieżącego użytkownika (w tym UserID)
DOSTAWAĆ /api/framework/v1/bieżący użytkownik
wynik {
"UserID": 2,
"UserUID": "e792efa3-69df-4f23-acf6-44d7d1088766", "Imię":
"Administrator", "Nazwisko":
"Administrator", "Pełne
imię": "Administrator", "E-mail" :
"lbdadmin@wolterskluwer.com", "DisplayName":
"Administrator (Admin)", "CreatedDate":
"2009-07-01T00:00:00", "ModifyDate":
"2019-09-12T14:49:07.313 ", "Comment": null,
"UserName":
"Admin", "Roles":
[ { "RoleId":
1, "Name": "Wszyscy użytkownika" }, { "RoleId": 3, "Name": "
Zarejestrowani użytkownicy" }, { "RoleId": 4, "Name": "Administratorzy" },
{ "RoleId": 10, "Name": "Standardowi" użytkownika }
]
}
Pobranie list portalu (dostęp tylko dla administratorów)
DOSTAWAĆ /api/framework/v1/roles
wynik [
{ "RoleId": 3, "Name": "Zarejestrowani użytkownicy" },

{ "RoleId": 5, "Name": "Redaktorzy" },
{ "RoleId": 7, "Name": "Redaktorzy zaawansowani" }
]
Strona 2 z 23
NBD-475 / NBD-476
Uwaga! Każdy rodzaj dokumentu ma odrębną pulę identyfikatorów pól (Id). To znaczy, że np. pole „Tytuł” w typie „Instrukcja”
może mieć Id = 4708, aw typie „Regulamin” będzie np. 10. W związku z tym podczas mapowania pól należy użyć atrybutu
„Nazwa”.
Wyszukiwanie pełnotekstowe (wynik prosty)
POST /api/repository/v1/search/text
Żądanie: SearchByTextDto
Odpowiedź: DocumentSearchResultDto[]
{
"Pomiń": 0,
„Weź”: 20,
"Ważność": 1,
"ValidityDate": "2019-07-21",
„Text”: „Wyszukiwana fraza”
}
Wyniki zapytania są listą prostych informacji na temat dokumentów (id, nazwa, czy opublikowane, czy anulowane).
Przykładowy wynik:
[
{
"Identyfikator dokumentu": 60848,
"Title": "Równania/2019/07/03/0001",
"IsCancelled": fałsz,
"IsPublished": fałsz,
"Typ publikowania": 4,
"Ważność":5,
„Pola”: [
{"Value":null,"Id":5,"Typ":1,"Label":"Tytuł","Nazwa":"Tytuł"},
{"Value":null,"Id":6,"Typ":5,"Label":"Dane dokumentu","Nazwa":"Dane dokumentu"},
{"Value":null,"Id":11,"Type":9,"Label":"Autorzy","Nazwa":"Autorzy"}
]
}
]
Wyszukiwanie pełnotekstowe (wynik rozszerzony)
POST /api/repository/v1/search/text/details
Żądanie: SearchByTextDto
Odpowiedź: DokumentDto[]
{
"Pomiń": 0,
„Weź”: 20,
"Ważność": 1,
Strona 3 z 23
„Text”: „Wyszukiwana fraza”
}
Wyniki wyszukiwania są listą wykorzystanych informacji na temat dokumentów (id, nazwa, wartości
wszystkich pól). Przykładowy wynik:
[{
"Id": 20739,
"Title": "PK1.1", "Kod
kreskowy": null,
"Timestamp": "AAAAAAAB/LBQ=",
"UID": "58c0b86b-257b-4b9a-b637-5ca220166705", "
DocVersion": 2,
"CurrentVersion": 2,
"Major": null,
"Minor": null,
"Creator": "piotr.chmiel2@",
"CreatedDate": "2018-09-25T12:54:50", "Modifier":
"piotr.chmiel2@", "ModifiedDate":
"2018-09-25T12:57:53", "Blocker": null,
"BlockExpiration":
null, "BlockType": 3, "IsBlocker":
fałsz , "IsOwner":
false, "IsModifier": false,
"HasActiveProcess":
false, "Activities": null,
"ProcessAcls": null, "FolderPath":
null, "Link": "http://
localhost:60281/ api/
repository/v1/documents/
20739", "ProcessTypeId": null, "UserNotifications": null, "Status": 0, "Validity": 0,
"PublishDate": null,
"PublishedBy": null, "IsPublished" :
false,
"PublishType": 3,
"DocType": { "DocTypeId":
1037, "Name":
"Zarządzenie", "Description":
null
},
"Pola": [{
"Wartość": "PCh D1 25.09.18", "Id":
4990, "Typ":
1,
"Wymagane": true,
"Label": "Tytuł",
"Nazwa": "Tytuł", "Id
słownika": null,
"CustomControl": null
}, {
"Wartość": [],
"Id": 4992,
"Typ": 8,
„Wymagane”: fałsz,
"Wytwórnia": "Relacje",
"Nazwa": "Relacje",
"Identyfikator słownika": null,
Strona 4 z 23
}, {
"Wartość": {
"AllowToChangeSignatureGenerationMode": fałsz,
„CreateSignatureFromUnit”: prawda,
"Wartości pól": [{
"Wartość": "1",
"DictionaryEntry": null,
„IsManuallyEdited”: fałsz
}, {
"Wartość": zerowa,
}, {
}, {
}, {
}, {
}
],
„Identyfikator wybranej jednostki”: 17
},
"Id": 4989,
"Typ": 9,
„Wymagane”: prawda,
"Label": "Miejsce publikacji",
"Nazwa": "Miejsce publikacji",
}, {
"Wartość": "2018-09-25T00:00:00",
"Id": 4991,
"Typ": 5,
"Etykieta": "Dane dokumentu",
"Nazwa": "Dane dokumentu",
}, {
"Wartość": "<p>dsadsa</p>\r\n",
"Id": 6116,
"Typ": 2,
"Etykieta": "Tekst", dokumentu
"Nazwa": "Tekst", dokumentu
}, {
"Wartość": 586,
"Id": 4993,
"Typ": 3,
Strona 5 z 23
"Etykieta": "Numer wewnętrzny",
"Nazwa": "Numer wewnętrzny",
}, {
"Wartość": [{
"FileID": 266,
"FileName": "j.xls",
"FileType": "vnd.ms-excel",
"FileExtension": "xls", "Rozmiar":
12288, "Url":
"http://localhost:60281/Module/Xhn3Na/GetFile.ashx?lang=pl
PL&z=dWQ76rSJMRPSUM9fYaJggONCDdsP477wkf54fUXei4s=",
"TempId": zero,
"Base64Data": zero
}
],
"Id": 4994,
"Typ": 7,
"Etykieta": "Treść dokumentu",
"Nazwa": "Treść dokumentu",
}, {
"Wartość": [{
"FileID": 265,
"FileName": "h.xls",
"FileType": "vnd.ms-excel",
"FileExtension": "xls", "Rozmiar":
35840, "URL":
"http://localhost:60281/Module/Xhn3Na/GetFile.ashx?lang=pl
PL&z=1QajG22waCrA4meTfuapSthPqXeGUAY/pYdxJge3N2c=",
"TempId": zero,
"Base64Data": zero
}
],
"Id": 4995,
"Typ": 7,
"Etykieta": "Załączniki",
"Nazwa": "Załączniki",
}, {
"Value": "Utrata mocy: wygaśnięcie z dnia: 2018-09-24.", "Id": 4996, "Type": 9,
"Required":
false, "Label":
"Informacja o utracie
ważności", "Name": "Informacja o utracie ważności",
"DictionaryId": null, "CustomControl": null
}, {
"Wartość": "2018-09-11T00:00:00",
"Id": 5010,
"Typ": 5,
"Label": "Dane obowiązywania od",
Strona 6 z 23
"Nazwa": "Dane obowiązywania od",

}, {
"Wartość": "2018-09-24T00:00:00",
"Id": 5011,
"Typ": 5,
"Label": "Dane obowiązywania do",
"Nazwa": "Dane obowiązywania do",
}, {
"Value":
{ "IsActive": false, "Days":
30, "Emails": [],
"NewEmail": null,
"MyEmail": "rh@exant.pl"
},
"Id": 5012,
"Typ": 9,
"Label": "Powiadomienie e-mail",
"Nazwa": "Powiadomienie e-mail",
}, {
"Id": 5014,
"Typ": 6,
"Wytwórnia": "Archiwalny",
"Nazwa": "Archiwalny",
}
],
"Uprawnienia": [],
"Kategorie": [],
"Powiadomienia": []
}]
Wyszukiwanie według słownika (wynik prosty)
POST /api/repozytorium/v1/search/dictionary
Żądanie: SearchByDictionaryDto
Odpowiedź: DocumentSearchResultDto[]
{
"Pomiń": 0,
„Weź”: 20,
"Ważność": 1,
"AllWords": "Z każdym ze słów",
"Wyrażenie": "Fraza",
"AnyWords": "Którekolwiek ze słów",
„Bez słów”: „Bez słów”
}
Strona 7 z 23
Wyniki zapytania są listą prostych informacji na temat dokumentów (id, nazwa, czy opublikowane, czy anulowane). Formatuj
taki sam, jak wynik wyszukiwania pełnotekstowego.
Wyszukiwanie według słownika (wynik rozszerzony)

POST /api/repository/v1/search/dictionary/details
Żądanie: SearchByDictionaryDto
Odpowiedź: DokumentDto []
{
"Pomiń": 0,
„Weź”: 20,
"Ważność": 6,
"AllWords": "Z każdym ze słów",
"Wyrażenie": "Fraza",
"AnyWords": "Którekolwiek ze słów",
„Bez słów”: „Bez słów”
}
Wyniki wyszukiwania są listą wykorzystanych informacji na temat dokumentów (id, nazwa, wartości wszystkich pól).
Formatuj tak sam, jak wynik wyszukiwania pełnotekstowego.
Strona 8 z 23
NBD-477
Pobranie pól do filtrowania zaawansowanego

DOSTAWAĆ api/repository/v1/advancedsearch/fields
lub
DOSTAWAĆ api/repository/v1/advancedsearch/fields/{id_rodzaju_dokumentu}
Żądanie: brak
Odpowiedź: SearchFieldReadDto[]
Wyniki wyszukiwania są listą pobranych pól dostępnych w filtrowaniu zabezpieczeń. W przypadku listy pobierania pól
dla każdego rodzaju dokumentu, lista może zawierać więcej pól – m. w polach słownikowych. Przykładowy wynik:
[{
"Id": 1,
"FieldName": "Miejsce publikacji", "FieldType":
9, "DictionaryId":
null, "MaxLength": null,
"CustomControl":
"ASP_eXant.iBuilder2.Modules.LBD, Version=1.0. 0.0,
Control=Controls.Workflow.Units.UnitControl.ascx", "Format danych":
null
}, {
"Id": -6,
"FieldName": "Rodzaj",
"Typ pola": 1,
"MaxLength": null,
"CustomControl": zero,
"Format danych": null
}, {
"Identyfikator": 10,
"FieldName": "Autorzy",
"Typ pola": 12,
"Identyfikator słownika": 3,
"MaxLength": null,
}, {
"Identyfikator": 2,
"FieldName": "Tytuł",
"Typ pola": 1,
"Maksymalna długość": 4000,
}, {
"Identyfikator": 6,
"FieldName": "Treść dokumentu",

"Typ pola": 7,
"MaxLength": null,
Strona 9 z 23
}, {
"Identyfikator": 3,
"FieldName": "Dane dokumentu",

"Typ pola": 5,
"MaxLength": null,
}, {
"FieldName": "Dane obowiązywania od",

"Typ pola": 5,
"MaxLength": null,
}, {
"FieldName": "Dane obowiązywania do",

"Typ pola": 5,
"MaxLength": null,
}, {
"Id": 13,
"FieldName": "Dane publikacji",
"Typ pola": 5,
"MaxLength": null,
}, {
"Identyfikator": 5,
"FieldName": "Numer wewnętrzny",

"Typ pola": 3,
"MaxLength": null,
}, {
"Id": -25,
"FieldName": "Hasła",
"Typ pola": 9,
"MaxLength": null,
}, {
"Identyfikator": -35,
"FieldName": "Czy opublikowany",

"Typ pola": 6,
"MaxLength": null,
}, {
Strona 10 z 23
"Id": -24,
"FieldName": "Utworzony przez",
"Typ pola": 3,
"MaxLength": null,
}]
Filtrowanie zaawansowane
POST api/repozytorium/v1/wyszukiwanie zaawansowane

POST api/repozytorium/v1/wyszukiwanie zaawansowane/szczegóły
POST api/repository/v1/advancedsearch/dt/{id_rodzaju_dokumentu}
POST api/repository/v1/advancedsearch/dt/{id_rodzaju_dokumentu}/details
Żądanie: AdvancedSearchDto
Odpowiedź: DocumentSearchResultDto[] / DocumentDto[] (wynik rozszerzony)
Wniosek: {
"Pomiń": 0,
„Weź”: 20,
„Pola”:
[
{ "Id": 3, "Wartość": { "Od": "2019-01-01", "Do": null } },
{ "Id": 10, "Wartość": [ { "Nazwa": "Rada Miasta" } ] }
],
Wyniki wyszukiwania są listą danych pochodzących z badań korzystających z kryteriów wyszukiwania. Formatuj taki sam,
jak wynik wyszukiwania pełnotekstowego.
W celu filtrowania dokumentów po rodzaju, należy użyć adresu z zmienną {id_rodzaju_dokumentu} np. api/repository/v1/
advancedsearch/dt/1024 (gdzie 1024 do identyfikatora rodzaju).
Postać „Value” filtr w zależności od typu pola (FieldType):
a) liczba całkowita (3), rzeczywista (4) oraz data (5) - obiekt zawiera 2 atrybuty: From oraz To (wymagany jest co
najmniej jeden z nich), np. dla daty { "Od":
"2019-01-01T00:00:00", "Do": "2019-06-31T23:59:59" } dla liczby { "Od": 15 }
b) plik (7) – obiekt z atrybutami WithAllWords, WithPhrase, WithAnyWord, WithoutWords, np.

{ "WithAllWords": "a", "WithPhrase": "b", "WithAnyWord": "c", "Bez słów": "d" }
c) słownik jednokrotnego wyboru (15) – obiekt zawierający atrybut „Nazwa”, np.

{ "Nazwa":"Rada Miasta" }
d) słownik wyboru wyboru (12) – obiekt zawierający tablicę obiektu z atrybutem „Nazwa”,
np.
Strona 11 z 23
[ { "Nazwa":"Rada Miasta" } ]
e) pole tekstowe ze słownikiem (1) + DictionaryId – jak niezwykły tekst, np.

„Rada Miasta”
f) miejsce publikacji (pole typu 9 – xml, pole Id = 1) – obiekt z atrybutem „SelectedUnitId” oraz możliwość
filtrowania po polach jednostki kolekcji „FieldValues” określającej wartość w „Value”, np.
{ "SelectedUnitId": 72 } // filtrowanie po prostu
{ "SelectedUnitId": 72, "FieldValues" : wartość pierwszego [ { "Wartość":"1" } ] } // dodatkowy filtr na

pola = „1” (zawsze tekstowo)
{ "SelectedUnitId": 72, "FieldValues" : [ { "Value": null }, { "Value":"Wartość" }] } // dodatkowy filtr na

wartość drugiego pola = „Wartość” (zawsze tekstowo)
{ "SelectedUnitId": 72, "FieldValues" : // dodatkowy [ { "Wartość": "1" }, { "Wartość": "2" }] }

filtr na wartość pierwszego i drugiego pola g) filtrowanie po słowie (pole Id =
-25)
[ { "Id":"12" } ] // gdzie 12 to identyfikator hasła
Zliczanie dokumentów
POST api/repository/v1/advancedsearch/count
POST api/repository/v1/advancedsearch/dt/{id_rodzaju_dokumentu}/count
Żądanie: AdvancedSearchDto
Odpowiedź: DocumentCountResultDto
Przykładowy wniosek pobierający dokumenty.
Wniosek:
{
„Pola”: [
{ "Id": -35, "Wartość": prawda},

],
Odpowiedź :
{ "Liczba": 413 }
Strona 12 z 23
NBD-478
Wyszukiwanie dokumentów wg ID
DOSTAWAĆ /api/repository/v1/documents/{id_dokumentu}
Odpowiedź: DocumentDto
Szukaj dokumentów wg sygnatury
POST api/repozytorium/v1/wyszukiwanie/tytuł
POST api/repozytorium/v1/wyszukiwanie/tytuł/szczegóły
Żądanie: SearchByTitleDto
Odpowiedź: DocumentSearchResultDto [] / DocumentDto[] (szczegóły)
Wniosek:
{
"Pomiń": 0,
„Weź”: 20,
"Ważność": zerowa,
"ValidityDate": null,
"Title": "Wyszukiwana sygnatura"
}
Strona 13 z 23
NBD-479
Lista różnych rodzajów dokumentów

DOSTAWAĆ /api/repository/v1/document-types
Odpowiedź: DocTypeReadDto[]
Przykładowa odpowiedź: [
{
"DocTypeId": 1028,
"Nazwa": "Instrukcja",
"Opis": brak
}, {
"DocTypeId": 2041,
"Nazwa": "Rodzaj publikacyjny",
"Opis": brak
}, {
"DocTypeId": 1037,
"Nazwa": "Zarządzenie",
"Opis": brak
}, {
"DocTypeId": 4,
"Nazwa": "Umowa",
"Opis": brak
}, {
"DocTypeId": 5,
"Nazwa": "Uchwały",
"Opis": brak
}
]
Pobranie równorzędnego rodzaju dokumentu

DOSTAWAĆ /api/repository/v1/document-types/{id_rodzaju}
Odpowiedź: DocumentTypeDto
Uwaga! Każdy rodzaj dokumentu ma odrębną pulę identyfikatorów pól (Id). To znaczy, że np. pole „Tytuł” w typie
„Instrukcja” może mieć Id = 4708, aw typie „Regulamin” będzie np. 10.
Przykładowa odpowiedź: {
"DocTypeId": 1028,
"Nazwa": "Instrukcja",
"Opis": brak,
"Pola": [{
"Id": 4708,
"Typ 1,
"Wytwórnia": "Tytuł",
"Nazwa": "Tytuł",
}, {
"Id": 4709,
"Typ": 9,
Strona 14 z 23
"Label": "Miejsce publikacji",

"Kontrola niestandardowa": {
"Moduł": "LBD",
„Nazwa”: „Kontrola jednostki”
}
}, {
"Id": 4710,
"Typ": 5,
"Etykieta": "Dane dokumentu",
"Nazwa": "Dane dokumentu",
}, {
"Id": 4711,
"Typ": 5,
"Label": "Dane obowiązywania od",
"Nazwa": "Dane obowiązywania od",
}, {
"Id": 4712,
"Typ": 5,
"Label": "Dane obowiązywania do",
"Nazwa": "Dane obowiązywania do",
}, {
"Id": 4713,
"Typ": 9,
"Wytwórnia": "Autorzy",
"Nazwa": "Autorzy",
"Moduł": "Repozytorium",
"Nazwa": "MultiSelectControl"
}
}, {
"Id": 4714,
"Typ": 8,
"Wytwórnia": "Relacje",
"Nazwa": "Relacje",
"Moduł": "LBD",
„Nazwa”: „Kontrola relacji”
}
}, {
"Id": 4716,
"Typ": 7,
"Etykieta": "Treść dokumentu",
Strona 15 z 23
"Nazwa": "Treść dokumentu",

}, {
"Id": 4717,
"Typ": 7,
"Etykieta": "Załączniki",
"Nazwa": "Załączniki",
}, {
"Id": 4718,
"Typ": 9,
"Label": "Informacja o utracie ważności",
"Nazwa": "Informacja o utracie ważności",
"Moduł": "LBD",
"Nazwa": "ValidityDescriptionControl"
}
}, {
"Id": 6440,
"Typ": 6,
"Etykieta": "cnvTakNie",
"Nazwa": "cnvTakNie",
}, {
"Id": 6443,
"Typ 1,
"Etykieta": "Test AD",
"Nazwa": "Test AD",
}, {
"Id": 6444,
"Typ": 6,
"Etykieta": "ml",
"Nazwa": "ml",
}, {
"Id": 6445,
"Typ 1,
"Label": "Kasi pole słownik1",
"Nazwa": "Kasi pole słownik1",
„Nazwa”: „SingleSelectControl”
}
}, {
Strona 16 z 23
"Id": 6446,
"Typ 1,
"Wytwórnia": "Przemek",
"Imię": "Przemek",
}
}, {
"Id": 6447,
"Typ 1,
"Etykieta": "Słownik duży",
"Nazwa": "Słownik duży",
}
}
]}
Strona 17 z 23
NBD-480
Lista miejsc publikacji, których użytkowników ma prawo do publikacji i edycji
DOSTAWAĆ /api/lbd/v1/jednostki
Odpowiedź: UnitListDto[]
Przykładowa odpowiedź: [
{
"Identyfikator jednostki": 19,
"Nazwa": "Dział HR"

}, {
"Nazwa": "Dział prawny"

}, {
"Nazwa": "Zarządzania Prezesem Sądu"

}, {
"Nazwa": "Zarządzenie Asystenta Rektora"

}, {
"Nazwa": "Zarządzenie Rektora"

}
]
Lista miejsc publikacji, których użytkowników ma prawo przeglądania (do filtrowania)

DOSTAWAĆ /api/lbd/v1/jednostki/filtr
Odpowiedź: UnitListDto[]
Odpowiedź w takim samym formacie jak poprzednia prośba.
Pobranie danych miejsc publikacji

DOSTAWAĆ /api/lbd/v1/jednostki/{identyfikator}
Odpowiedź: UnitDto

"Krótka nazwa": "MP",
"Pola": [{
"Nazwa": "Biegun 1",
"Typ": 4,
"AllowManualEdit": fałsz,
"IsYearDependent": prawda,
"IsDictionaryDependent": fałsz,
"DictFieldIndex": 0
}, {
"Nazwa": "Polak 2",
"Typ": 4,
Strona 18 z 23
"IsYearDependent": fałsz,
"DictFieldIndex": 0
}, {
"Nazwa": "Biegun 3",
"Typ": 4,
"DictFieldIndex": 0
}, {
„Nazwa”: „Słup 4”,
"Typ": 2,
"DictFieldIndex": 0
}
]
}
Typy pól („Typ”):

1 – tekst
2 – rok
3 – słownik
4 – autonumerowane
Strona 19 z 23
NBD-481
Dodawanie dokumentu
POST /api/repository/v1/documents/fid/6/dt/{docTypeId}
Żądanie: DocumentUpdateRequestDto
Odpowiedź: DocumentCreatedResponseDto
Przykładowe żądanie: {
"Pola": [ {
"Id": 4708,
"Wartość": "Tytuł dokumentu"
},
{
"Id": 4709,
"Wartość": {
"Wartości pól": [ { "Wartość": "1" } ],
„Identyfikator wybranej jednostki”: 72
}
},
{
"Id": 4710,
"Wartość": "\/Data(1563746400000+0200)\/"
}
]}
"Id": 15593,
"Title": "B.6.18.18",
"IdForStatistics": 15593,
"ErrorCode": null,
"ErrorMessage": null,
"SuccessMessage": null,
"RepoErrorCode": null
}
Więcej informacji na temat tworzenia dokumentu w pliku Instrukcja tworzenia i edycji

dokumentów (iBuilder REST API).docx
Strona 20 z 23
NBD-482
Edycja dokumentu
UMIEŚCIĆ /api/repository/v1/documents/d/{identyfikator dokumentu}/fid/5
Żądanie: DocumentUpdateRequestDto
Odpowiedź: DocumentCreatedResponseDto
Pola Timestamp oraz DocVersion są wymagane. Służą one do zarządzania współbieżnym postępowaniem do
dokumentów (zabezpieczenie przed nadpisaniem zmian dokonanych przez innego użytkownika). Można uzyskać pobranie
dokumentu (/api/repository/v1/documents/{id_dokumentu}).
Przykładowe żądanie: {
"Znacznik czasu": "AAAAAAB/LBQ=",

"DocVersion": 2,
"Pola": [ {
"Id": 5449,
"Wartość": "2019-06-28T14:30:18.7417133+02:00" }, {
"Id": 5447,
"Wartość": {
"Identyfikator wybranej jednostki": 1,
"Wartości pól": [ {
"Wartość": null }, {
„Wartość”: „XXX”
}
]
} }, {
"Id": 5452,
"Value": "[{\"Base64Data\":\"JVBERi0xLjQNCiXT9MzhDQoxIDA(dane skrócone ze względu na na
długość)\",\"NazwaPliku\":\"Plik.pdf\"}]"
}
}
„Id”: 15593,
„Title”: „MP.64”, „Kod
błędu”: zero, „Message”:
zero, „SuccessMessage”: zero,
„RepoErrorCode”: zero
Więcej informacji na temat tworzenia dokumentu w pliku Instrukcja tworzenia i edycji

dokumentów (iBuilder REST API).docx
Strona 21 z 23
NBD-483
dokumentu
USUWAĆ /api/repository/v1/documents/{identyfikator dokumentu}
Odpowiedź: DeleteOrCancelResultDto
Odpowiedź po wzroście korzyści: {
"IsError": false,
"Message": "Wybrane usunięte zostały usunięte."
}
Odpowiedź, gdy błąd:

{
"IsError": true,
"Message": "Dokument nie istnieje."
}
Anulowanie dokumentu
USUWAĆ /api/repository/v1/documents/{documentId}/cancel
Odpowiedź: DeleteOrCancelResultDto
Odpowiedź po poprawie: {
"IsError": false,
"Message": "Wybrane usunięte zostały usunięte."
}
Odpowiedź, gdy błąd:

{
"IsError": true,
"Message": "Dokument nie istnieje."
}
Strona 22 z 23
Słownik wartości
Ważność w requestach do wyszukiwania (ocena obowiązywania)
1 – wcześnie 2 –
archiwalne 3 –
anulowane 4 –
wszędziece 5 –
nieoceniane 6 –
wszystkie
FieldType w obiektach związanych z polami dokumentu (typ pola)
1 – tekst 2
– długi tekst 3 –
liczba całkowita 4 – liczba
rzeczywista 5 – data 6 –
prawda/
fałsz dokumentu (true/false) 7 – plik
8 – link
(do innego lub zmiany URL) 9 – pole typu XML, związany z
dedykowaną kontrolką 12 – pole słownikowe wyboru 15 – pole
słownikowe jednokrotnego wyboru
PublishType w liście treści i rozszerzonej (szczegóły)
0 – nieopublikowany 1 -
opublikowany z badania polami typu "plik" (załącznikami) 2 - opublikowany bez
pól plików (bez zastosowania) 3 - opublikowany z polem pliku "Treść
dokumentu" (bez innych pól plików) 4 - opublikowany z polami plików, ale bez pola "Treść dokumentu"
Strona 23 z 23

(WK) Instrukcja Do API REST

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

(WK) Instrukcja Do API REST

Uploaded by

Copyright:

Available Formats

Machine Translated by Google

Instrukcja do API REST iBuildera

Pobranie danych bieżących użytkownika (w tym UserID) .............................................. .......................................... 2

Pobranie list portalu portalu (dostęp tylko dla administratorów)............................................ ............................... 2

NBD-475 / NBD-476........................................... ................................................................ ............................................. 3

Wyszukiwanie pełnotekstowe (wynik prosty)............................................ ................................................................ 3 Wyszukiwanie

pełnotekstowe (wynik rozszerzony)........................................... ........................................ 3 Wyszukiwanie według słownika (wynik

prosty) .............................................................. ............................................. 7 Wyszukiwanie według słownika (wynik

rozszerzony) ................................................................................ ................................... 8

Pobranie pól do filtrowania zaawansowanego .............................................. ............................................... 9

Zliczanie dokumentów........................................................... ................................................................ ............................. 12

NBD-478........................................................... ................................................................ ................................................................ ...... 13

Wyszukiwanie dokumentów wg ID............................................................ ................................................................ ............... 13

wyszukiwanie dokumentów wg sygnatury............................ ................................................................ .............. 13

Lista różnych rodzajów dokumentów .......................................... ................................................................ .......... 14 Pobranie

podobnego rodzaju dokumentu .............................................. ................................................................ .............. 14

miejsca publikacji .............................................. ................................................................ ................... 18

Dodawanie dokumentu................................................................ ................................................................ ............................. 20

NBD-482........................................................... ................................................................ ................................................................ ...... 21

Edycja dokumentu ......................................................... ................................................................ .......................................... 21

wniosek dokumentu ......................................................... ................................................................ ............................. 22

Anulowanie dokumentu........................................................... ................................................................ ............................ 22

Słownik wartości ................................................................................ ................................................................ ....................................... 23

Ważność w requestach do wyszukiwania (ocena obowiązywania)........................................... ........................... 23 FieldType w

podania i rozszerzonej (szczegóły) .............................................................. ............................ 23

Logowanie (uzyskanie ApiToken)

Pobranie danych bieżącego użytkownika (w tym UserID)

DOSTAWAĆ /api/framework/v1/bieżący użytkownik

Pobranie list portalu (dostęp tylko dla administratorów)

{ "RoleId": 3, "Name": "Zarejestrowani użytkownicy" },

Wyszukiwanie pełnotekstowe (wynik prosty)

Wyszukiwanie pełnotekstowe (wynik rozszerzony)

"Nazwa": "Dane obowiązywania od",

Wyszukiwanie według słownika (wynik prosty)

Wyszukiwanie według słownika (wynik rozszerzony)

Pobranie pól do filtrowania zaawansowanego

"FieldName": "Treść dokumentu",

"Format danych": null

"FieldName": "Dane dokumentu",

"FieldName": "Dane obowiązywania od",

"FieldName": "Dane obowiązywania do",

"FieldName": "Numer wewnętrzny",

"FieldName": "Czy opublikowany",

POST api/repozytorium/v1/wyszukiwanie zaawansowane

Postać „Value” filtr w zależności od typu pola (FieldType):

b) plik (7) – obiekt z atrybutami WithAllWords, WithPhrase, WithAnyWord, WithoutWords, np.

c) słownik jednokrotnego wyboru (15) – obiekt zawierający atrybut „Nazwa”, np.

e) pole tekstowe ze słownikiem (1) + DictionaryId – jak niezwykły tekst, np.

{ "SelectedUnitId": 72 } // filtrowanie po prostu

{ "SelectedUnitId": 72, "FieldValues" : wartość pierwszego [ { "Wartość":"1" } ] } // dodatkowy filtr na

{ "SelectedUnitId": 72, "FieldValues" : [ { "Value": null }, { "Value":"Wartość" }] } // dodatkowy filtr na

{ "SelectedUnitId": 72, "FieldValues" : // dodatkowy [ { "Wartość": "1" }, { "Wartość": "2" }] }

Przykładowy wniosek pobierający dokumenty.

{ "Id": -35, "Wartość": prawda},

Szukaj dokumentów wg sygnatury

Lista różnych rodzajów dokumentów

Pobranie równorzędnego rodzaju dokumentu

"Label": "Miejsce publikacji",

"Nazwa": "Treść dokumentu",

"Nazwa": "Dział HR"

"Nazwa": "Dział prawny"

"Nazwa": "Zarządzania Prezesem Sądu"

"Nazwa": "Zarządzenie Asystenta Rektora"