smapOne
Użyj tego łącznika, aby pobrać dane dotyczące map z elementu smapOne plattform, zaktualizować źródła danych lub utworzyć zadania dla użytkowników.
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 | smapOne AG |
| adres URL | https://www.smapone.com |
| support@smapone.com |
| Metadane łącznika | |
|---|---|
| Publisher | smapOne AG |
| Witryna internetowa | https://www.smapone.com |
| Zasady ochrony prywatności | https://en.smapone.com/privacy-policy/ |
| Kategorie | Dane; Produktywność |
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 zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| smapOne klucz interfejsu API | securestring | Klucz interfejsu API dla konta smapOne | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizowanie wszystkich źródeł danych na mapie |
Sprawdź wszystkie przywołyne źródła danych dla aktualizacji. Jeśli istnieją nowsze wersje pomocnicze źródeł danych, do których odwołuje się odwołanie, zaktualizowano odwołania i opublikowano nową wersję tej mapy. Jeśli nie ma dostępnych aktualizacji, nie zostanie wykonana żadna publikacja i zostanie zwrócona najnowsza wersja. |
| Aktualizowanie źródła danych |
Aktualizowanie źródła danych. Kolumny muszą być równe. Oznacza to, że identyfikatory kolumn muszą być zgodne. |
| Pobieranie pliku rekordu danych |
Zwraca określony plik dla danego identyfikatora recordId danej wersji mapy. |
| Pobieranie raportu rekordu danych |
Zwraca raport określonego rekordu danych danej wersji mapy. |
| Pobieranie raportów dla wszystkich rekordów danych wszystkich wersji mapy |
Zwraca raporty dla wszystkich rekordów danego identyfikatora smapId. Zwracane są raporty o wszystkich wersjach mapy. |
| Pobieranie raportów dla wszystkich rekordów danych z określonej wersji mapy |
Zwraca raporty dla wszystkich rekordów określonej wersji mapy. Dla wszystkich nowych rekordów data eksportu zostanie zaktualizowana automatycznie. Możesz użyć parametru stanu, aby filtrować nowe rekordy. |
| Pobieranie rekordu danych |
Zwraca określony rekord danych danej wersji mapy. |
|
Pobieranie schematu dla elementu data |
Pobieranie schematu json dla danych tej mapy |
| Pobieranie szczegółów źródła danych |
Zwraca szczegóły do danego źródła danych. |
| Pobieranie wartości źródła danych |
Zwraca wartości określonej wersji źródła danych. |
| Pobieranie wszystkich map |
Zwraca wszystkie mapy subskrypcji. Zwrócone jednostki mogą służyć do wykonywania zapytań dotyczących dostępnych wersji mapy przy użyciu danego identyfikatora smapId lub wykonywania zapytań dotyczących rekordów danych mapy. |
| Pobieranie wszystkich metadanych pliku dla rekordu danych |
Zwraca metadane dla wszystkich plików tego rekordu danych. |
| Pobieranie wszystkich rekordów danych dla wersji mapy |
Zwraca wszystkie rekordy dla określonej wersji mapy przy użyciu danego identyfikatora smapId. Dla wszystkich nowych rekordów data eksportu zostanie zaktualizowana automatycznie. Możesz użyć parametru stanu, aby filtrować nowe rekordy. |
| Pobieranie wszystkich rekordów danych dla wszystkich wersji mapy |
Zwraca wszystkie rekordy do danego identyfikatora smapId. Zwracane są rekordy danych wszystkich wersji mapy. Należy pamiętać, że wyniki mogą nie być zgodne ze sobą, ponieważ schemat danych mógł ulec zmianie między wersją mapy. |
| Pobieranie wszystkich wersji mapy |
Zwraca wersje als, które należą do danego identyfikatora smapId. Zwrócone jednostki mogą służyć do wykonywania zapytań dotyczących rekordów danych w danej wersji. Wersja 0.0 to obecnie edytowana wersja, a nie opublikowana wersja mapy. |
| Pobieranie źródeł danych |
Zwraca listę źródeł danych dostępnych w ramach subskrypcji. Zwrócone jednostki mogą służyć do wykonywania zapytań dotyczących wersji źródła danych przy użyciu danego identyfikatora dataSourceId. |
| Przypisywanie lub usuwanie zadania |
Przypisywanie lub usuwanie zadania od użytkownika |
| Tworzenie zadania dla wersji mapy |
Tworzenie zadania — wstępnie wypełnionego rekordu danych, który można przypisać użytkownikowi |
| Usuwanie rekordu danych |
Usuwa określony rekord danych danej wersji mapy. |
| Usuwanie rekordów danych wersji mapy |
Usuwa wszystkie rekordy danych do danej wersji mapy. Pamiętaj, że usuwasz wszystkie rekordy, jeśli nie ustawisz filtru stanu! |
| Uzyskiwanie informacji o użytkowniku |
Ta operacja zwraca informacje o bieżącym użytkowniku. Na przykład użytkownicy e-mail i subscriptionId. |
| Uzyskiwanie określonej wersji mapy |
Pobieranie metadanych dla określonej wersji mapy |
| Uzyskiwanie statystyk dotyczących użytkowników i subskrypcji |
Ta operacja zapewnia statystyki dotyczące subskrypcji, takie jak liczba danych. |
| Uzyskiwanie szczegółów dla określonej mapy |
Pobieranie wszystkich metadanych dla określonej mapy |
Aktualizowanie wszystkich źródeł danych na mapie
Sprawdź wszystkie przywołyne źródła danych dla aktualizacji. Jeśli istnieją nowsze wersje pomocnicze źródeł danych, do których odwołuje się odwołanie, zaktualizowano odwołania i opublikowano nową wersję tej mapy. Jeśli nie ma dostępnych aktualizacji, nie zostanie wykonana żadna publikacja i zostanie zwrócona najnowsza wersja.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
smapId
|
smapId | True | string |
Identyfikator mapy |
|
Wersja programu Update Designer
|
updateEditVersion | boolean |
Jeśli bieżąca wersja projektanta również powinna zostać zaktualizowana |
Zwraca
Informacje do Smap-Version
- Body
- SmapVersionModel
Aktualizowanie źródła danych
Aktualizowanie źródła danych. Kolumny muszą być równe. Oznacza to, że identyfikatory kolumn muszą być zgodne.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator źródła danych
|
dataSourceId | True | string |
Identyfikator źródła danych |
|
wersja
|
dataSourceVersion | True | string |
Numer wersji bieżącej wersji źródła danych (np. 1.0) |
|
values
|
values | object |
Zwraca
Model wersji źródła danych
Pobieranie pliku rekordu danych
Zwraca określony plik dla danego identyfikatora recordId danej wersji mapy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
smapId
|
smapId | True | string |
Identyfikator mapy |
|
smapVersion
|
version | True | string |
Numer wersji mapy (np. 1.0) |
|
recordId (identyfikator rekordu)
|
recordId | True | string |
Identyfikator rekordu |
|
Identyfikator pliku
|
fileId | True | string |
Identyfikator pliku |
Pobieranie raportu rekordu danych
Zwraca raport określonego rekordu danych danej wersji mapy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
smapId
|
smapId | True | string |
Identyfikator mapy |
|
smapVersion
|
version | True | string |
Numer wersji mapy (np. 1.0) |
|
recordId (identyfikator rekordu)
|
recordId | True | string |
Identyfikator rekordu danych |
|
Format
|
format | True | string |
Pdf, Docx, Doc, Html, Xml, Txt (na potrzeby testowania) |
|
Oznacz jako wyeksportowany
|
markAsExported | boolean |
Oznacz rekord jako wyeksportowany |
|
|
Użyj szablonu domyślnego
|
useDefault | boolean |
Jeśli zostanie wygenerowany nowy szablon, a przekazany szablon raportu zostanie zignorowany. |
Zwraca
- response
- binary
Pobieranie raportów dla wszystkich rekordów danych wszystkich wersji mapy
Zwraca raporty dla wszystkich rekordów danego identyfikatora smapId. Zwracane są raporty o wszystkich wersjach mapy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
smapId
|
smapId | True | string |
Identyfikator mapy |
|
Oznacz jako wyeksportowany
|
markAsExported | boolean |
Oznaczanie rekordów danych wszystkich żądanych raportów jako wyeksportowanych |
|
|
Stan rekordu
|
state | string |
Filtrowanie rekordów dla ich stanu: nowe, wyeksportowane lub niekompletne (zadanie) |
Zwraca
- response
- binary
Pobieranie raportów dla wszystkich rekordów danych z określonej wersji mapy
Zwraca raporty dla wszystkich rekordów określonej wersji mapy. Dla wszystkich nowych rekordów data eksportu zostanie zaktualizowana automatycznie. Możesz użyć parametru stanu, aby filtrować nowe rekordy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
smapId
|
smapId | True | string |
Identyfikator mapy |
|
smapVersion
|
version | True | string |
Wersja mapy w formacie głównym lub głównym.pomocniczym |
|
Oznacz jako wyeksportowany
|
markAsExported | boolean |
Oznaczanie rekordów danych wszystkich żądanych raportów jako wyeksportowanych |
|
|
Stan rekordu
|
state | string |
Filtrowanie rekordów pod kątem stanu nowego, wyeksportowanego lub niekompletnego |
Zwraca
- response
- binary
Pobieranie rekordu danych
Zwraca określony rekord danych danej wersji mapy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
smapId
|
smapId | True | string |
Identyfikator mapy |
|
smapVersion
|
version | True | string |
Numer wersji mapy (np. 1.0) |
|
recordId (identyfikator rekordu)
|
recordId | True | string |
Identyfikator rekordu danych |
|
Format
|
format | string |
Json, Xml |
|
|
Oznacz jako wyeksportowany
|
markAsExported | boolean |
Oznacz rekord jako wyeksportowany |
Zwraca
Model interfejsu API REST dla rekordów danych
- Body
- DataRecordApi
Pobieranie schematu dla elementu dataRecord
Pobieranie schematu json dla danych tej mapy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
smapId
|
smapId | True | string |
Identyfikator mapy |
|
smapVersion
|
version | True | string |
Numer wersji mapy (np. 1.0) |
Zwraca
- response
- object
Pobieranie szczegółów źródła danych
Zwraca szczegóły do danego źródła danych.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator źródła danych
|
dataSourceId | True | string |
Identyfikator źródła danych |
Zwraca
Model źródłowy
- Body
- DataSourceModel
Pobieranie wartości źródła danych
Zwraca wartości określonej wersji źródła danych.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator źródła danych
|
dataSourceId | True | string |
Identyfikator źródła danych |
|
Wersja źródła danych
|
dataSourceVersion | True | string |
Numer wersji źródła danych (np. 1.0) |
Zwraca
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
|
array of object | ||
|
items
|
object |
Pobieranie wszystkich map
Zwraca wszystkie mapy subskrypcji. Zwrócone jednostki mogą służyć do wykonywania zapytań dotyczących dostępnych wersji mapy przy użyciu danego identyfikatora smapId lub wykonywania zapytań dotyczących rekordów danych mapy.
Zwraca
- response
- array of SmapModel
Pobieranie wszystkich metadanych pliku dla rekordu danych
Zwraca metadane dla wszystkich plików tego rekordu danych.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
smapId
|
smapId | True | string |
Identyfikator mapy |
|
smapVersion
|
version | True | string |
Numer wersji mapy (np. 1.0) |
|
recordId (identyfikator rekordu)
|
recordId | True | string |
Identyfikator rekordu danych |
Zwraca
- response
- array of SingleFileValue
Pobieranie wszystkich rekordów danych dla wersji mapy
Zwraca wszystkie rekordy dla określonej wersji mapy przy użyciu danego identyfikatora smapId. Dla wszystkich nowych rekordów data eksportu zostanie zaktualizowana automatycznie. Możesz użyć parametru stanu, aby filtrować nowe rekordy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
smapId
|
smapId | True | string |
Identyfikator mapy |
|
smapVersion
|
version | True | string |
Wersja mapy w formacie głównym (np. 1) lub wersja pomocnicza (np. 1.1) |
|
Oznacz jako wyeksportowany
|
markAsExported | boolean |
Oznacz wszystkie żądane rekordy jako wyeksportowane |
|
|
Format
|
format | string |
Format danych wyjściowych (.json oder .xml), wartość domyślna to Json |
|
|
Stan rekordu
|
state | string |
filtrowanie rekordów pod kątem stanu nowego, wyeksportowanego lub niekompletnego |
Zwraca
- response
- array of DataRecordApi
Pobieranie wszystkich rekordów danych dla wszystkich wersji mapy
Zwraca wszystkie rekordy do danego identyfikatora smapId. Zwracane są rekordy danych wszystkich wersji mapy. Należy pamiętać, że wyniki mogą nie być zgodne ze sobą, ponieważ schemat danych mógł ulec zmianie między wersją mapy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
smapId
|
smapId | True | string |
Identyfikator mapy |
|
Oznacz jako wyeksportowany
|
markAsExported | boolean |
Oznacz wszystkie żądane rekordy jako wyeksportowane |
|
|
Format
|
format | True | string |
Format danych wyjściowych (.json, .xml), wartość domyślna to Json |
|
Stan rekordu
|
state | string |
Filtrowanie rekordów dla ich stanu: nowe, wyeksportowane lub niekompletne (zadanie) |
Zwraca
- response
- array of DataRecordApi
Pobieranie wszystkich wersji mapy
Zwraca wersje als, które należą do danego identyfikatora smapId. Zwrócone jednostki mogą służyć do wykonywania zapytań dotyczących rekordów danych w danej wersji. Wersja 0.0 to obecnie edytowana wersja, a nie opublikowana wersja mapy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
smapId
|
smapId | True | string |
Identyfikator mapy |
Zwraca
- response
- array of SmapVersionModel
Pobieranie źródeł danych
Zwraca listę źródeł danych dostępnych w ramach subskrypcji. Zwrócone jednostki mogą służyć do wykonywania zapytań dotyczących wersji źródła danych przy użyciu danego identyfikatora dataSourceId.
Zwraca
- response
- array of DataSourceListModel
Przypisywanie lub usuwanie zadania
Przypisywanie lub usuwanie zadania od użytkownika
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
smapId
|
smapId | True | string |
Identyfikator mapy |
|
smapVersion
|
version | True | string |
Numer wersji mapy (np. 1.0) |
|
recordId (identyfikator rekordu)
|
taskId | True | string |
Identyfikator rekordu |
|
akcja
|
action | string | ||
|
userEmail
|
userEmail | string |
Zwraca
Model interfejsu API REST dla rekordów danych
- Body
- DataRecordApi
Tworzenie zadania dla wersji mapy
Tworzenie zadania — wstępnie wypełnionego rekordu danych, który można przypisać użytkownikowi
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
smapId
|
smapId | True | string |
Identyfikator mapy |
|
smapVersion
|
version | True | string |
Numer wersji mapy (np. 1.0) |
|
userEmail
|
userEmail | string | ||
|
title
|
title | True | string |
Nazwa zadania |
|
komentarz
|
comment | string |
Komentarz twórcy zadania |
|
|
hasPriority
|
hasPriority | boolean |
Zadanie jest priorytetowe |
|
|
dane
|
data | True | object |
Zwraca
Model interfejsu API REST dla rekordów danych
- Body
- DataRecordApi
Usuwanie rekordu danych
Usuwa określony rekord danych danej wersji mapy.
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
smapId
|
smapId | True | string |
Identyfikator mapy |
|
smapVersion
|
version | True | string |
Numer wersji mapy (np. 1.0) |
|
recordId (identyfikator rekordu)
|
recordId | True | string |
Identyfikator rekordu danych |
Usuwanie rekordów danych wersji mapy
Usuwa wszystkie rekordy danych do danej wersji mapy. Pamiętaj, że usuwasz wszystkie rekordy, jeśli nie ustawisz filtru stanu!
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
smapId
|
smapId | True | string |
Identyfikator mapy |
|
smapVersion
|
version | True | string |
Numer wersji mapy (np. 1.0) |
|
Stan rekordu
|
state | string |
filtrowanie rekordów pod kątem stanu nowego, wyeksportowanego lub niekompletnego |
Uzyskiwanie informacji o użytkowniku
Ta operacja zwraca informacje o bieżącym użytkowniku. Na przykład użytkownicy e-mail i subscriptionId.
Zwraca
Informacje dla użytkownika
- Body
- UserInfoModel
Uzyskiwanie określonej wersji mapy
Pobieranie metadanych dla określonej wersji mapy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
smapId
|
smapId | True | string |
Identyfikator mapy |
|
smapVersion
|
version | True | string |
Numer wersji mapy (np. 1.0) |
Zwraca
Informacje do Smap-Version
- Body
- SmapVersionModel
Uzyskiwanie statystyk dotyczących użytkowników i subskrypcji
Ta operacja zapewnia statystyki dotyczące subskrypcji, takie jak liczba danych.
Zwraca
- Body
- AccountStatistics
Uzyskiwanie szczegółów dla określonej mapy
Pobieranie wszystkich metadanych dla określonej mapy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
smapId
|
smapId | True | string |
Identyfikator smapId mapy do zażądania |
Zwraca
Podstawowe informacje o mapie
- Body
- SmapModel
Definicje
UserInfoModel
Informacje dla użytkownika
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
accountIsActivated
|
accountIsActivated | boolean |
Wskazuje, czy konto zostało aktywowane. Jeśli nie, użytkownik jeszcze nie zweryfikował konta. |
|
Identyfikator subskrypcji
|
subscriptionId | string |
Identyfikator subskrypcji użytkownika |
|
userName
|
userName | string |
Nazwa użytkownika |
|
companyName
|
companyName | string |
Nazwa firmy zarejestrowana dla subskrypcji |
|
e-mail
|
string |
Adres e-mail użytkownika |
|
|
originalMail
|
originalMail | string |
Jeśli dostęp do bieżącego konta był uzyskiwany przy użyciu personifikacji, zostanie wyświetlony adres e-mail oryginalnego użytkownika. |
|
kontrakt
|
contract | string |
Typ kontraktu |
|
roles
|
roles | array of string |
Lista ról, które mają zastosowanie do użytkownika |
|
smapLimit
|
smapLimit | integer |
Maksymalna liczba map, które użytkownik może opublikować. Wartość null oznacza nieograniczoną wartość. |
|
wydawca
|
publisher | string |
Tekst opisujący wydawcę użytkownikom. |
|
przesłać źródło
|
source | string |
Źródło subskrypcji. |
|
isInternal (Wewnętrzny)
|
isInternal | boolean |
Wskazuje, że to konto jest używane wewnętrznie przez element smapOne. |
|
userLimit
|
userLimit | integer |
Maksymalna liczba użytkowników, które twórca może utworzyć |
|
publishedSmaps
|
publishedSmaps | integer |
Liczba opublikowanych map tego konta |
|
availableFeatures
|
availableFeatures | array of string |
Lista dostępnych funkcji dla tego konta |
|
ustawienia
|
settings | object |
Ustawienia niestandardowe przechowywane na tym koncie. Dane wyjściowe będą wyświetlane tylko wtedy, gdy parametr "embed" jest ustawiony na żądanie. |
|
kultura
|
culture | string |
Obecnie wybrana kultura dla tego konta. Podane jako dwucyfrowy kod kultury, np. "en". |
AccountStatistics
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string | |
|
subscriptionType
|
subscriptionType | string | |
|
subscriptionTypeChanged
|
subscriptionTypeChanged | date-time | |
|
subscriptionTypeTitle
|
subscriptionTypeTitle | string | |
|
subscriptionTypeValue
|
subscriptionTypeValue | integer | |
|
isMasterSubscription
|
isMasterSubscription | boolean | |
|
smapLimit
|
smapLimit | integer | |
|
groupCount
|
groupCount | integer | |
|
trialDurationInDays
|
trialDurationInDays | integer | |
|
daysLeftForTrial
|
daysLeftForTrial | integer | |
|
data utworzenia
|
createdDate | date-time | |
|
liczba użytkowników
|
userCount | integer | |
|
userLimit
|
userLimit | integer | |
|
daysSinceCreation
|
daysSinceCreation | integer | |
|
kultura
|
culture | string | |
|
langCode
|
langCode | string | |
|
isInternal (Wewnętrzny)
|
isInternal | boolean | |
|
systemVersion (wersja systemu)
|
systemVersion | string | |
|
domena
|
domain | string | |
|
isChildSubscription
|
isChildSubscription | boolean | |
|
isImpersonating
|
isImpersonating | boolean | |
|
dataCount
|
dataCount | integer | |
|
smapCount
|
smapCount | integer | |
|
publishedSmapCount
|
publishedSmapCount | integer | |
|
notPublishedSmapCount
|
notPublishedSmapCount | integer | |
|
distributedSmapCount
|
distributedSmapCount | integer | |
|
installedSmapsCount
|
installedSmapsCount | integer | |
|
groupLicenseCount
|
groupLicenseCount | integer | |
|
lastSmapId
|
lastSmapId | string | |
|
previewSmapCount
|
previewSmapCount | integer |
DataSourceListModel
Model źródłowy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
data utworzenia
|
createdDate | date-time |
Data utworzenia źródła danych |
|
latestVersion
|
latestVersion | string |
Najnowsza wersja dostępna dla tego źródła danych |
|
typ
|
type | string |
Typ źródła danych |
|
dataSourceId (identyfikator źródła_danych)
|
dataSourceId | string |
Identyfikator źródła danych |
|
nazwa
|
name | string |
Nazwa źródła danych. |
DataSourceVersionModel
Model wersji źródła danych
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
definicja
|
definition | AbstractDataSourceDefinition |
Definicja tej wersji źródła danych |
|
data utworzenia
|
createdDate | date-time |
Data utworzenia tej wersji źródła danych |
|
wersja
|
version | string |
Numer wersji tego źródła danych |
|
dataSourceId (identyfikator źródła_danych)
|
dataSourceId | string |
Identyfikator źródła danych |
|
nazwa
|
name | string |
Nazwa źródła danych. |
AbstractDataSourceDefinition
Definicja tej wersji źródła danych
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
title
|
title | string | |
|
typ
|
type | string | |
|
id
|
id | string | |
|
dataSourceId (identyfikator źródła_danych)
|
dataSourceId | string |
Identyfikator źródła danych |
DataSourceModel
Model źródłowy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dataSourceId (identyfikator źródła_danych)
|
dataSourceId | string |
Identyfikator źródła danych |
|
typ
|
type | string |
Typ źródła danych |
|
nazwa
|
name | string |
Nazwa źródła danych |
|
data utworzenia
|
createdDate | date-time |
Data utworzenia źródła danych |
|
latestVersion
|
latestVersion | string |
Najnowsza wersja dostępna dla tego źródła danych |
|
usedInSmaps
|
usedInSmaps | array of DataSourceSmapModel |
smapy korzystające z tego źródła danych |
DataSourceSmapModel
Opisuje mapę
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
smapName
|
smapName | string |
Nazwa mapy |
|
smapId
|
smapId | string |
Identyfikator mapy |
SmapModel
Podstawowe informacje o mapie
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
groupLicenseCount
|
groupLicenseCount | integer |
Liczba licencji grup |
|
typZmiany
|
changeType | string |
Wskazuje, jakiego rodzaju zmiany zostały wprowadzone do mapy w porównaniu z ostatnią opublikowaną wersją. |
|
userLicenseCount
|
userLicenseCount | integer |
Liczba licencji użytkowników |
|
lastChanged
|
lastChanged | date-time |
Data wprowadzenia ostatniej zmiany na mapie |
|
isUpToDate
|
isUpToDate | boolean |
Wskazuje, że mapa nie została zmieniona od czasu ostatniej publikacji |
|
installationsCount
|
installationsCount | integer |
Liczba instalacji mapy |
|
lastPublishedVersion
|
lastPublishedVersion | SmapVersionModel |
Informacje do Smap-Version |
|
totalDataCount
|
totalDataCount | integer |
Liczba wszystkich rekordów danych dla wszystkich wersji mapy |
|
totalOpenTasksCount
|
totalOpenTasksCount | integer |
Liczba otwartych zadań dla tej mapy |
|
tasksActivated
|
tasksActivated | boolean |
Wskazuje, że opcja tworzenia zadań z rekordów danych jest aktywowana dla tej mapy. |
|
isCompanyTemplate
|
isCompanyTemplate | boolean |
Wskazuje, czy ta mapa została udostępniona jako szablon firmy |
|
nazwa
|
name | string |
Nazwa mapy |
|
smapId
|
smapId | string |
Identyfikator mapy |
|
logoId
|
logoId | string |
Identyfikator logo mapy |
SmapVersionModel
Informacje do Smap-Version
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
lastChanged
|
lastChanged | date-time |
Data opublikowania tej wersji. W przypadku wersji 0.0 (edytuj wersję) jest wyświetlana po wprowadzeniu ostatniej zmiany na mapie. |
|
lastRecordReceived
|
lastRecordReceived | date-time |
Data odebrania ostatniego rekordu danych dla tej wersji mapy |
|
dataCount
|
dataCount | integer |
Liczba rekordów danych dla tej wersji mapy |
|
smapVersionId
|
smapVersionId | string |
Identyfikator tej wersji mapy |
|
wersja
|
version | string |
Numer wersji tej wersji mapy |
DataRecordApi
Model interfejsu API REST dla rekordów danych
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
wersja schematu
|
schemaVersion | integer |
Wersja formatu danych |
|
id
|
id | string |
Identyfikator rekordu danych |
|
typ rekordu
|
recordType | string |
Opisuje typ rekordu danych. Jest to zadanie lub własny rekord danych. |
|
Identyfikator subskrypcji
|
subscriptionId | string |
Identyfikator subskrypcji, do której należy rekord danych i zgodnie z mapą. |
|
smapId
|
smapId | string |
Identyfikator mapowania rekordu danych. |
|
smapVersionId
|
smapVersionId | string |
Identyfikator wersji mapy, do którego należy rekord danych. |
|
wersja
|
version | string |
Wersja mapy z możliwością odczytu przez człowieka, do którego należy rekord danych. |
|
tokenId (identyfikator tokenu)
|
tokenId | string |
Identyfikator tokenu mapy, za pomocą którego utworzono rekord danych. |
|
userId
|
userId | string |
Identyfikator użytkownika, który utworzył rekord danych |
|
userEmail
|
userEmail | string |
Adres e-mail użytkownika, który utworzył rekord danych |
|
userName
|
userName | string |
Nazwa użytkownika, który utworzył rekord danych. Uwaga: po utworzeniu rekordu danych za pośrednictwem licencji anonimowej to pole ma w nim nieczytelny unikatowy identyfikator. |
|
sendDate
|
sendDate | date-time |
Sygnatura czasowa ukończenia rekordu danych przez użytkownika i zapisana w kolejce do wysyłania do serwera w aplikacji smapOne. |
|
clientCreatedDate
|
clientCreatedDate | date-time |
Sygnatura czasowa przekazywania rekordu danych przez użytkownika, a tym samym stała się zadaniem. |
|
receivedDate
|
receivedDate | date-time |
Sygnatura czasowa, w której rekord danych został odebrany przez serwer. Zostanie ono ustawione, gdy sam rekord został przeniesiony na serwer, ale skojarzone pliki mogły jeszcze nie być. Sygnatura czasowa będzie późniejsza niż sendDate, ale przed ukończeniemDate. |
|
completedDate
|
completedDate | date-time |
Sygnatura czasowa, w której sam ukończony rekord danych i wszystkie przywoływane pliki zostały całkowicie przesłane i odebrane przez serwer. |
|
deletedDate
|
deletedDate | date-time |
Sygnatura czasowa usunięcia rekordu danych |
|
lastExportDate
|
lastExportDate | date-time |
Sygnatura czasowa podczas eksportowania rekordu danych po raz ostatni |
|
toCompleteOn
|
toCompleteOn | date-time |
Data opublikowania rekordu danych |
|
title
|
title | string |
Nazwa zadania lub rekordu danych. |
|
komentarz
|
comment | string |
Pojedynczy komentarz do zadania |
|
dane
|
data |
Zebrane dane z mapy. Lista par wartości klucza, w których klucz jest identyfikatorem każdego modułu mapy, a wartość jest rzeczywistymi danymi z tego modułu. |
SingleFileValue
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
fileId (identyfikator pliku)
|
fileId | string | |
|
fileName
|
fileName | string | |
|
sygnatura czasowa
|
timestamp | date-time | |
|
suma kontrolna
|
checkSum | string | |
|
typ treści
|
contentType | string | |
|
size
|
size | integer | |
|
Meta
|
meta | FileMetaData | |
|
URL
|
url | string |
FileMetaData
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
audioDuration
|
audioDuration | string |
obiekt
Jest to typ 'obiekt'.
binarny
Jest to podstawowy typ danych "binary".