Udostępnij przez

Almanac (niezależny wydawca) (wersja zapoznawcza)

Almanac buduje wspólną infrastrukturę, aby służyć ludzkiej kreatywności. Korzystając z najszybszego narzędzia typu wiki i przepływu pracy, skonsoliduj dokumenty w pięknym, zorganizowanym pojedynczym źródle prawdy.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Logic Apps Standard Wszystkie regiony usługi Logic Apps z wyjątkiem następujących:
     — Regiony platformy Azure Government
     — Regiony platformy Azure (Chiny)
     - Departament Obrony USA (DoD)
Power Apps Premium Wszystkie regiony usługi Power Apps z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Power Automate Premium Wszystkie regiony usługi Power Automate z wyjątkiem następujących:
     - Rząd USA (GCC)
     - Rząd USA (GCC High)
     - China Cloud obsługiwane przez firmę 21Vianet
     - Departament Obrony USA (DoD)
Kontakt
Name Troy Taylor
adres URL https://www.hitachisolutions.com
Email ttaylor@hitachisolutions.com
Metadane łącznika
Publisher Troy Taylor
Witryna internetowa https://almanac.io/
Zasady ochrony prywatności https://almanac.io/privacy-policy
Kategorie Kolaboracja; Zawartość i pliki

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:
Wartość domyślna Parametry tworzenia połączenia. Wszystkie regiony Nie można udostępniać

Domyślny

Dotyczy: Wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja Power App zostanie udostępniona innemu użytkownikowi, inny użytkownik zostanie poproszony o jawne utworzenie nowego połączenia.

Name Typ Description Wymagane
Identyfikator obszaru roboczego ciąg Identyfikator obszaru roboczego dla tego interfejsu API. Prawda
Token dostępu (w postaci "Bearer yourAccessToken") securestring Token dostępu (w postaci "Bearer yourAccessToken") dla tego interfejsu API. Prawda

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 100 60 sekund

Akcje

Aktualizowanie dostępu do dokumentów

Aktualizowanie dostępu do dokumentu.
Aktualizowanie informacji o dokumencie

Aktualizowanie metadanych informacji o dokumencie.
Aktualizowanie informacji o folderze

Aktualizowanie metadanych folderu.
Dodawanie dostępu do dokumentów

Dodaj dostęp do dokumentu.
Dodawanie właściwości dokumentu

Dodaj właściwość niestandardową do dokumentu.
Importowanie dokumentu

Zaimportuj dokument ze źródła zewnętrznego.
Pobieranie dokumentów

Pobierz metadane wszystkich dokumentów w obszarze roboczym.
Pobieranie elementów podręcznika

Pobieranie listy elementów podręcznika.
Pobieranie folderów

Pobierz listę wszystkich folderów.
Pobieranie grup

Pobieranie grup użytkowników.
Pobieranie importu

Pobieranie informacji o istniejącym importowaniu.
Pobieranie informacji o dokumencie

Pobieranie metadanych informacji o dokumencie.
Pobieranie podręczników

Pobieranie listy podręczników obszaru roboczego.
Pobieranie użytkowników

Pobieranie listy użytkowników.
Pobieranie użytkowników w grupie

Pobierz wszystkich użytkowników grupy użytkowników.
Pobieranie właściwości dokumentu

Wyświetlanie listy właściwości niestandardowych dokumentu na poziomie obszaru roboczego.
Pobieranie właściwości dokumentu

Wyświetlanie listy właściwości niestandardowych dokumentu na poziomie dokumentu.
Przenoszenie plików

Przenieś pliki (dokumenty i/lub foldery) do określonego folderu (w tym samym lub innym obszarze roboczym).
Tworzenie elementu podręcznika

Dodaj element do podręcznika.
Tworzenie właściwości dokumentu

Utwórz właściwość dokumentu na poziomie obszaru roboczego.
Usuwanie dostępu do dokumentu

Usuń dostęp z dokumentu.
Usuwanie elementu skoroszytu

Usuń element z podręcznika.
Usuwanie właściwości niestandardowej dokumentu

Usuń właściwość niestandardową dokumentu na poziomie obszaru roboczego.
Usuń właściwość dokumentu

Usuń właściwość niestandardową z dokumentu.
Utwórz folder

Utwórz folder.
Uzyskiwanie dostępu do dokumentów

Wyświetlanie listy dostępu do dokumentów.
Uzyskiwanie informacji o folderze

Pobierz listę metadanych folderu.
Zamień informacje o dokumencie

Aktualizowanie metadanych dokumentu.
Zamień informacje o folderze

Zastąp metadane folderu.
Zastępowanie dostępu do dokumentów

Zastąp dostęp do dokumentu.

Aktualizowanie dostępu do dokumentów

Identyfikator operacji:
PatchDocsDocIdAccessesId

Aktualizowanie dostępu do dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Pozwolenie
 access[permission] True string

Uprawnienie.
Identyfikator dokumentu
 doc_id True integer

Identyfikator dokumentu.
identyfikator
 id True integer

Identyfikator.

Zwraca

Model dostępu do dokumentu
DocAccess

Aktualizowanie informacji o dokumencie

Identyfikator operacji:
PatchDocsId

Aktualizowanie metadanych informacji o dokumencie.

Parametry

Nazwa Klucz Wymagane Typ Opis
Title
 doc[title] True string

Tytuł dokumentu.
identyfikator
 id True integer

Identyfikator.

Zwraca

Model dokumentu
Doc

Aktualizowanie informacji o folderze

Identyfikator operacji:
PatchFoldersId

Aktualizowanie metadanych folderu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tytuł folderu
 folder[title] True string

Tytuł folderu.
identyfikator
 id True integer

Identyfikator.

Zwraca

Model folderu
Folder

Dodawanie dostępu do dokumentów

Identyfikator operacji:
PostDocsDocIdAccesses

Dodaj dostęp do dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Pozwolenie
 access[permission] True string

Uprawnienie.
Typ dostępu
 access[accessor_type] True string

Typ metody dostępu.
Identyfikator dostępu
 access[accessor_id] True integer

Identyfikator dostępu.
Identyfikator dokumentu
 doc_id True integer

Identyfikator dokumentu.

Zwraca

Model dostępu do dokumentu
DocAccess

Dodawanie właściwości dokumentu

Identyfikator operacji:
PostDocsDocIdProperties

Dodaj właściwość niestandardową do dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator właściwości
 property_id True integer

Identyfikator właściwości.
Wartość
 value string

Typ parametru value zależy od typu właściwości: "text", "date", "number", "link" => String 'single_select' => { 'selected_item_id': Integer }, propertyValue#ID 'multi_select' => { 'selected_item_ids': Array[Integer] }, wybrana właściwośćValue#IDs 'pole wyboru' => { 'check': Boolean } 'document' => { 'doc_id': liczba całkowita }, identyfikator #document#id 'person' => { 'user_ids': Array[Integer] }, identyfikatory użytkownika#.
Identyfikator dokumentu
 doc_id True integer

Identyfikator dokumentu.

Zwraca

Model właściwości dokumentu
DocProperty

Importowanie dokumentu

Identyfikator operacji:
PostImports

Zaimportuj dokument ze źródła zewnętrznego.

Parametry

Nazwa Klucz Wymagane Typ Opis
File
 import[file] True file

Plik do zaimportowania.
Źródło
 import[source] True string

Źródło pliku.

Zwraca

Importowanie modelu
Import

Pobieranie dokumentów

Identyfikator operacji:
GetDocs

Pobierz metadane wszystkich dokumentów w obszarze roboczym.

Parametry

Nazwa Klucz Wymagane Typ Opis
Strona
 page integer

Przesunięcie strony w celu pobrania.
Przedmioty
 items integer

Liczba elementów do zwrócenia na stronę.
Identyfikator folderu
 folder_id string

Filtr opcjonalny: pokaż tylko dokumenty, które znajdują się w katalogu głównym tego folderu.

Zwraca

response
array of Doc

Pobieranie elementów podręcznika

Identyfikator operacji:
GetHandbooksHandbookIdItems

Pobieranie listy elementów podręcznika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Strona
 page integer

Przesunięcie strony w celu pobrania.
Przedmioty
 items integer

Liczba elementów do zwrócenia na stronę.
Identyfikator podręcznika
 handbook_id True integer

Identyfikator podręcznika.

Zwraca

response
array of HandbookItem

Pobieranie folderów

Identyfikator operacji:
GetFolders

Pobierz listę wszystkich folderów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Strona
 page integer

Przesunięcie strony w celu pobrania.
Przedmioty
 items integer

Liczba elementów do zwrócenia na stronę.
Identyfikator folderu nadrzędnego
 parent_folder_id string

Filtr opcjonalny: pokaż tylko foldery z tym identyfikatorem folderu nadrzędnego.

Zwraca

response
array of Folder

Pobieranie grup

Identyfikator operacji:
GetGroups

Pobieranie grup użytkowników.

Parametry

Nazwa Klucz Wymagane Typ Opis
Strona
 page integer

Przesunięcie strony w celu pobrania.
Przedmioty
 items integer

Liczba elementów do zwrócenia na stronę.

Zwraca

response
array of Group

Pobieranie importu

Identyfikator operacji:
GetImportsId

Pobieranie informacji o istniejącym importowaniu.

Parametry

Nazwa Klucz Wymagane Typ Opis
identyfikator
 id True integer

Identyfikator.

Zwraca

Importowanie modelu
Import

Pobieranie informacji o dokumencie

Identyfikator operacji:
GetDocsId

Pobieranie metadanych informacji o dokumencie.

Parametry

Nazwa Klucz Wymagane Typ Opis
identyfikator
 id True integer

Identyfikator.

Zwraca

Model dokumentu
Doc

Pobieranie podręczników

Identyfikator operacji:
GetHandbooks

Pobieranie listy podręczników obszaru roboczego.

Parametry

Nazwa Klucz Wymagane Typ Opis
Strona
 page integer

Przesunięcie strony w celu pobrania.
Przedmioty
 items integer

Liczba elementów do zwrócenia na stronę.

Zwraca

response
array of Handbook

Pobieranie użytkowników

Identyfikator operacji:
GetUsers

Pobieranie listy użytkowników.

Parametry

Nazwa Klucz Wymagane Typ Opis
Strona
 page integer

Przesunięcie strony w celu pobrania.
Przedmioty
 items integer

Liczba elementów do zwrócenia na stronę.

Zwraca

response
array of User

Pobieranie użytkowników w grupie

Identyfikator operacji:
GetGroupsGroupIdUsers

Pobierz wszystkich użytkowników grupy użytkowników.

Parametry

Nazwa Klucz Wymagane Typ Opis
Strona
 page integer

Przesunięcie strony w celu pobrania.
Przedmioty
 items integer

Liczba elementów do zwrócenia na stronę.
Identyfikator grupy
 group_id True integer

Identyfikator grupy.

Zwraca

response
array of User

Pobieranie właściwości dokumentu

Identyfikator operacji:
GetProperties

Wyświetlanie listy właściwości niestandardowych dokumentu na poziomie obszaru roboczego.

Parametry

Nazwa Klucz Wymagane Typ Opis
Strona
 page integer

Przesunięcie strony w celu pobrania.
Przedmioty
 items integer

Liczba elementów do zwrócenia na stronę.

Zwraca

response
array of Property

Pobieranie właściwości dokumentu

Identyfikator operacji:
GetDocsDocIdProperties

Wyświetlanie listy właściwości niestandardowych dokumentu na poziomie dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Strona
 page integer

Przesunięcie strony w celu pobrania.
Przedmioty
 items integer

Liczba elementów do zwrócenia na stronę.
Identyfikator dokumentu
 doc_id True integer

Identyfikator dokumentu.

Zwraca

response
array of DocProperty

Przenoszenie plików

Identyfikator operacji:
PostFilesMove

Przenieś pliki (dokumenty i/lub foldery) do określonego folderu (w tym samym lub innym obszarze roboczym).

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikatory folderów
 folder_ids[] array

Identyfikatory folderów.
Identyfikatory dokumentu
 doc_ids[] array

Identyfikatory dokumentu.
Identyfikator folderu docelowego
 destination_folder_id integer

Identyfikator folderu docelowego.
Identyfikator docelowego obszaru roboczego
 destination_workspace_id integer

Identyfikator docelowego obszaru roboczego.

Tworzenie elementu podręcznika

Identyfikator operacji:
PostHandbooksHandbookIdItems

Dodaj element do podręcznika.

Parametry

Nazwa Klucz Wymagane Typ Opis
Typ elementu
 handbook_item[type] True string

Typ elementu podręcznika.
Pozycja elementu
 handbook_item[position] integer

Dołącza element jako ostatnią pozycję, jeśli nie zostanie podany.
Identyfikator elementu nadrzędnego
 handbook_item[parent_item_id] integer

Identyfikator elementu nadrzędnego do celów zagnieżdżania.
Identyfikator dokumentu
 handbook_item[doc_id] True integer

Tylko wymagane dla elementów dokumentu.
Tytuł elementu
 handbook_item[title] True string

Wymagane tylko dla elementów sekcji i linków.
Adres URL elementu
 handbook_item[url] True string

Wymagane tylko dla elementów linków.
Identyfikator podręcznika
 handbook_id True integer

Identyfikator podręcznika.

Zwraca

Model podręcznika
HandbookItem

Tworzenie właściwości dokumentu

Identyfikator operacji:
PostProperties

Utwórz właściwość dokumentu na poziomie obszaru roboczego.

Parametry

Nazwa Klucz Wymagane Typ Opis
Nazwa właściwości
 property[name] True string

Nazwa właściwości, która musi być unikatowa dla każdego obszaru roboczego.
Typ właściwości
 property[type] True string

Typ właściwości.
Ustawienie domyślne dla artykułów
 property[default_for_articles] boolean

Czy automatycznie dodać tę właściwość do nowych artykułów? Wartość domyślna to „false”.
Format danych
 property[meta][date_format] string

Opcjonalnie dla właściwości typu data.
Format liczb
 property[meta][number_format] string

Opcjonalnie dla właściwości typu number.
Zezwalaj na wspominanie wielu osób
 property[meta][allow_mentioning_multiple_people] boolean

Opcjonalnie dla właściwości typu osoba.
Powiadamianie osoby
 property[meta][notify_person] boolean

Opcjonalnie dla właściwości typu osoba.
Wartości właściwości
 property[property_values][][value] True array

Wartości właściwości.
Kolor
 property[property_values][][meta][color] array

Kolor.

Zwraca

Model właściwości
Property

Usuwanie dostępu do dokumentu

Identyfikator operacji:
DeleteDocsDocIdAccessesId

Usuń dostęp z dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 doc_id True integer

Identyfikator dokumentu.
identyfikator
 id True integer

Identyfikator.

Usuwanie elementu skoroszytu

Identyfikator operacji:
DeleteHandbooksHandbookIdItemsId

Usuń element z podręcznika.

Parametry

Nazwa Klucz Wymagane Typ Opis
identyfikator
 id True string

Identyfikator.
Identyfikator podręcznika
 handbook_id True integer

Identyfikator podręcznika.

Usuwanie właściwości niestandardowej dokumentu

Identyfikator operacji:
DeletePropertiesId

Usuń właściwość niestandardową dokumentu na poziomie obszaru roboczego.

Parametry

Nazwa Klucz Wymagane Typ Opis
identyfikator
 id True integer

Identyfikator.

Usuń właściwość dokumentu

Identyfikator operacji:
DeleteDocsDocIdPropertiesId

Usuń właściwość niestandardową z dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Identyfikator dokumentu
 doc_id True integer

Identyfikator dokumentu.
identyfikator
 id True integer

Identyfikator.

Utwórz folder

Identyfikator operacji:
PostFolders

Utwórz folder.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tytuł folderu
 folder[title] True string

Tytuł folderu.
Identyfikator folderu nadrzędnego
 folder[parent_folder_id] integer

Identyfikator folderu nadrzędnego. Jeśli nie zostanie podany, zostanie utworzony w katalogu głównym obszaru roboczego.

Zwraca

Model folderu
Folder

Uzyskiwanie dostępu do dokumentów

Identyfikator operacji:
GetDocsDocIdAccesses

Wyświetlanie listy dostępu do dokumentów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Strona
 page integer

Przesunięcie strony w celu pobrania.
Przedmioty
 items integer

Liczba elementów do zwrócenia na stronę.
Identyfikator dokumentu
 doc_id True integer

Identyfikator dokumentu.

Zwraca

response
array of DocAccess

Uzyskiwanie informacji o folderze

Identyfikator operacji:
GetFoldersId

Pobierz listę metadanych folderu.

Parametry

Nazwa Klucz Wymagane Typ Opis
identyfikator
 id True string

Identyfikator.

Zwraca

Model folderu
Folder

Zamień informacje o dokumencie

Identyfikator operacji:
PutDocsId

Aktualizowanie metadanych dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Title
 doc[title] True string

Tytuł dokumentu.
identyfikator
 id True integer

Identyfikator.

Zwraca

Model dokumentu
Doc

Zamień informacje o folderze

Identyfikator operacji:
PutFoldersId

Zastąp metadane folderu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Tytuł folderu
 folder[title] True string

Tytuł folderu.
identyfikator
 id True integer

Identyfikator.

Zwraca

Model folderu
Folder

Zastępowanie dostępu do dokumentów

Identyfikator operacji:
PutDocsDocIdAccessesId

Zastąp dostęp do dokumentu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Pozwolenie
 access[permission] True string

Uprawnienie.
Identyfikator dokumentu
 doc_id True integer

Identyfikator dokumentu.
identyfikator
 id True integer

Identyfikator.

Zwraca

Model dostępu do dokumentu
DocAccess

Definicje

User

Nazwa Ścieżka Typ Opis
identyfikator
 id integer

Identyfikator
Imię
 first_name string

Imię.
Nazwisko
 last_name string

Nazwisko.

Grupa

Nazwa Ścieżka Typ Opis
identyfikator
 id integer

Identyfikator
Name
 name string

Nazwa.
Description
 description string

Opis.
Accessibility
 accessibility string

Ułatwienia dostępu.

Majątek

Nazwa Ścieżka Typ Opis
identyfikator
 id integer

Identyfikator
Name
 name string

Nazwa.
Typ
 type string

Typ.
Ustawienie domyślne dla artykułów
 default_for_articles boolean

Określa, czy jest to ustawienie domyślne dla artykułów.
Meta
 meta PropertyMeta
property_values
 property_values array of PropertyValue

WłaściwośćMeta

Nazwa Ścieżka Typ Opis
Format liczb
 number_format string

Tylko zwracane i istotne dla właściwości numeru typu.
Format daty
 date_format string

Tylko zwrócone i istotne dla właściwości daty typu
Zezwalaj na wspominanie wielu osób
 allow_mentioning_multiple_people boolean

Tylko zwrócone i istotne dla właściwości osoby typu.
Powiadamianie osoby
 notify_person boolean

Tylko zwrócone i istotne dla właściwości osoby typu.

PropertyValue

Nazwa Ścieżka Typ Opis
identyfikator
 id integer

Identyfikator
Identyfikator właściwości
 property_id integer

Identyfikator właściwości.
Wartość
 value string

Wartość.
Meta
 meta PropertyValueMeta

PropertyValueMeta

Nazwa Ścieżka Typ Opis
Kolor
 color string

Zwracane i istotne tylko dla właściwości typu single_select i multi_select.

PodręcznikItem

Nazwa Ścieżka Typ Opis
identyfikator
 id integer

Identyfikator
Identyfikator podręcznika
 handbook_id integer

Identyfikator podręcznika.
Typ
 type string

Typ.
Position
 position integer

Pozycja.
Title
 title string

Dotyczy tylko elementów sekcji i linków.
adres URL
 url string

Dotyczy tylko elementów linków.
Identyfikator elementu nadrzędnego
 parent_item_id integer

Bez wartości null, jeśli element jest zagnieżdżony.
Identyfikator dokumentu
 doc_id integer

Dotyczy tylko elementów dokumentu.

Podręcznik

Nazwa Ścieżka Typ Opis
identyfikator
 id integer

Identyfikator
Name
 name string

Nazwa.

Folder

Nazwa Ścieżka Typ Opis
identyfikator
 id integer

Identyfikator
Title
 title string

Tytuł.
Identyfikator obszaru roboczego
 workspace_id integer

Identyfikator obszaru roboczego.
Identyfikator folderu nadrzędnego
 parent_folder_id integer

Identyfikator folderu nadrzędnego.

DocAccess

Nazwa Ścieżka Typ Opis
identyfikator
 id integer

Identyfikator
Identyfikator dokumentu
 doc_id integer

Identyfikator dokumentu.
Pozwolenie
 permission string

Uprawnienie.
Typ dostępu
 accessor_type string

Typ metody dostępu.
Identyfikator dostępu
 accessor_id integer

Identyfikator dostępu.
Odziedziczono
 inherited boolean

Czy odziedziczono.

DocProperty

Nazwa Ścieżka Typ Opis
identyfikator
 id integer

Identyfikator
Model właściwości
 property Property
Wartość
 value string

value Typ właściwości zależy od typu właściwości: "text", "date", "number", "link" => String "single_select" => { 'selected_item_id': Integer }, propertyValue#ID 'multi_select' = { 'selected_item_ids': Array[Integer] }, wybrana właściwośćValue#IDs 'checkbox' =>> { 'checked': Boolean } 'document' => { 'doc_id': Integer }, document#ID 'person' => { 'user_ids': Array[Integer] }, user#IDs.

Doc

Nazwa Ścieżka Typ Opis
identyfikator
 id integer

Identyfikator
Title
 title string

Tytuł.
Identyfikator obszaru roboczego
 workspace_id integer

Identyfikator obszaru roboczego.
Identyfikator folderu
 folder_id integer

Identyfikator folderu.
Identyfikator właściciela
 owner_id integer

Identyfikator użytkownika właściciela dokumentu.
Utworzono pod adresem
 created_at string

ISO8601 sformatowana data/godzina.
Zaktualizowano o
 updated_at string

ISO8601 sformatowana data/godzina.

Import

Nazwa Ścieżka Typ Opis
identyfikator
 id integer

Identyfikator
stan
 status string
Model dokumentu
 doc Doc