Udostępnij przez


Content Manager Power Connect

Content Manager to oparty na ładie system zarządzania zawartością przedsiębiorstwa, który ułatwia agencjom rządowym, regulowanym branżom i organizacjom globalnym zarządzanie zawartością biznesową od tworzenia do dyspozycji. Połącz się z menedżerem zawartości, aby wykonać akcje, w tym tworzenie lub aktualizowanie rekordów lub lokalizacji, przekazywanie lub pobieranie plików elektronicznych, wyszukiwanie i nie tylko. (1.0.4.757)

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 Kapish Services Pty Ltd
adres URL https://kapish.com.au/products/power_connect/
Email sales@kapish.com.au
Metadane łącznika
Publisher Kapish Services Pty Ltd
Witryna internetowa https://kapish.com.au/products/power_connect/
Zasady ochrony prywatności https://kapish.com.au/products/privacy-policy/
Kategorie Dane; Zawartość i pliki

Program Content Manager Power Connect by Kapish to łącznik, który zapewnia funkcje automatyzacji i integracji w Menedżerze zawartości, aby usprawnić możliwości organizacji w zakresie zarządzania informacjami i zapewniania ładu.

Pre-requisites

  • Interfejs SERVICEAPI menedżera zawartości dostępny zewnętrznie
  • Klucz subskrypcji dostarczony przez Kapish Services Pty Ltd

Aby uzyskać szczegółową listę specyfikacji i wymagań lub uzyskać więcej informacji na temat sposobu, w jaki łącznik może pomóc Twojej organizacji, skontaktuj się z Kapish Services Pty Ltd

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:

OAuth (poufny przepływ klienta) Nawiązywanie połączenia z menedżerem zawartości przy użyciu protokołu OAuth Wszystkie regiony Nie można udostępniać
Zarządzane przez system Nawiązywanie połączenia z menedżerem zawartości przy użyciu nazwy użytkownika i hasła Wszystkie regiony Nie można udostępniać
Domyślne [PRZESTARZAŁE] Ta opcja dotyczy tylko starszych połączeń bez jawnego typu uwierzytelniania i jest dostępna tylko w celu zapewnienia zgodności z poprzednimi wersjami. Wszystkie regiony Nie można udostępniać

OAuth (poufny przepływ klienta)

Identyfikator uwierzytelniania: OAuth

Dotyczy: wszystkie regiony

Nawiązywanie połączenia z menedżerem zawartości przy użyciu protokołu OAuth

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
Klucz subskrypcji KPC securestring Klucz interfejsu API do uzyskiwania dostępu do programu Kapish Power Connect Prawda
Adres URL interfejsu API usługi CM (np. https://myserver/CMServiceAPI/) ciąg Adres URL, pod którym można uzyskać dostęp do interfejsu CM ServiceAPI Prawda
Adres URL serwera autoryzacji (np. https://myserver/adfs/oauth2/token) ciąg Adres URL umożliwiający uzyskanie tokenu dostępu Prawda
ID klienta ciąg Identyfikator klienta na potrzeby uwierzytelniania Prawda
Tajemnica klienta securestring Klucz tajny klienta na potrzeby uwierzytelniania Prawda

Zarządzane przez system

Identyfikator uwierzytelniania: Podstawowy

Dotyczy: wszystkie regiony

Nawiązywanie połączenia z menedżerem zawartości przy użyciu nazwy użytkownika i hasła

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
Klucz subskrypcji KPC securestring Klucz interfejsu API do uzyskiwania dostępu do programu Kapish Power Connect Prawda
Adres URL interfejsu API usługi CM (np. https://myserver/CMServiceAPI/) ciąg Adres URL, pod którym można uzyskać dostęp do interfejsu CM ServiceAPI Prawda
Nazwa użytkownika ciąg Nazwa użytkownika na potrzeby uwierzytelniania Prawda
Hasło securestring Hasło do uwierzytelniania Prawda

Domyślne [PRZESTARZAŁE]

Dotyczy: wszystkie regiony

Ta opcja dotyczy tylko starszych połączeń bez jawnego typu uwierzytelniania i jest dostępna tylko w celu zapewnienia zgodności z poprzednimi wersjami.

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
Klucz subskrypcji KPC securestring Klucz interfejsu API do uzyskiwania dostępu do programu Kapish Power Connect Prawda
Adres URL interfejsu API usługi CM (np. https://myserver/CMServiceAPI/) ciąg Adres URL, pod którym można uzyskać dostęp do interfejsu CM ServiceAPI Prawda
Adres URL serwera autoryzacji (np. https://myserver/adfs/oauth2/token) ciąg Adres URL umożliwiający uzyskanie tokenu dostępu Prawda
ID klienta ciąg Identyfikator klienta na potrzeby uwierzytelniania Prawda
Tajemnica klienta securestring Klucz tajny klienta na potrzeby uwierzytelniania Prawda

Limity ograniczania

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

Akcje

Aktualizuj rekord (akcja ponownego przypisania)

Ponownie przypisuje nominowaną akcję do określonej lokalizacji

Aktualizuj rekord (Dispose)

Usuwanie rekordu

Aktualizuj rekord (dołącz kontakt)

Dołączanie kontaktu do rekordu

Aktualizuj rekord (otwórz ponownie)

Użyj funkcji ReopenRecord, aby ponownie otworzyć zamknięty kontener. Ponieważ ponowne otwarcie rekordu może wymagać aktualizacji wielu zawartych rekordów, ta funkcja zatwierdza zmiany automatycznie

Aktualizuj rekord (pełne akcje)

Wykonaj jedną lub wszystkie akcje z powodu określonego rekordu

Aktualizuj rekord (ustaw etykietę użytkownika)

Umożliwia ustawienie etykiety użytkownika w rekordzie

Aktualizuj rekord (Ustaw przypisanie)

Ustaw właściwość Assignee na określoną lokalizację, wróć do pozycji Strona główna lub zarejestruj się jako Brak

Aktualizuj rekord (usuń wszystkie akcje)

Usuwa wszystkie akcje dołączone do określonego rekordu

Aktualizuj rekord (właściwości)

Aktualizowanie rekordu

Aktualizuj rekord (zamknij)

Użyj funkcji CloseRecord, aby zamknąć kontener — pozostaw datę pustą, jeśli chcesz, aby data zamknięcia to "now". Ponieważ zamknięcie rekordu może wymagać aktualizacji wielu zawartych rekordów, ta funkcja zatwierdza zmiany automatycznie

Lokalizacja aktualizacji (adres)

Tworzenie/aktualizowanie adresu lokalizacji przy użyciu unikatowego identyfikatora adresu

Lokalizacja aktualizacji (dodatkowe pola)

Aktualizowanie dodatkowych pól w lokalizacji

Lokalizacja aktualizacji (inne)

Aktualizowanie lokalizacji

Lokalizacja aktualizacji (osoba)

Aktualizowanie lokalizacji osoby przy użyciu unikatowego identyfikatora

Odczytywanie danych zdarzenia

Przekształcanie danych zdarzenia Kapish Dispatch na potrzeby użycia przepływu

Pobieranie pliku z adresu URL

Pobieranie pliku z adresu URL do obszaru przejściowego przy użyciu wtyczki interfejsu API usługi CM "GetFileFromUrl"

Pobierz plik elektroniczny

Pobieranie elektronicznego pliku rekordu

Przekazywanie pliku elektronicznego

Przekaż plik elektroniczny, który może być później dołączony do rekordu

Rekord aktualizacji (akcje zmiany harmonogramów)

Zmienia harmonogram wszystkich akcji dołączonych do tego rekordu

Rekord aktualizacji (cofanie wyewidencjonowania)

Cofnij poprzednie wyewidencjonowanie dokumentu elektronicznego dla tego rekordu, pomijając wszelkie wprowadzone zmiany, ponieważ został wyewidencjonowany

Rekord aktualizacji (dodatkowe pola)

Aktualizowanie dodatkowych pól w rekordzie

Rekord aktualizacji (dodawanie kontroli dostępu)

AddAccessControl

Rekord aktualizacji (dołącz akcję lub procedurę)

Dołączanie akcji lub procedury do rekordu

Rekord aktualizacji (dołącz termin Thesaurus)

Dołączanie terminu Thesaurus do rekordu

Rekord aktualizacji (dołączanie pliku elektronicznego)

Dołączanie pliku elektronicznego do rekordu

Rekord aktualizacji (finalizowanie)

Aktualizowanie wersji roboczej rekordu

Rekord aktualizacji (klasyfikacja)

Aktualizowanie klasyfikacji rekordu

Rekord aktualizacji (undispose)

Przywraca stan rekordu (i jego zawartości), aby nie został już usunięty

Rekord aktualizacji (unfinalise — Ustaw jako wersję roboczą)

Aktualizowanie sfinalizowanego rekordu do wersji roboczej

Rekord aktualizacji (ustaw dostęp bez ograniczeń lub na podstawie kontenera)

InheritAccessControl

Rekord aktualizacji (usuń lokalizację z kontroli dostępu)

RemoveAccessControl

Rekord aktualizacji (wyewidencjonuj)

Ustaw stan rekordu na wyewidencjonowany

Rekord aktualizacji (zaawansowane)

Aktualizowanie rekordu za pomocą właściwości zaawansowanych

Rekord aktualizacji (zastąp kontrolki dostępu)

SetAccessControl

Rekord aktualizacji (żądanie odwzorowania)

Umożliwia utworzenie żądania dla aparatu automatycznego renderowania w celu utworzenia odwzorowania rekordu

Tworzenie rekordu (dokument)

Tworzenie rekordu

Tworzenie rekordu (folder)

Tworzenie rekordu

Tworzenie rekordu (zaawansowane)

Tworzenie rekordu z polami zaawansowanymi

Usuń rekord

Usuwanie rekordu

Utwórz lokalizację (inne)

Tworzenie lokalizacji dowolnego typu

Utwórz lokalizację (osoba)

Tworzenie lokalizacji osoby

Znajdowanie lokalizacji

Wyszukaj lokalizacje (pobierz kolekcję lokalizacji przy użyciu ciągu wyszukiwania)

Znajdowanie obiektów cm

Wyszukiwanie obiektów CM

Znajdowanie rekordu według identyfikatora

Pobieranie pojedynczego rekordu według unikatowego identyfikatora lub nazwy

Znajdowanie rekordów

Wyszukiwanie rekordów (pobieranie kolekcji rekordów przy użyciu ciągu wyszukiwania)

Znajdowanie rekordów (zaawansowane)

Wyszukaj ciąg Rekordy (pobierz kolekcję rekordów przy użyciu ciągu wyszukiwania). Zwraca nieprzetworzona odpowiedź serviceAPI menedżera zawartości.

Znajdowanie unikatowego identyfikatora adresu lokalizacji

Uzyskiwanie unikatowego identyfikatora adresu podrzędnego lokalizacji

Znajdź lokalizację według identyfikatora

Pobieranie pojedynczej lokalizacji według unikatowego identyfikatora lub nazwy

Aktualizuj rekord (akcja ponownego przypisania)

Ponownie przypisuje nominowaną akcję do określonej lokalizacji

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer
Nowy przypisz
NewAssignee True string

Unikatowy identyfikator lub adres e-mail nowego przypisania

Akcja ponownego przypisania
RecordActionUri True integer
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Aktualizuj rekord (Dispose)

Usuwanie rekordu

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer
Czy kontynuować w przypadku błędu?
ContinueOnError boolean
Metoda usuwania
MethodOfDisposal string
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Aktualizuj rekord (dołącz kontakt)

Dołączanie kontaktu do rekordu

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer
Typ kontaktu
ContactType True string
Lokalizacja kontaktu
ContactLocation True string

Unikatowy identyfikator lub adres e-mail lokalizacji

Ustaw jako kontakt podstawowy?
IsPrimary True boolean
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Aktualizuj rekord (otwórz ponownie)

Użyj funkcji ReopenRecord, aby ponownie otworzyć zamknięty kontener. Ponieważ ponowne otwarcie rekordu może wymagać aktualizacji wielu zawartych rekordów, ta funkcja zatwierdza zmiany automatycznie

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer
Czy kontynuować w przypadku błędu?
ContinueOnError boolean
Wyniki dziennika?
LogResults boolean

Czy zwrócić dziennik tekstowy rekordów ponownie otwarty we właściwości Komunikat dziennika?

Czy usunąć treść?
UnfinalizeContents boolean
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Aktualizuj rekord (pełne akcje)

Wykonaj jedną lub wszystkie akcje z powodu określonego rekordu

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer
Complete
Complete True string

Określ, które akcje rekordów mają być ukończone

Wykonywanie poprzednich akcji
CompletePrevious boolean

Ukończ wszystkie akcje rekordu przed określonym

Data ukończenia
CompletionDate date

Data, która ma być ustawiona jako data ukończenia

Unikatowy identyfikator akcji rekordu
RecordActionUri integer

Unikatowy identyfikator akcji rekordu do ukończenia, jeśli wybrano opcję "Dla unikatowego identyfikatora"

Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Aktualizuj rekord (ustaw etykietę użytkownika)

Umożliwia ustawienie etykiety użytkownika w rekordzie

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Rekord
Uri True integer

Unikatowy identyfikator rekordu w celu dołączenia etykiety użytkownika do

Etykieta użytkownika
UserLabel True string

Unikatowy identyfikator lub nazwa etykiety użytkownika do zastosowania

Ulubiony typ
FavouriteType string
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Aktualizuj rekord (Ustaw przypisanie)

Ustaw właściwość Assignee na określoną lokalizację, wróć do pozycji Strona główna lub zarejestruj się jako Brak

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer
Nowy przypisz
NewAssignee string

Unikatowy identyfikator lub adres e-mail nowego przypisania

Typ przypisania
AssigneeType string
Termin zwrotu według daty
DueForReturnByDate date
Wystąpiła zmiana czasu rzeczywistego
ActualTimeChangeOccurred date-time
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Aktualizuj rekord (usuń wszystkie akcje)

Usuwa wszystkie akcje dołączone do określonego rekordu

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Aktualizuj rekord (właściwości)

Aktualizowanie rekordu

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri integer
Query
q string

Określ tutaj zapytanie, aby zastosować aktualizację do zestawu rekordów, a nie tylko jednego (określonego przez unikatowy identyfikator)

Tytuł (część tekstowa bezpłatna)
RecordTypedTitle string
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Author
RecordAuthor string

Unikatowy identyfikator lub adres e-mail lokalizacji

Pojemnik
RecordContainer string
Classification
RecordClassification string

Podaj unikatowy identyfikator klasyfikacji

Adresat
RecordAddressee string

Unikatowy identyfikator lub adres e-mail lokalizacji

Kontener alternatywny
RecordAlternativeContainer string
Cesjonariusza
RecordAssignee string

Unikatowy identyfikator lub adres e-mail lokalizacji

Automatyczne renderowanie do formatu PDF podczas zapisywania
RecordAutoRenderToPDFOnSave boolean
Obejście kontroli dostępu typu rekordu
RecordBypassRecordTypeAccessControls boolean
Zaewidencjonuj jako
CheckinAs string

Ustaw właściwość Source dokumentu elektronicznego.

Client
RecordClient string

Unikatowy identyfikator lub adres e-mail lokalizacji

Rekord klienta
RecordClientRecord string
Kopiowanie dokumentu z rekordu
CopyDocumentFromRecord string

Określ unikatowy identyfikator rekordu, z którego ma być skopiowany dokument elektroniczny dla tego rekordu.

Kreator
RecordCreator string

Unikatowy identyfikator lub adres e-mail lokalizacji

Data utworzenia
RecordDateCreated string
Data ukończenia
RecordDateDue string
Data publikacji
RecordDatePublished string
Data odebrania
RecordDateReceived string
Dokumentacja zewnętrzna
RecordExternalReference string
Nie można włączyć ostrzeżeń?
FailOnWarnings boolean

Wartość True, aby nie tworzyć/zapisywać obiektu, jeśli istnieją ostrzeżenia.

Nazwa pliku w folderze Uploads
RecordFilePath string

Nazwa pliku wyświetlana w folderze Uploads.

Finalizowanie przy zapisywaniu
RecordFinalizeOnSave boolean
Obcy kod kreskowy
RecordForeignBarcode string
Lokalizacja GPS
RecordGpsLocation string
Lokalizacja domowa
RecordHomeLocation string

Unikatowy identyfikator lokalizacji

Przestrzeń domowa
RecordHomeSpace string
Jest ujęta
RecordIsEnclosed boolean
Jurisdiction
RecordJurisdictions string
Zachowaj wyewidencjonowywanie
keepBookedOut boolean

Wartość True umożliwia pozostawienie wyewidencjonowanego rekordu po przekazaniu dokumentu elektronicznego.

Długa liczba
RecordLongNumber string
Typ nośnika
RecordMediaType string
Notatki
RecordNotes string
Typ aktualizacji notatek
NotesUpdateType string
Inny kontakt
RecordOtherContact string

Unikatowy identyfikator lub adres e-mail lokalizacji

Lokalizacja właściciela
RecordOwnerLocation string

Unikatowy identyfikator lub adres e-mail lokalizacji

Rekord pokrewny
RecordRelatedRecord string
Przedstawiciel
RecordRepresentative string
Data przeglądu
RecordReviewDate string
Data ukończenia przeglądu
RecordReviewDueDate string
Stan przeglądu
RecordReviewState string
Zabezpieczenia
RecordSecurity string

Zwraca

Aktualizuj rekord (zamknij)

Użyj funkcji CloseRecord, aby zamknąć kontener — pozostaw datę pustą, jeśli chcesz, aby data zamknięcia to "now". Ponieważ zamknięcie rekordu może wymagać aktualizacji wielu zawartych rekordów, ta funkcja zatwierdza zmiany automatycznie

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer
Czy kontynuować w przypadku błędu?
ContinueOnError boolean
Ujęta zawartość?
EncloseContents boolean
Finalizuj zawartość?
FinalizeContents boolean
Tylko błędy dziennika?
LogErrorsOnly boolean
Wyniki dziennika?
LogResults boolean

Czy zwrócić dziennik tekstowy rekordów zamknięty we właściwości Komunikat dziennika?

Czyścić poprawki zawartości?
PurgeContentRevisions boolean
Konkretna data zamknięcia?
SpecificCloseDate date
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Lokalizacja aktualizacji (adres)

Tworzenie/aktualizowanie adresu lokalizacji przy użyciu unikatowego identyfikatora adresu

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer

Identyfikator URI istniejącej lokalizacji do zaktualizowania

Unikatowy identyfikator
Uri integer

Identyfikator URI istniejącej ulicy lub adresu wysyłkowego, który ma zostać zaktualizowany

Typ
LocationAddressAddressType string

Wybierz typ adresu. Limit jednego na typ.

Ulica
LocationAddressAddressLines string
Przedmieścia / Miasto
LocationAddressCity string
State
LocationAddressState string
Kodów pocztowych
LocationAddressPostcode string
Country
LocationAddressCountry string

Zwraca

Lokalizacja aktualizacji (dodatkowe pola)

Aktualizowanie dodatkowych pól w lokalizacji

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri integer
Name
SearchClause string
Wartość
Value string

Zwraca

Lokalizacja aktualizacji (inne)

Aktualizowanie lokalizacji

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri integer
Ciąg zapytania
q string

Określ tutaj zapytanie, aby zastosować aktualizację do zestawu lokalizacji, a nie tylko jednego (określonego przez unikatowy identyfikator).

Name
LocationSortName string
Unikatowa nazwa
LocationNickName string
Numer identyfikatora
LocationIdNumber string
Telefon służbowy
LocationPhoneNumber string
Telefon komórkowy
LocationMobileNumber string
Faks
LocationFaxNumber string
Telefon domowy
LocationAfterHoursPhoneNumber string
Taki sam jak adres
LocationUseAddressOf integer

Unikatowy identyfikator lokalizacji

Ustaw jako domyślne
AddRelationshipMakeThisTheDefaultRelationship boolean
Powiązany unikatowy identyfikator
AddRelationshipRelatedLocation integer
Typ
AddRelationshipRelationshipType string
Adres e-mail
LocationEmailAddress string
Źródło
SetActiveDateRangeValidFromDate string

dd/mm/rrrr

Do
SetActiveDateRangeValidToDate string

dd/mm/rrrr

Notatki
LocationNotes string
Typ aktualizacji notatek
NotesUpdateType string
Powiązany unikatowy identyfikator
RemoveRelationshipRelatedLocation integer

Zwraca

Lokalizacja aktualizacji (osoba)

Aktualizowanie lokalizacji osoby przy użyciu unikatowego identyfikatora

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri integer
Ciąg zapytania
q string

Określ tutaj zapytanie, aby zastosować aktualizację do zestawu lokalizacji, a nie tylko jednego (określonego przez unikatowy identyfikator).

Title
LocationHonorific string
Nazwisko
LocationSurname string
Imię
LocationGivenNames string
Wewnętrzny
LocationIsWithin boolean
Stanowisko
LocationJobDescription string
Data urodzenia
LocationDateOfBirth string
Zwrot grzecznościowy
LocationSalutation string
Unikatowa nazwa
LocationNickName string
Numer identyfikatora
LocationIdNumber string
Telefon służbowy
LocationPhoneNumber string
Telefon komórkowy
LocationMobileNumber string
Faks
LocationFaxNumber string
Telefon domowy
LocationAfterHoursPhoneNumber string
Taki sam jak adres
LocationUseAddressOf integer

Unikatowy identyfikator lokalizacji

Ustaw jako domyślne
AddRelationshipMakeThisTheDefaultRelationship boolean
Powiązany unikatowy identyfikator
AddRelationshipRelatedLocation integer
Typ
AddRelationshipRelationshipType string
Adres e-mail
LocationEmailAddress string
Gender
LocationGenderValue string
Akceptowanie logowań
LocationCanLogin boolean
Logowanie do sieci
LocationLogsInAs string
Dodatkowe logowanie do sieci
LocationAdditionalLogin string
Logowanie wygasa
LocationLoginExpires string
Profil użytkownika
LocationUseProfileOf integer

Unikatowy identyfikator lokalizacji

Typ użytkownika
LocationUserType string
Ciąg zabezpieczeń
LocationSecurityString string
Źródło
SetActiveDateRangeValidFromDate string

dd/mm/rrrr

Do
SetActiveDateRangeValidToDate string

dd/mm/rrrr

Notatki
LocationNotes string
Typ aktualizacji notatek
NotesUpdateType string
Powiązany unikatowy identyfikator
RemoveRelationshipRelatedLocation integer

Zwraca

Odczytywanie danych zdarzenia

Przekształcanie danych zdarzenia Kapish Dispatch na potrzeby użycia przepływu

Parametry

Nazwa Klucz Wymagane Typ Opis
Content
Content string

Zawartość akcji usługi Service Bus, która pobrała dane zdarzenia cm

Zwraca

Pobieranie pliku z adresu URL

Pobieranie pliku z adresu URL do obszaru przejściowego przy użyciu wtyczki interfejsu API usługi CM "GetFileFromUrl"

Parametry

Nazwa Klucz Wymagane Typ Opis
Adres URL pliku
url True string

Niezakodowany adres URL pliku do pobrania

Nazwa pliku do zapisywania jako
filename string

Nazwa pliku do zapisania pobranego adresu URL jako (tylko nazwa pliku z sufiksem, nie dołączaj pełnego katalogu)

Typ zawartości
contentType string

Typowy ciąg znaleziony w większości nagłówków Content-Type (np. image/png, text/plain, application/pdf).

Zwraca

Odpowiedź z wtyczki interfejsu API usługi CM "GetFileFromUrl".

Pobierz plik elektroniczny

Pobieranie elektronicznego pliku rekordu

Parametry

Nazwa Klucz Wymagane Typ Opis
Unikatowy identyfikator
uri True string

Unikatowy identyfikator lub numer rekordu

Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Zwraca

response
binary

Przekazywanie pliku elektronicznego

Przekaż plik elektroniczny, który może być później dołączony do rekordu

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Nazwa pliku
RecordFilePath True string
Unikatowy identyfikator
Uri True string

Rekord aktualizacji (akcje zmiany harmonogramów)

Zmienia harmonogram wszystkich akcji dołączonych do tego rekordu

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer
Od daty bazowej
FromBaseDate date
Używanie rzeczywistych czasów trwania
UseActualDurations boolean
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Rekord aktualizacji (cofanie wyewidencjonowania)

Cofnij poprzednie wyewidencjonowanie dokumentu elektronicznego dla tego rekordu, pomijając wszelkie wprowadzone zmiany, ponieważ został wyewidencjonowany

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer
Comments
Comments string
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Rekord aktualizacji (dodatkowe pola)

Aktualizowanie dodatkowych pól w rekordzie

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri integer
Name
SearchClause string
Wartość
Value string
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Rekord aktualizacji (dodawanie kontroli dostępu)

AddAccessControl

Parametry

Nazwa Klucz Wymagane Typ Opis
Unikatowy identyfikator
Uri True integer
FunctionEnum
FunctionEnum string
Unikatowy identyfikator
Uri integer

Unikatowy identyfikator lokalizacji

Zwraca

Rekord aktualizacji (dołącz akcję lub procedurę)

Dołączanie akcji lub procedury do rekordu

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer
Akcja dołączenia
ActionToAttach True integer
Unikatowy identyfikator przypisywania
NewAssignee integer
Opcja przypisywania
AssigneeOption string
Data rozpoczęcia harmonogramu
ScheduleStartDate date
Istniejąca akcja
RecordAction integer
Wstaw położenie
InsertPos string
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Rekord aktualizacji (dołącz termin Thesaurus)

Dołączanie terminu Thesaurus do rekordu

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Rekord
Uri True integer

Unikatowy identyfikator rekordu w celu dołączenia terminu Thesaurus do

Termin tezaurusa
Keyword True string

Unikatowy identyfikator lub nazwa terminu Thesaurus do dołączenia

Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Rekord aktualizacji (dołączanie pliku elektronicznego)

Dołączanie pliku elektronicznego do rekordu

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

File
File True file

Zawartość/treść dokumentu elektronicznego do dołączenia

Unikatowy identyfikator
Uri True string

Unikatowy identyfikator rekordu

Zwraca

Rekord aktualizacji (finalizowanie)

Aktualizowanie wersji roboczej rekordu

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer
Usuń stare poprawki
SetAsFinalRemoveOldRevisions boolean
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Rekord aktualizacji (klasyfikacja)

Aktualizowanie klasyfikacji rekordu

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer
Classification
RecordClassification True string

Podaj unikatowy identyfikator klasyfikacji

Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Rekord aktualizacji (undispose)

Przywraca stan rekordu (i jego zawartości), aby nie został już usunięty

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer
Czy kontynuować w przypadku błędu?
ContinueOnError boolean
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Rekord aktualizacji (unfinalise — Ustaw jako wersję roboczą)

Aktualizowanie sfinalizowanego rekordu do wersji roboczej

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer

Zwraca

Rekord aktualizacji (ustaw dostęp bez ograniczeń lub na podstawie kontenera)

InheritAccessControl

Parametry

Nazwa Klucz Wymagane Typ Opis
Unikatowy identyfikator
Uri True integer
FunctionEnum
FunctionEnum string
Unikatowy identyfikator
Uri integer

Unikatowy identyfikator lokalizacji

Zwraca

Rekord aktualizacji (usuń lokalizację z kontroli dostępu)

RemoveAccessControl

Parametry

Nazwa Klucz Wymagane Typ Opis
Unikatowy identyfikator
Uri True integer
FunctionEnum
FunctionEnum string
Unikatowy identyfikator
Uri integer

Unikatowy identyfikator lokalizacji

Zwraca

Rekord aktualizacji (wyewidencjonuj)

Ustaw stan rekordu na wyewidencjonowany

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer
Comments
Comments string
Zapisz ścieżkę wyewidencjonowania jako
SaveCheckoutPathAs string
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Rekord aktualizacji (zaawansowane)

Aktualizowanie rekordu za pomocą właściwości zaawansowanych

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer
Typ rekordu
RecordRecordType string
Classification
RecordClassification string

Podaj unikatowy identyfikator klasyfikacji

Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Author
RecordAuthor string

Unikatowy identyfikator lub adres e-mail lokalizacji

Numer przystąpienia
RecordAccessionNumber string
Adresat
RecordAddressee string

Unikatowy identyfikator lub adres e-mail lokalizacji

Kontener alternatywny
RecordAlternativeContainer string
Cesjonariusza
RecordAssignee string

Unikatowy identyfikator lub adres e-mail lokalizacji

Poziom ufności automatycznej klasyfikacji
RecordAutoClassificationConfidenceLevel string
Automatyczne renderowanie do formatu PDF podczas zapisywania
RecordAutoRenderToPDFOnSave boolean
Obejście kontroli dostępu typu rekordu
RecordBypassRecordTypeAccessControls boolean
Czy pominąć zapisywanie?
ByPassSave boolean

Wartość True, aby nie zapisać obiektu. Jednym z tych zastosowań jest ustawienie co najmniej jednej właściwości wpisu rekordu i zwrócenie formularza wprowadzania danych. Formularz wprowadzania danych będzie następnie odzwierciedlać różne właściwości ustawione na oryginalnym rekordzie.

Zmień pozycję w ulubionych
ChangePositionWithinFavorites string

Podczas wyszukiwania ulubionych zostaną one zwrócone w tej kolejności, chyba że zostanie użyty inny sortowanie.

Zmień położenie w etykiecie użytkownika
ChangePositionWithinUserLabel string

Podczas wyszukiwania według elementu UserLabel będą zwracane w tej kolejności, chyba że zostanie użyty inny sortowanie.

Zaewidencjonuj jako
CheckinAs string

Ustaw właściwość Source dokumentu elektronicznego.

Klasa rekordu
RecordClassOfRecord string
Client
RecordClient string

Unikatowy identyfikator lub adres e-mail lokalizacji

Rekord klienta
RecordClientRecord string
Comments
comments string

Komentarze do przechodzenia do notatek rekordów po przekazaniu dokumentu.

Przesyłka
RecordConsignment string
Obiekt przewozowy
RecordConsignmentObject string
Pojemnik
RecordContainer string
Kopiowanie dokumentu z rekordu
CopyDocumentFromRecord string

Określ unikatowy identyfikator rekordu, z którego ma być skopiowany dokument elektroniczny dla tego rekordu.

Kreator
RecordCreator string

Unikatowy identyfikator lub adres e-mail lokalizacji

Data utworzenia
RecordDateCreated string
Data ukończenia
RecordDateDue string
Data publikacji
RecordDatePublished string
Data odebrania
RecordDateReceived string
Editor
RecordEditor string

Unikatowy identyfikator lub adres e-mail lokalizacji

Elektroniczny magazyn dokumentów
RecordEStore string
Dokumentacja zewnętrzna
RecordExternalReference string
Nie można włączyć ostrzeżeń?
FailOnWarnings boolean

Wartość True, aby nie tworzyć/zapisywać obiektu, jeśli istnieją ostrzeżenia.

Nazwa pliku w folderze Uploads
RecordFilePath string

Nazwa pliku wyświetlana w folderze Uploads.

Finalizowanie przy zapisywaniu
RecordFinalizeOnSave boolean
Obcy kod kreskowy
RecordForeignBarcode string
Lokalizacja GPS
RecordGpsLocation string
Lokalizacja domowa
RecordHomeLocation string

Unikatowy identyfikator lokalizacji

Przestrzeń domowa
RecordHomeSpace string
Jest ujęta
RecordIsEnclosed boolean
Jurisdiction
RecordJurisdictions string
Zachowaj wyewidencjonowywanie
keepBookedOut boolean

Wartość True umożliwia pozostawienie wyewidencjonowanego rekordu po przekazaniu dokumentu elektronicznego.

Data ostatniej akcji
RecordLastActionDate string
Długa liczba
RecordLongNumber string
Uaktywnij
MakeActive string

Przywraca stan rekordu (i dowolnej jego zawartości), aby nie był już nieaktywny. Podczas przetwarzania zawartości można określić, czy zadanie powinno zostać zatrzymane, jeśli wystąpią jakieś błędy.

Ustaw jako nieaktywne
MakeInactive string

Ustawia datęInactive dla tego rekordu i dowolną jego zawartość. Podczas przetwarzania zawartości można określić, czy zadanie powinno zostać zatrzymane, jeśli wystąpią jakieś błędy.

Wprowadź nową poprawkę
makeNewRevision boolean

Wartość True, aby utworzyć nową poprawkę z tym dokumentem elektronicznym false, aby zastąpić bieżącą poprawkę.

Data ręcznego zniszczenia
RecordManualDestructionDate string
Rekord materii
RecordMatterRecord string
Typ nośnika
RecordMediaType string
Moje komentarze autoryzacji
RecordMyAuthorizationComments string
Ukończono moją autoryzację
RecordMyAuthorizationComplete boolean
Moje komentarze do przeglądu
RecordMyReviewComments string
Mój przegląd ukończony
RecordMyReviewComplete boolean
Wymaga autoryzacji?
RecordNeedsAuthorization boolean
Potrzebuje przeglądu?
RecordNeedsReview boolean
Nowa reguła tworzenia części
RecordNewPartCreationRule string

Unikatowy identyfikator reguły automatycznego tworzenia części

Notatki
RecordNotes string
Typ aktualizacji notatek
NotesUpdateType string
Inny kontakt
RecordOtherContact string

Unikatowy identyfikator lub adres e-mail lokalizacji

Lokalizacja właściciela
RecordOwnerLocation string

Unikatowy identyfikator lub adres e-mail lokalizacji

Hierarchia zachowania we wpisie danych?
RecordPreserveHierarchyOnDataEntry boolean
Poprzedni rekord części
RecordPrevPartRecord string
Priority
RecordPriority string
Nowy typ rekordu
RecordNewType string

Pozostaw wartość Domyślna, chyba że tworzysz nową wersję części lub kopiuj.

Rekord pokrewny
RecordRelatedRecord string
Przedstawiciel
RecordRepresentative string
Harmonogram przechowywania
RecordRetentionSchedule string
Data przeglądu
RecordReviewDate string
Data ukończenia przeglądu
RecordReviewDueDate string
Stan przeglądu
RecordReviewState string
Zabezpieczenia
RecordSecurity string
Rekord serii
RecordSeriesRecord string
Tytuł (część tekstowa bezpłatna)
RecordTypedTitle string
Ciąg zapytania
q string

Określ tutaj zapytanie, aby zastosować aktualizację do zestawu rekordów, a nie tylko jednego (określonego przez unikatowy identyfikator).

Zwraca

Rekord aktualizacji (zastąp kontrolki dostępu)

SetAccessControl

Parametry

Nazwa Klucz Wymagane Typ Opis
Unikatowy identyfikator
Uri True integer
FunctionEnum
FunctionEnum string
Unikatowy identyfikator
Uri integer

Unikatowy identyfikator lokalizacji

Zwraca

Rekord aktualizacji (żądanie odwzorowania)

Umożliwia utworzenie żądania dla aparatu automatycznego renderowania w celu utworzenia odwzorowania rekordu

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer
Typ odwzorowania
RenditionType True string
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Zwraca

Tworzenie rekordu (dokument)

Tworzenie rekordu

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Typ rekordu
RecordRecordType True string
Tytuł (część tekstowa bezpłatna)
RecordTypedTitle True string
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Author
RecordAuthor string

Unikatowy identyfikator lub adres e-mail lokalizacji

Adresat
RecordAddressee string

Unikatowy identyfikator lub adres e-mail lokalizacji

Kontener alternatywny
RecordAlternativeContainer string
Cesjonariusza
RecordAssignee string

Unikatowy identyfikator lub adres e-mail lokalizacji

Automatyczne renderowanie do formatu PDF podczas zapisywania
RecordAutoRenderToPDFOnSave boolean
Obejście kontroli dostępu typu rekordu
RecordBypassRecordTypeAccessControls boolean
Zaewidencjonuj jako
CheckinAs string

Ustaw właściwość Source dokumentu elektronicznego.

Classification
RecordClassification string

Podaj unikatowy identyfikator klasyfikacji

Client
RecordClient string

Unikatowy identyfikator lub adres e-mail lokalizacji

Rekord klienta
RecordClientRecord string
Pojemnik
RecordContainer string
Kopiowanie dokumentu z rekordu
CopyDocumentFromRecord string

Określ unikatowy identyfikator rekordu, z którego ma być skopiowany dokument elektroniczny dla tego rekordu.

Kreator
RecordCreator string

Unikatowy identyfikator lub adres e-mail lokalizacji

Data utworzenia
RecordDateCreated string
Data ukończenia
RecordDateDue string
Data publikacji
RecordDatePublished string
Data odebrania
RecordDateReceived string
Dokumentacja zewnętrzna
RecordExternalReference string
Nie można włączyć ostrzeżeń?
FailOnWarnings boolean

Wartość True, aby nie tworzyć/zapisywać obiektu, jeśli istnieją ostrzeżenia.

Nazwa pliku w folderze Uploads
RecordFilePath string

Nazwa pliku wyświetlana w folderze Uploads.

Finalizowanie przy zapisywaniu
RecordFinalizeOnSave boolean
Obcy kod kreskowy
RecordForeignBarcode string
Lokalizacja GPS
RecordGpsLocation string
Lokalizacja domowa
RecordHomeLocation string

Unikatowy identyfikator lokalizacji

Przestrzeń domowa
RecordHomeSpace string
Jest ujęta
RecordIsEnclosed boolean
Jurisdiction
RecordJurisdictions string
Zachowaj wyewidencjonowywanie
keepBookedOut boolean

Wartość True umożliwia pozostawienie wyewidencjonowanego rekordu po przekazaniu dokumentu elektronicznego.

Data ostatniej akcji
RecordLastActionDate string
Długa liczba
RecordLongNumber string
Typ nośnika
RecordMediaType string
Notatki
RecordNotes string
Typ aktualizacji notatek
NotesUpdateType string
Inny kontakt
RecordOtherContact string

Unikatowy identyfikator lub adres e-mail lokalizacji

Lokalizacja właściciela
RecordOwnerLocation string

Unikatowy identyfikator lub adres e-mail lokalizacji

Rekord pokrewny
RecordRelatedRecord string
Przedstawiciel
RecordRepresentative string

Unikatowy identyfikator lub adres e-mail lokalizacji

Data przeglądu
RecordReviewDate string
Data ukończenia przeglądu
RecordReviewDueDate string
Stan przeglądu
RecordReviewState string
Zabezpieczenia
RecordSecurity string

Zwraca

Tworzenie rekordu (folder)

Tworzenie rekordu

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Typ rekordu
RecordRecordType True string
Tytuł (część tekstowa bezpłatna)
RecordTypedTitle True string
Classification
RecordClassification string

Podaj unikatowy identyfikator klasyfikacji

Pojemnik
RecordContainer string
Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Author
RecordAuthor string

Unikatowy identyfikator lub adres e-mail lokalizacji

Adresat
RecordAddressee string

Unikatowy identyfikator lub adres e-mail lokalizacji

Kontener alternatywny
RecordAlternativeContainer string
Cesjonariusza
RecordAssignee string

Unikatowy identyfikator lub adres e-mail lokalizacji

Obejście kontroli dostępu typu rekordu
RecordBypassRecordTypeAccessControls boolean
Client
RecordClient string

Unikatowy identyfikator lub adres e-mail lokalizacji

Kreator
RecordCreator string

Unikatowy identyfikator lub adres e-mail lokalizacji

Data utworzenia
RecordDateCreated string
Data ukończenia
RecordDateDue string
Data publikacji
RecordDatePublished string
Dokumentacja zewnętrzna
RecordExternalReference string
Nie można włączyć ostrzeżeń?
FailOnWarnings boolean

Wartość True, aby nie tworzyć/zapisywać obiektu, jeśli istnieją ostrzeżenia.

Nazwa pliku w folderze Uploads
RecordFilePath string

Nazwa pliku wyświetlana w folderze Uploads.

Obcy kod kreskowy
RecordForeignBarcode string
Lokalizacja GPS
RecordGpsLocation string
Lokalizacja domowa
RecordHomeLocation string

Unikatowy identyfikator lokalizacji

Przestrzeń domowa
RecordHomeSpace string
Jest ujęta
RecordIsEnclosed boolean
Jurisdiction
RecordJurisdictions string
Data ostatniej akcji
RecordLastActionDate string
Długa liczba
RecordLongNumber string
Notatki
RecordNotes string
Typ aktualizacji notatek
NotesUpdateType string
Inny kontakt
RecordOtherContact string

Unikatowy identyfikator lub adres e-mail lokalizacji

Lokalizacja właściciela
RecordOwnerLocation string

Unikatowy identyfikator lub adres e-mail lokalizacji

Rekord pokrewny
RecordRelatedRecord string
Przedstawiciel
RecordRepresentative string

Unikatowy identyfikator lub adres e-mail lokalizacji

Data przeglądu
RecordReviewDate string
Data ukończenia przeglądu
RecordReviewDueDate string
Stan przeglądu
RecordReviewState string
Zabezpieczenia
RecordSecurity string

Zwraca

Tworzenie rekordu (zaawansowane)

Tworzenie rekordu z polami zaawansowanymi

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Typ rekordu
RecordRecordType True string
Tytuł (część tekstowa bezpłatna)
RecordTypedTitle True string
Classification
RecordClassification string

Podaj unikatowy identyfikator klasyfikacji

Author
RecordAuthor string

Unikatowy identyfikator lub adres e-mail lokalizacji

Właściwości
Properties string

Rozdzielana przecinkami lista właściwości do zwrócenia

Numer przystąpienia
RecordAccessionNumber string
Adresat
RecordAddressee string

Unikatowy identyfikator lub adres e-mail lokalizacji

Kontener alternatywny
RecordAlternativeContainer string
Cesjonariusza
RecordAssignee string

Unikatowy identyfikator lub adres e-mail lokalizacji

Poziom ufności automatycznej klasyfikacji
RecordAutoClassificationConfidenceLevel string
Automatyczne renderowanie do formatu PDF podczas zapisywania
RecordAutoRenderToPDFOnSave boolean
Obejście kontroli dostępu typu rekordu
RecordBypassRecordTypeAccessControls boolean
Czy pominąć zapisywanie?
ByPassSave boolean

Wartość True, aby nie zapisać obiektu. Jednym z tych zastosowań jest ustawienie co najmniej jednej właściwości wpisu rekordu i zwrócenie formularza wprowadzania danych. Formularz wprowadzania danych będzie następnie odzwierciedlać różne właściwości ustawione na oryginalnym rekordzie.

Zmień pozycję w ulubionych
ChangePositionWithinFavorites string

Podczas wyszukiwania ulubionych zostaną one zwrócone w tej kolejności, chyba że zostanie użyty inny sortowanie.

Zmień położenie w etykiecie użytkownika
ChangePositionWithinUserLabel string

Podczas wyszukiwania według elementu UserLabel będą zwracane w tej kolejności, chyba że zostanie użyty inny sortowanie.

Zaewidencjonuj jako
CheckinAs string

Ustaw właściwość Source dokumentu elektronicznego.

Klasa rekordu
RecordClassOfRecord string
Client
RecordClient string

Unikatowy identyfikator lub adres e-mail lokalizacji

Rekord klienta
RecordClientRecord string
Comments
comments string

Komentarze do przechodzenia do notatek rekordów po przekazaniu dokumentu.

Przesyłka
RecordConsignment string
Obiekt przewozowy
RecordConsignmentObject string
Pojemnik
RecordContainer string
Kopiowanie dokumentu z rekordu
CopyDocumentFromRecord string

Określ unikatowy identyfikator rekordu, z którego ma być skopiowany dokument elektroniczny dla tego rekordu.

Kreator
RecordCreator string

Unikatowy identyfikator lub adres e-mail lokalizacji

Data utworzenia
RecordDateCreated string
Data ukończenia
RecordDateDue string
Data publikacji
RecordDatePublished string
Data odebrania
RecordDateReceived string
Editor
RecordEditor string

Unikatowy identyfikator lub adres e-mail lokalizacji

Dokumentacja zewnętrzna
RecordExternalReference string
Nie można włączyć ostrzeżeń?
FailOnWarnings boolean

Wartość True, aby nie tworzyć/zapisywać obiektu, jeśli istnieją ostrzeżenia.

Nazwa pliku w folderze Uploads
RecordFilePath string

Nazwa pliku wyświetlana w folderze Uploads.

Finalizowanie przy zapisywaniu
RecordFinalizeOnSave boolean
Obcy kod kreskowy
RecordForeignBarcode string
Lokalizacja GPS
RecordGpsLocation string
Lokalizacja domowa
RecordHomeLocation string

Unikatowy identyfikator lokalizacji

Przestrzeń domowa
RecordHomeSpace string
Inicjowanie szablonu
RecordInitiateTemplate string
Jest ujęta
RecordIsEnclosed boolean
Jurisdiction
RecordJurisdictions string
Zachowaj wyewidencjonowywanie
keepBookedOut boolean

Wartość True umożliwia pozostawienie wyewidencjonowanego rekordu po przekazaniu dokumentu elektronicznego.

Data ostatniej akcji
RecordLastActionDate string
Długa liczba
RecordLongNumber string
Uaktywnij
MakeActive string

Przywraca stan rekordu (i dowolnej jego zawartości), aby nie był już nieaktywny. Podczas przetwarzania zawartości można określić, czy zadanie powinno zostać zatrzymane, jeśli wystąpią jakieś błędy.

Ustaw jako nieaktywne
MakeInactive string

Ustawia datęInactive dla tego rekordu i dowolną jego zawartość. Podczas przetwarzania zawartości można określić, czy zadanie powinno zostać zatrzymane, jeśli wystąpią jakieś błędy.

Wprowadź nową poprawkę
makeNewRevision boolean

Wartość True, aby utworzyć nową poprawkę z tym dokumentem elektronicznym false, aby zastąpić bieżącą poprawkę.

Data ręcznego zniszczenia
RecordManualDestructionDate string
Rekord materii
RecordMatterRecord string
Typ nośnika
RecordMediaType string
Moje komentarze autoryzacji
RecordMyAuthorizationComments string
Ukończono moją autoryzację
RecordMyAuthorizationComplete boolean
Moje komentarze do przeglądu
RecordMyReviewComments string
Mój przegląd ukończony
RecordMyReviewComplete boolean
Wymaga autoryzacji?
RecordNeedsAuthorization boolean
Potrzebuje przeglądu?
RecordNeedsReview boolean
Nowa reguła tworzenia części
RecordNewPartCreationRule string

Unikatowy identyfikator reguły automatycznego tworzenia części

Notatki
RecordNotes string
Typ aktualizacji notatek
NotesUpdateType string
Inny kontakt
RecordOtherContact string

Unikatowy identyfikator lub adres e-mail lokalizacji

Lokalizacja właściciela
RecordOwnerLocation string

Unikatowy identyfikator lub adres e-mail lokalizacji

Hierarchia zachowania we wpisie danych?
RecordPreserveHierarchyOnDataEntry boolean
Poprzedni rekord części
RecordPrevPartRecord string
Priority
RecordPriority string
Nowy typ rekordu
RecordNewType string

Pozostaw wartość Domyślna, chyba że tworzysz nową wersję części lub kopiuj.

Rekord pokrewny
RecordRelatedRecord string
Przedstawiciel
RecordRepresentative string
Harmonogram przechowywania
RecordRetentionSchedule string
Data przeglądu
RecordReviewDate string
Data ukończenia przeglądu
RecordReviewDueDate string
Stan przeglądu
RecordReviewState string
Zabezpieczenia
RecordSecurity string
Rekord serii
RecordSeriesRecord string
Zestawy właściwości
propertySets string

Określ zestawy właściwości oprócz tych opublikowanych, które mają być zwracane przez żądanie.

Ciąg zapytania
q string

Określ tutaj zapytanie, aby zastosować aktualizację do zestawu rekordów, a nie tylko jednego (określonego przez unikatowy identyfikator).

Zwraca

Usuń rekord

Usuwanie rekordu

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Uri True integer

Unikatowy identyfikator rekordu do usunięcia

Czy usunąć zawartość?
DeleteContents True boolean
Nowy dom zawartości
NewHomeForContents string

Unikatowy identyfikator lub adres e-mail nowej lokalizacji głównej dla zawartości

Zwraca

Utwórz lokalizację (inne)

Tworzenie lokalizacji dowolnego typu

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Typ lokalizacji
LocationTypeOfLocation string
Name
LocationSortName True string
Unikatowa nazwa
LocationNickName string
Numer identyfikatora
LocationIdNumber string
Wewnętrzny
LocationIsWithin boolean
Telefon służbowy
LocationPhoneNumber string
Telefon komórkowy
LocationMobileNumber string
Faks
LocationFaxNumber string
Telefon domowy
LocationAfterHoursPhoneNumber string
Taki sam jak adres
LocationUseAddressOf integer

Unikatowy identyfikator lokalizacji

Typ adresu
LocationAddressAddressType string

Wybierz typ adresu. Limit jednego na typ.

Ulica
LocationAddressAddressLines string
Przedmieścia / Miasto
LocationAddressCity string
State
LocationAddressState string
Kodów pocztowych
LocationAddressPostcode string
Country
LocationAddressCountry string
Ustaw jako domyślne
AddRelationshipMakeThisTheDefaultRelationship boolean
Powiązany unikatowy identyfikator
AddRelationshipRelatedLocation integer
Typ
AddRelationshipRelationshipType string
Adres e-mail
LocationEmailAddress string
Źródło
SetActiveDateRangeValidFromDate string

dd/mm/rrrr

Do
SetActiveDateRangeValidToDate string

dd/mm/rrrr

Notatki
LocationNotes string
Typ aktualizacji notatek
NotesUpdateType string

Zwraca

Utwórz lokalizację (osoba)

Tworzenie lokalizacji osoby

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Title
LocationHonorific string
Nazwisko
LocationSurname string
Imię
LocationGivenNames string
Wewnętrzny
LocationIsWithin boolean
Stanowisko
LocationJobDescription string
Data urodzenia
LocationDateOfBirth string
Zwrot grzecznościowy
LocationSalutation string
Unikatowa nazwa
LocationNickName string
Numer identyfikatora
LocationIdNumber string
Telefon służbowy
LocationPhoneNumber string
Telefon komórkowy
LocationMobileNumber string
Faks
LocationFaxNumber string
Telefon domowy
LocationAfterHoursPhoneNumber string
Taki sam jak adres
LocationUseAddressOf integer

Unikatowy identyfikator lokalizacji

Typ adresu
LocationAddressAddressType string

Wybierz typ adresu. Limit jednego na typ.

Ulica
LocationAddressAddressLines string
Przedmieścia / Miasto
LocationAddressCity string
State
LocationAddressState string
Kodów pocztowych
LocationAddressPostcode string
Country
LocationAddressCountry string
Ustaw jako domyślne
AddRelationshipMakeThisTheDefaultRelationship boolean
Powiązany unikatowy identyfikator
AddRelationshipRelatedLocation integer
Typ
AddRelationshipRelationshipType string
Adres e-mail
LocationEmailAddress string
Gender
LocationGenderValue string
Akceptowanie logowań
LocationCanLogin boolean
Logowanie do sieci
LocationLogsInAs string
Dodatkowe logowanie do sieci
LocationAdditionalLogin string
Logowanie wygasa
LocationLoginExpires string
Profil użytkownika
LocationUseProfileOf integer

Unikatowy identyfikator lokalizacji

Typ użytkownika
LocationUserType string
Ciąg zabezpieczeń
LocationSecurityString string
Źródło
SetActiveDateRangeValidFromDate string

dd/mm/rrrr

Do
SetActiveDateRangeValidToDate string

dd/mm/rrrr

Notatki
LocationNotes string
Typ aktualizacji notatek
NotesUpdateType string

Zwraca

Znajdowanie lokalizacji

Wyszukaj lokalizacje (pobierz kolekcję lokalizacji przy użyciu ciągu wyszukiwania)

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Query
q True string

Wprowadź zapytanie wyszukiwania, np. "all", aby pobrać wszystkie obiekty.

Zastosuj wartości domyślne
ApplyDefaults boolean

Wartość True w celu zastosowania domyślnego filtru użytkownika i sortowania do tego wyszukiwania

Liczba wyników
CountResults boolean

Wartość True w celu uwzględnienia liczby wyników

Liczba wyklucz
ExcludeCount boolean

Wartość True, aby wykluczyć liczbę wyników

Filter
filter string

Rozdzielona spacją lista klauzul wyszukiwania, które mają być stosowane jako filtr.

Z wyszukiwarki
fromSearch string

Unikatowy identyfikator zapisanego wyszukiwania, z którego ma być skonstruowane to wyszukiwanie

Właściwości potomne
descendantProperties string

Rozdzielona przecinkami lista właściwości obiektu ma zastosowanie tylko do właściwości obiektu tego i niższych właściwości, np. RecordNumber,RecordTitle

Uwzględnij definicje właściwości
IncludePropertyDefs boolean

Wartość True zwracająca tablicę definicji właściwości używanych przez właściwości w tej odpowiedzi

Opcje
Options string

Ustaw co najmniej jedną z opcji zwykle ustawioną w obszarze Opcje użytkownika tylko dla tego wyszukiwania. Czy używać identyfikatorów z /PropertyDef? Get=SearchOptions service, dołącz znak minus, aby ustawić wartość false, w przeciwnym razie zakłada się, że wartość true.

Właściwości
properties string

Rozdzielona przecinkami lista właściwości obiektu, np. RecordNumber, RecordTitle

Zestawy właściwości
propertySets string

Co najmniej jeden wstępnie zdefiniowany zestaw właściwości, wybierz pozycję DataGridVisible, Detailed, FromSearch, All lub niestandardowy zestaw właściwości zgodnie z definicją w konfiguracji usługi

Wartość właściwości
PropertyValue string

Uwzględnij wartość nieprzetworzona, wartość ciągu lub obie wartości w wynikach

Rozmiar strony
pageSize string

Liczba elementów, które mają być zwracane na każdej stronie wyników

Przeznaczenie
purpose string

Specjalna właściwość służąca do filtrowania wyników wyszukiwania na podstawie wartości wyliczenia przeznaczenie obiektu

Cel dodatkowy
purposeExtra string

Konieczne jako dodatek do niektórych celów. Usługa ObjectDef udostępnia informacje o typie wyliczenia lub TrimMainObject do określenia, w szczególności ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes i HaveExtraPurposeParameter.

Sortuj wg
sortBy string

Rozdzielona przecinkami lista identyfikatorów klauzuli wyszukiwania

Start
start string

Pozycja w zestawie wyników na początek, pusta (lub 1), aby rozpocząć od początku, 2, aby rozpocząć od drugiego obiektu, 3 na trzecim itd.

Typ wyświetlania ciągu
stringDisplayType string

Jeśli zwraca wartość ciągu, która ma być używana w formacie

Zwraca

Znajdowanie obiektów cm

Wyszukiwanie obiektów CM

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Szukaj
TrimType True string
Ciąg zapytania
q True string

Wprowadź zapytanie wyszukiwania, np. "all", aby pobrać wszystkie obiekty.

Zastosuj wartości domyślne
ApplyDefaults boolean

Wartość True, aby zastosować domyślny filtr użytkownika i sortować je do tego wyszukiwania.

Liczba wyników
CountResults boolean

Funkcja CountResults zwraca najbardziej niezawodną i najwolniejszą liczbę wyników wyszukiwania. Wynikowa liczba jest we właściwości Count odpowiedzi.

Właściwości potomne
DescendantProperties string

Rozdzielona przecinkami lista właściwości obiektu ma zastosowanie tylko do właściwości obiektu tego i niższych właściwości, np. RecordNumber, RecordTitle.

Liczba wyklucz
ExcludeCount boolean

Zwracanie wartości TotalResults i SearchTitle może obniżyć wydajność. Ustaw wartość true, jeśli wartości TotalResults i SearchTitle nie są wymagane.

Filter
Filter string

Rozdzielona spacją lista klauzul wyszukiwania, które mają być stosowane jako filtr.

Z wyszukiwarki
FromSearch integer

Unikatowy identyfikator zapisanego wyszukiwania, z którego ma być skonstruowane to wyszukiwanie.

Uwzględnij defs właściwości
IncludePropertyDefs boolean

Wartość True zwracająca tablicę definicji właściwości używanych przez właściwości w tej odpowiedzi.

Opcje
Options string

Ustaw co najmniej jedną z opcji zwykle ustawioną w obszarze Opcje użytkownika tylko dla tego wyszukiwania. Czy używać identyfikatorów z /PropertyDef? Get=SearchOptions service, dołącz znak minus, aby ustawić wartość false, w przeciwnym razie zakłada się, że wartość true.

Rozmiar strony
pageSize integer

Liczba elementów, które mają być zwracane na każdej stronie wyników. Jeśli wartość jest pusta, wartość domyślna zostanie ustawiona w konfiguracji.

Wartość właściwości
PropertyValue string

Uwzględnij wartość nieprzetworzona, wartość ciągu lub obie wartości w wynikach.

Zestawy właściwości
PropertySets string

Co najmniej jeden wstępnie zdefiniowany zestaw właściwości, wybierz pozycję DataGridVisible, Detailed, FromSearch, All lub niestandardowy zestaw właściwości zgodnie z definicją w konfiguracji usługi.

Przeznaczenie
purpose integer

Specjalna właściwość służąca do filtrowania wyników wyszukiwania na podstawie wartości wyliczenia przeznaczenie obiektu.

Cel dodatkowy
purposeExtra integer

Konieczne jako dodatek do niektórych celów. Usługa ObjectDef udostępnia informacje o typie wyliczenia lub TrimMainObject do określenia, w szczególności ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes i HaveExtraPurposeParameter.

Sortuj wg
sortBy string

Rozdzielona przecinkami lista identyfikatorów klauzuli wyszukiwania. Użyj — aby określić malejąco. Na przykład Number- aby posortować rekordy według liczby malejącej.

Start
start integer

Pozycja w zestawie wyników na początek, pusta (lub 1), aby rozpocząć od początku, 2, aby rozpocząć od drugiego obiektu, 3 na trzecim itd.

StringDisplayType
StringDisplayType string

Jeśli zwraca wartość ciągu, która ma być używana w formacie.

Właściwości
properties string

Rozdzielona przecinkami lista właściwości obiektu, np. Identyfikator URI, NameString

Zwraca

Znajdowanie rekordu według identyfikatora

Pobieranie pojedynczego rekordu według unikatowego identyfikatora lub nazwy

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

identyfikator
Id True string

Unikatowy identyfikator obiektu lub nazwa

Uwzględnij definicje właściwości
IncludePropertyDefs boolean

Wartość True zwracająca tablicę definicji właściwości używanych przez właściwości w tej odpowiedzi

Właściwości potomne
descendantProperties string

Rozdzielona przecinkami lista właściwości obiektu ma zastosowanie tylko do właściwości obiektu tego i niższych właściwości, np. RecordNumber, RecordTitle.

Właściwości
properties string

Rozdzielona przecinkami lista właściwości obiektu, np. RecordNumber, RecordTitle.

Zestawy właściwości
propertySets string

Co najmniej jeden wstępnie zdefiniowany zestaw właściwości, wybierz pozycję DataGridVisible, Detailed, FromSearch, All lub niestandardowy zestaw właściwości zgodnie z definicją w konfiguracji usługi.

Wartość właściwości
PropertyValue string

Uwzględnij wartość nieprzetworzona, wartość ciągu lub obie wartości w wynikach

Typ wyświetlania ciągu
stringDisplayType string

Jeśli zwraca wartość ciągu, która ma być używana w formacie

Zwraca

Znajdowanie rekordów

Wyszukiwanie rekordów (pobieranie kolekcji rekordów przy użyciu ciągu wyszukiwania)

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Query
q True string

Kwerenda wyszukiwania

Właściwości
properties True string

Rozdzielona przecinkami lista właściwości do zwrócenia

Zwraca

Znajdowanie rekordów (zaawansowane)

Wyszukaj ciąg Rekordy (pobierz kolekcję rekordów przy użyciu ciągu wyszukiwania). Zwraca nieprzetworzona odpowiedź serviceAPI menedżera zawartości.

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Query
q True string

Kwerenda wyszukiwania

Właściwości
properties True string

Rozdzielona przecinkami lista właściwości do zwrócenia

Zwraca

response
object

Znajdowanie unikatowego identyfikatora adresu lokalizacji

Uzyskiwanie unikatowego identyfikatora adresu podrzędnego lokalizacji

Parametry

Nazwa Klucz Wymagane Typ Opis
Typ
type string

Wybierz typ adresu

Unikatowy identyfikator
LocationUri True string

Unikatowy identyfikator lokalizacji

Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Zwraca

Adres podrzędny
CMLocationAddressUri

Znajdź lokalizację według identyfikatora

Pobieranie pojedynczej lokalizacji według unikatowego identyfikatora lub nazwy

Parametry

Nazwa Klucz Wymagane Typ Opis
Personifikuj użytkownika
userToImpersonate string

Logowanie sieciowe lub alternatywne logowanie lokalizacji w cm w celu personifikacji

Unikatowy identyfikator
Id True string

Unikatowy identyfikator obiektu lub nazwa

Właściwości potomne
descendantProperties string

Rozdzielona przecinkami lista właściwości obiektu ma zastosowanie tylko do właściwości obiektu tego i niższych poziomów, np. Nazwisko, GivenNames

Uwzględnij definicje właściwości
IncludePropertyDefs boolean

Wartość True zwracająca tablicę definicji właściwości używanych przez właściwości w tej odpowiedzi

Właściwości
properties string

Rozdzielona przecinkami lista właściwości obiektu, np. Nazwisko,GivenNames

Zestawy właściwości
propertySets string

Co najmniej jeden wstępnie zdefiniowany zestaw właściwości, wybierz pozycję DataGridVisible, Detailed, FromSearch, All lub niestandardowy zestaw właściwości zgodnie z definicją w konfiguracji usługi

Wartość właściwości
PropertyValue string

Uwzględnij wartość nieprzetworzona, wartość ciągu lub obie wartości w wynikach

Typ wyświetlania ciągu
stringDisplayType string

Zwraca wartość ciągu, która ma być używana w formacie

Zwraca

Definicje

CmRecord

Nazwa Ścieżka Typ Opis
Ścieżka pliku
RecordFilePath string

Nazwa pliku wyświetlana w folderze Uploads

Numer przystąpienia
RecordAccessionNumber integer
Adresat
RecordAddressee integer
Kontener alternatywny
RecordAlternativeContainer integer
Cesjonariusza
RecordAssignee integer
Author
RecordAuthor integer
Metoda autoryzacji
RecordAuthorizationMethod string
Poziom ufności automatycznej klasyfikacji
RecordAutoClassificationConfidenceLevel integer
Automatyczne renderowanie do formatu PDF podczas zapisywania
RecordAutoRenderToPDFOnSave boolean
Tytuł niebieskiego wydruku
RecordBlueprintTitle string
Obejście kontroli dostępu typu rekordu
RecordBypassRecordTypeAccessControls boolean
Zaewidencjonowane przez
RecordCheckedInBy integer
Wyewidencjonowany do
RecordCheckedOutTo integer
Classification
RecordClassification integer
Klasa rekordu
RecordClassOfRecord string
Client
RecordClient integer
Rekord klienta
RecordClientRecord integer
Przesyłka
RecordConsignment string
Obiekt przewozowy
RecordConsignmentObject string
Pojemnik
RecordContainer integer
Kreator
RecordCreator integer
Bieżąca wersja
RecordCurrentVersion string
Data zamknięcia
RecordDateClosed date-time
Data utworzenia
RecordDateCreated date-time
Data ukończenia
RecordDateDue date-time
Data sfinalizowana
RecordDateFinalized date-time
Data zaimportowania
RecordDateImported date-time
Data nieaktywna
RecordDateInactive date-time
Data modyfikacji
RecordDateModified date-time
Data publikacji
RecordDatePublished date-time
Data odebrania
RecordDateReceived date-time
Data zarejestrowania
RecordDateRegistered date-time
Oczekiwanie na dołączenie dokumentu
RecordDocumentAttachPending boolean
Rozmiar dokumentu
RecordDocumentSize integer
Typ dokumentu
RecordDocumentType string
Editor
RecordEditor integer
Elektroniczny magazyn dokumentów
RecordEStore integer
Rozszerzenie dokumentu
RecordExtension string
Dokumentacja zewnętrzna
RecordExternalReference string
Finalizowanie przy zapisywaniu
RecordFinalizeOnSave boolean
Źródło folderu
RecordFolderOrigin integer
Obcy kod kreskowy
RecordForeignBarcode string
Wygenerowany tytuł
RecordGeneratedTitle string
Lokalizacja GPS
RecordGpsLocation string
Lokalizacja domowa
RecordHomeLocation integer
Przestrzeń domowa
RecordHomeSpace integer
Inicjowanie szablonu
RecordInitiateTemplate string

Unikatowy identyfikator szablonu przepływu pracy

Jest ujęta
RecordIsEnclosed boolean
Jurisdiction
RecordJurisdictions string
Data ostatniej akcji
RecordLastActionDate date-time
Ostatni rekord części
RecordLastPartRecord integer
Najnowsza wersja
RecordLatestVersion integer
Liczba rozszerzona
RecordLongNumber string
Numer rekordu
RecordNumber string
Data ręcznego zniszczenia
RecordManualDestructionDate date-time
Rekord materii
RecordMatterRecord integer
Typ nośnika
RecordMediaType string
Spotkanie
RecordMeeting integer
Typ mime
RecordMimeType string
Moje komentarze autoryzacji
RecordMyAuthorizationComments string
Ukończono moją autoryzację
RecordMyAuthorizationComplete boolean
Moje komentarze do przeglądu
RecordMyReviewComments string
Mój przegląd ukończony
RecordMyReviewComplete boolean
Liczba stron?
RecordNbrPages integer
Wymaga autoryzacji?
RecordNeedsAuthorization boolean
Potrzebuje przeglądu?
RecordNeedsReview boolean
Nowa reguła tworzenia części
RecordNewPartCreationRule string

Unikatowy identyfikator reguły automatycznego tworzenia części

Następny rekord części
RecordNextPartRecord integer
Typ aktualizacji notatek
NotesUpdateType string
Notatki
RecordNotes string
Pochodzi z
RecordOriginatedFrom string
Pochodzi z przebiegu
RecordOriginatedFromRun string
Inny kontakt
RecordOtherContact integer
Lokalizacja właściciela
RecordOwnerLocation integer
Hierarchia zachowania we wpisie danych?
RecordPreserveHierarchyOnDataEntry boolean
Poprzedni rekord części
RecordPrevPartRecord integer
Kontakt podstawowy
RecordPrimaryContact integer
Priority
RecordPriority string
Typ rekordu
RecordRecordType integer
Rekord pokrewny
RecordRelatedRecord integer
Przedstawiciel
RecordRepresentative integer
Harmonogram przechowywania
RecordRetentionSchedule integer
Data przeglądu
RecordReviewDate date-time
Data ukończenia przeglądu
RecordReviewDueDate date-time
Stan przeglądu
RecordReviewState string
Rekord części głównej
RecordRootPartRecord integer
Zabezpieczenia
RecordSecurity string
Rekord serii
RecordSeriesRecord integer
Title
RecordTitle string
Tytuł (część tekstowa bezpłatna)
RecordTypedTitle string
Unikatowy identyfikator
Uri integer
Dodatkowe pola
Fields object

CMEventData

Nazwa Ścieżka Typ Opis
Unikatowy identyfikator zdarzenia
OnlineEventUri integer
Identyfikator typu zdarzenia
EventType integer
Typ zdarzenia
EventTypeString string
Data zdarzenia
EventDate date-time
Identyfikator typu obiektu
ObjectType integer
Typ obiektu
ObjectTypeString string
Unikatowy identyfikator obiektu
ObjectUri integer
Identyfikator powiązanego typu obiektu
RelatedObjectType integer
Typ obiektu pokrewnego
RelatedObjectTypeString string
Unikatowy identyfikator obiektu pokrewnego
RelatedObjectUri integer
Z komputera
FromMachine string
Adres IP połączenia
ConnectionIPAddress string
Adres IP klienta
ClientIPAddress string
Ze strefy czasowej
FromTimeZone integer
Nazwa logowania
LoginName string
Unikatowy identyfikator logowania
LoginUri integer
Dodatkowe szczegóły
ExtraDetails string

CMLogMessage

Nazwa Ścieżka Typ Opis
Komunikat dziennika
LogMessage string
Szukaj
TrimType CMTrimType
Unikatowy identyfikator
Uri integer

CMRecordsResponse

Nazwa Ścieżka Typ Opis
Results
Results array of CMRecord
UpdateErrorResults
UpdateErrorResults array of CMUpdateErrorResponse
Łączna liczba wyników
TotalResults integer
Liczba ciągów ex
CountStringEx string
Minimalna liczba
MinimumCount integer
Liczba
Count integer
Ma więcej elementów
HasMoreItems boolean
Tytuł wyszukiwania
SearchTitle string
Naciśnij pozycję Wyróżnij ciąg
HitHighlightString string
Szukaj
TrimType CMTrimType
Stan odpowiedzi
ResponseStatus CMResponseStatus

Stan odpowiedzi

CMLogResponse

Nazwa Ścieżka Typ Opis
Results
Results array of CMLogMessage
UpdateErrorResults
UpdateErrorResults array of CMUpdateErrorResponse
Łączna liczba wyników
TotalResults integer
Liczba ciągów ex
CountStringEx string
Minimalna liczba
MinimumCount integer
Liczba
Count integer
Ma więcej elementów
HasMoreItems boolean
Tytuł wyszukiwania
SearchTitle string
Naciśnij pozycję Wyróżnij ciąg
HitHighlightString string
Szukaj
TrimType CMTrimType
Stan odpowiedzi
ResponseStatus CMResponseStatus

Stan odpowiedzi

CMUpdateErrorResponse

Odpowiedź na błąd aktualizacji

Nazwa Ścieżka Typ Opis
Kod błędu
ErrorCode string
Unikatowy identyfikator
Uri integer
Message
Message string
Name
Name string
Nazwa (dodatkowa)
NameExtra string

CMResponseStatus

Stan odpowiedzi

Nazwa Ścieżka Typ Opis
Kod błędu
ErrorCode string
Message
Message string
StackTrace
StackTrace string
Errors
Errors array of CMResponseError
Meta
Meta object

Ciąg słownika<, ciąg>

CMResponseError

Błąd odpowiedzi

Nazwa Ścieżka Typ Opis
Kod błędu
ErrorCode string
Nazwa pola
FieldName string
Message
Message string
Meta
Meta object

Ciąg słownika<, ciąg>

CMTrimType

Szukaj
string

CmLocation

Nazwa Ścieżka Typ Opis
Unikatowy identyfikator
Uri integer
Name
NameString string
Pełna nazwa lokalizacji
LocationFullFormattedName string
Nazwa sortowania lokalizacji
LocationSortName string

CmBob

Nazwa Ścieżka Typ Opis
Unikatowy identyfikator
Uri integer
Name
NameString string

CMLocationsResponse

Nazwa Ścieżka Typ Opis
Results
Results array of CMLocation

Results

UpdateErrorResults
UpdateErrorResults array of CMUpdateErrorResponse
Łączna liczba wyników
TotalResults integer
Liczba ciągów ex
CountStringEx string
Minimalna liczba
MinimumCount integer
Liczba
Count integer
Ma więcej elementów
HasMoreItems boolean
Tytuł wyszukiwania
SearchTitle string
Naciśnij pozycję Wyróżnij ciąg
HitHighlightString string
Szukaj
TrimType CMTrimType
Stan odpowiedzi
ResponseStatus CMResponseStatus

Stan odpowiedzi

CMBobResponse

Nazwa Ścieżka Typ Opis
Results
Results array of CMBob

Results

UpdateErrorResults
UpdateErrorResults array of CMUpdateErrorResponse
Łączna liczba wyników
TotalResults integer
Liczba ciągów ex
CountStringEx string
Minimalna liczba
MinimumCount integer
Liczba
Count integer
Ma więcej elementów
HasMoreItems boolean
Tytuł wyszukiwania
SearchTitle string
Naciśnij pozycję Wyróżnij ciąg
HitHighlightString string
Szukaj
TrimType CMTrimType
Stan odpowiedzi
ResponseStatus CMResponseStatus

Stan odpowiedzi

GetFileFromUrlResponse

Odpowiedź z wtyczki interfejsu API usługi CM "GetFileFromUrl".

Nazwa Ścieżka Typ Opis
Ścieżka pliku
Filepath string

Ścieżka pliku lokalnego do pliku pobranego z adresu URL.

Message
Message string

CMLocationAddressUri

Nazwa Ścieżka Typ Opis
Unikatowy identyfikator
Uri integer

binarny

Jest to podstawowy typ danych "binary".

obiekt

Jest to typ 'obiekt'.