Content Manager Power Connect
Content Manager je podnikový systém správy obsahu založený na zásadách správného řízení, který je navržený tak, aby pomohl vládním agenturám, regulovaným odvětvím a globálním organizacím spravovat svůj obchodní obsah od vytvoření až po odstranění. Připojte se ke Správci obsahu a proveďte akce, včetně vytváření nebo aktualizace záznamů nebo umístění, nahrávání nebo stahování elektronických souborů, vyhledávání a provádění dalších akcí. (1.0.4.757)
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Logic Apps | Standard | Všechny oblasti Logic Apps s výjimkou následujících: – Oblasti Azure Government – Oblasti Azure China - Ministerstvo obrany USA (DoD) |
| Power Apps | Premium | Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Power Automate | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Kontakt | |
|---|---|
| Název | Kapish Services Pty Ltd |
| URL | https://kapish.com.au/products/power_connect/ |
| sales@kapish.com.au |
| Metadata konektoru | |
|---|---|
| Vydavatel | Kapish Services Pty Ltd |
| Internetová stránka | https://kapish.com.au/products/power_connect/ |
| Zásady ochrany osobních údajů | https://kapish.com.au/products/privacy-policy/ |
| Kategorie | Data; Obsah a soubory |
Content Manager Power Connect by Kapish je konektor, který poskytuje funkce automatizace a integrace do Content Manageru, aby se zjednodušila schopnost vaší organizace splňovat požadavky na správu informací a zásady správného řízení.
Pre-requisites
- Externě přístupné rozhraní ServiceAPI správce obsahu
- Klíč předplatného, který poskytuje Kapish Services Pty Ltd
Podrobný seznam specifikací a požadavků nebo další informace o tom, jak může konektor pomoci vaší organizaci, obraťte se na kapish Services Pty Ltd.
Vytvoření připojení
Konektor podporuje následující typy ověřování:
| OAuth (důvěrný tok klienta) | Použití OAuth pro připojení ke Správci obsahu | Všechny oblasti | Nesdílitelné |
| Spravovaná systémem | Použití uživatelského jména a hesla pro připojení ke Správci obsahu | Všechny oblasti | Nesdílitelné |
| Výchozí [ZASTARALÉ] | Tato možnost je určená pouze pro starší připojení bez explicitního typu ověřování a poskytuje se pouze pro zpětnou kompatibilitu. | Všechny oblasti | Nesdílitelné |
OAuth (důvěrný tok klienta)
ID ověřování: OAuth
Použitelné: Všechny oblasti
Použití OAuth pro připojení ke Správci obsahu
Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.
| Název | Typ | Description | Povinné |
|---|---|---|---|
| Klíč předplatného KPC | securestring | Klíč rozhraní API pro přístup k Kapish Power Connect | Pravdivé |
| Adresa URL ROZHRANÍ API služby CM (např. https://myserver/CMServiceAPI/) | řetězec | Adresa URL, kde je možné dosáhnout rozhraní API služby CM | Pravdivé |
| Adresa URL autorizačního serveru (např. https://myserver/adfs/oauth2/token) | řetězec | Adresa URL pro získání přístupového tokenu | Pravdivé |
| ID klienta | řetězec | ID klienta pro ověřování | Pravdivé |
| Tajný klíč klienta | securestring | Tajný klíč klienta pro ověřování | Pravdivé |
Spravovaná systémem
ID ověřování: Základní
Použitelné: Všechny oblasti
Použití uživatelského jména a hesla pro připojení ke Správci obsahu
Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.
| Název | Typ | Description | Povinné |
|---|---|---|---|
| Klíč předplatného KPC | securestring | Klíč rozhraní API pro přístup k Kapish Power Connect | Pravdivé |
| Adresa URL ROZHRANÍ API služby CM (např. https://myserver/CMServiceAPI/) | řetězec | Adresa URL, kde je možné dosáhnout rozhraní API služby CM | Pravdivé |
| Uživatelské jméno | řetězec | Uživatelské jméno pro ověřování | Pravdivé |
| Heslo | securestring | Heslo pro ověřování | Pravdivé |
Výchozí [ZASTARALÉ]
Použitelné: Všechny oblasti
Tato možnost je určená pouze pro starší připojení bez explicitního typu ověřování a poskytuje se pouze pro zpětnou kompatibilitu.
Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.
| Název | Typ | Description | Povinné |
|---|---|---|---|
| Klíč předplatného KPC | securestring | Klíč rozhraní API pro přístup k Kapish Power Connect | Pravdivé |
| Adresa URL ROZHRANÍ API služby CM (např. https://myserver/CMServiceAPI/) | řetězec | Adresa URL, kde je možné dosáhnout rozhraní API služby CM | Pravdivé |
| Adresa URL autorizačního serveru (např. https://myserver/adfs/oauth2/token) | řetězec | Adresa URL pro získání přístupového tokenu | Pravdivé |
| ID klienta | řetězec | ID klienta pro ověřování | Pravdivé |
| Tajný klíč klienta | securestring | Tajný klíč klienta pro ověřování | Pravdivé |
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 100 | 60 sekund |
Akce
| Aktualizace záznamu (klasifikace) |
Aktualizace klasifikace záznamu |
| Aktualizace záznamu (nastavení neomezeného přístupu nebo na základě kontejneru) |
InheritAccessControl |
| Aktualizace záznamu (nastavení popisku uživatele) |
Umožňuje nastavení popisku uživatele u záznamu. |
| Aktualizace záznamu (přeplánování akcí) |
Přeplánuje všechny akce připojené k tomuto záznamu. |
| Aktualizace záznamu (přidání řízení přístupu) |
AddAccessControl |
| Aktualizace záznamu (rezervace) |
Nastavení stavu záznamu pro rezervaci |
| Aktualizace záznamu (vrácení rezervace zpět) |
Vrácení předchozí rezervace elektronického dokumentu pro tento záznam bez ohledu na všechny změny provedené od rezervace |
| Aktualizovat umístění (osoba) |
Aktualizace umístění osoby pomocí jedinečného identifikátoru |
| Aktualizovat záznam (další pole) |
Aktualizace dalších polí v záznamu |
| Aktualizovat záznam (Dispose) |
Dispose of a Record |
| Aktualizovat záznam (nahradit řízení přístupu) |
SetAccessControl |
| Aktualizovat záznam (nefinalizovat – nastavit jako koncept) |
Aktualizace dokončeného záznamu na koncept |
| Aktualizovat záznam (odebrat umístění z řízení přístupu) |
RemoveAccessControl |
| Aktualizovat záznam (odebrat všechny akce) |
Odebere všechny akce připojené k zadanému záznamu. |
| Aktualizovat záznam (připojit akci nebo proceduru) |
Připojení akce nebo procedury k záznamu |
| Aktualizovat záznam (připojit elektronický soubor) |
Připojení elektronického souboru k záznamu |
| Aktualizovat záznam (připojit kontakt) |
Připojení kontaktu k záznamu |
| Aktualizovat záznam (upřesnit) |
Aktualizace záznamu pomocí rozšířených vlastností |
| Aktualizovat záznam (vlastnosti) |
Aktualizace záznamu |
| Aktualizovat záznam (zavřít) |
Pomocí funkce CloseRecord zavřete kontejner – pokud chcete, aby datum uzavření bylo nyní prázdné. Protože uzavření záznamu může vyžadovat aktualizaci mnoha obsažených záznamů, tato funkce změny potvrdí automaticky. |
| Aktualizovat záznam (změna přiřazení akce) |
Znovu přiřazuje nominovanou akci k zadanému umístění. |
| Aktualizovat záznam (znovu otevřít) |
Pomocí funkce ReopenRecord znovu otevřete uzavřený kontejner. Protože opětovné otevření záznamu může vyžadovat aktualizaci mnoha obsažených záznamů, tato funkce změny potvrdí automaticky. |
| Aktualizovat záznam (úplné akce) |
Dokončení jedné nebo všech akcí s termínem splnění u konkrétního záznamu |
| Nahrání elektronického souboru |
Nahrání elektronického souboru, který může být později připojen k záznamu |
| Najít umístění |
Hledání umístění (načtení kolekce umístění pomocí vyhledávacího řetězce) |
| Najít umístění podle ID |
Načtení jednoho umístění podle jedinečného ID nebo názvu |
| Najít záznam podle ID |
Načtení jednoho záznamu podle jedinečného ID nebo názvu |
| Najít záznamy |
Hledání záznamů (načtení kolekce záznamů pomocí vyhledávacího řetězce) |
| Najít záznamy (upřesnit) |
Vyhledejte záznamy (načtěte kolekci záznamů pomocí vyhledávacího řetězce). Vrátí nezpracovanou odpověď ServiceAPI Správce obsahu. |
| Odstranit záznam |
Odstranění záznamu |
| Stáhnout elektronický soubor |
Stažení elektronického souboru záznamu |
| Umístění aktualizace (adresa) |
Vytvoření nebo aktualizace adresy umístění pomocí jedinečného ID adresy |
| Umístění aktualizace (další pole) |
Aktualizace dalších polí v umístění |
| Umístění aktualizace (jiné) |
Aktualizace umístění |
| Update Record (Attach Thesaurus Term) |
Připojení termínu tesaurus k záznamu |
| Update Record (Request Rendition) |
Umožňuje vytvořit žádost pro modul automatického vykreslování, aby se vytvořila verze záznamu. |
| Update Record (Set Assignee) |
Nastavte přiřazeného k určitému umístění zpět na domovskou stránku nebo se zaregistrujte jako Chybějící. |
| Update Record (Undispose) |
Vrátí stav záznamu (a veškerý jeho obsah), aby se již nezlikvidoval. |
| Vyhledání jedinečného ID adresy umístění |
Získání jedinečného ID podřízené adresy umístění |
| Vyhledání objektů CM |
Hledání objektů CM |
| Vytvoření záznamu (složka) |
Vytvoření záznamu |
| Vytvoření záznamu (upřesnit) |
Vytvoření záznamu s rozšířenými poli |
| Vytvořit umístění (jiné) |
Vytvoření umístění libovolného typu |
| Vytvořit umístění (osoba) |
Vytvoření umístění osoby |
| Vytvořit záznam (dokument) |
Vytvoření záznamu |
| Záznam aktualizace (Finale) |
Aktualizace konceptu záznamu |
| Získání souboru z adresy URL |
Stažení souboru z adresy URL do pracovní oblasti pomocí modulu plug-in rozhraní API služby CM GetFileFromUrl |
| Čtení dat událostí |
Transformace dat událostí Kapish Dispatch pro spotřebu toků |
Aktualizace záznamu (klasifikace)
Aktualizace klasifikace záznamu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
Classification
|
RecordClassification | True | string |
Zadejte jedinečný identifikátor klasifikace. |
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMRecordsResponse
Aktualizace záznamu (nastavení neomezeného přístupu nebo na základě kontejneru)
InheritAccessControl
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
Jedinečné ID
|
Uri | integer |
Jedinečný identifikátor umístění |
Návraty
- Body
- CMRecordsResponse
Aktualizace záznamu (nastavení popisku uživatele)
Umožňuje nastavení popisku uživatele u záznamu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Záznam
|
Uri | True | integer |
Jedinečné ID záznamu pro připojení popisku uživatele k |
|
Popisek uživatele
|
UserLabel | True | string |
Jedinečné ID nebo jméno popisku uživatele, které se má použít |
|
Oblíbený typ
|
FavouriteType | string | ||
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMRecordsResponse
Aktualizace záznamu (přeplánování akcí)
Přeplánuje všechny akce připojené k tomuto záznamu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
Od základního data
|
FromBaseDate | date | ||
|
Použití skutečných dob trvání
|
UseActualDurations | boolean | ||
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMRecordsResponse
Aktualizace záznamu (přidání řízení přístupu)
AddAccessControl
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
Jedinečné ID
|
Uri | integer |
Jedinečný identifikátor umístění |
Návraty
- Body
- CMRecordsResponse
Aktualizace záznamu (rezervace)
Nastavení stavu záznamu pro rezervaci
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
Comments
|
Comments | string | ||
|
Uložit cestu rezervace jako
|
SaveCheckoutPathAs | string | ||
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMRecordsResponse
Aktualizace záznamu (vrácení rezervace zpět)
Vrácení předchozí rezervace elektronického dokumentu pro tento záznam bez ohledu na všechny změny provedené od rezervace
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
Comments
|
Comments | string | ||
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMRecordsResponse
Aktualizovat umístění (osoba)
Aktualizace umístění osoby pomocí jedinečného identifikátoru
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | integer | ||
|
Řetězec dotazu
|
q | string |
Sem zadejte dotaz, který použije aktualizaci na sadu umístění, a ne jenom na jeden (jak je určeno jedinečným ID). |
|
|
Title
|
LocationHonorific | string | ||
|
Příjmení
|
LocationSurname | string | ||
|
Křestní jméno
|
LocationGivenNames | string | ||
|
Interní
|
LocationIsWithin | boolean | ||
|
Název pracovní pozice
|
LocationJobDescription | string | ||
|
Datum narození
|
LocationDateOfBirth | string | ||
|
Oslovení
|
LocationSalutation | string | ||
|
Jedinečný název
|
LocationNickName | string | ||
|
Číslo ID
|
LocationIdNumber | string | ||
|
Telefon do zaměstnání
|
LocationPhoneNumber | string | ||
|
Mobilní telefon
|
LocationMobileNumber | string | ||
|
Fax
|
LocationFaxNumber | string | ||
|
Telefon domů
|
LocationAfterHoursPhoneNumber | string | ||
|
Stejné jako adresa
|
LocationUseAddressOf | integer |
Jedinečné ID umístění |
|
|
Nastavit jako výchozí
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
Související jedinečné ID
|
AddRelationshipRelatedLocation | integer | ||
|
Typ
|
AddRelationshipRelationshipType | string | ||
|
E-mailová adresa
|
LocationEmailAddress | string | ||
|
Pohlaví
|
LocationGenderValue | string | ||
|
Přijetí přihlášení
|
LocationCanLogin | boolean | ||
|
Přihlášení k síti
|
LocationLogsInAs | string | ||
|
Další přihlášení k síti
|
LocationAdditionalLogin | string | ||
|
Platnost přihlášení vyprší dne
|
LocationLoginExpires | string | ||
|
Profil uživatele
|
LocationUseProfileOf | integer |
Jedinečné ID umístění |
|
|
Typ uživatele
|
LocationUserType | string | ||
|
Řetězec zabezpečení
|
LocationSecurityString | string | ||
|
Od
|
SetActiveDateRangeValidFromDate | string |
dd/mm/yyyyy |
|
|
To
|
SetActiveDateRangeValidToDate | string |
dd/mm/yyyyy |
|
|
Poznámky
|
LocationNotes | string | ||
|
Typ aktualizace poznámek
|
NotesUpdateType | string | ||
|
Související jedinečné ID
|
RemoveRelationshipRelatedLocation | integer |
Návraty
- Body
- CMLocationsResponse
Aktualizovat záznam (další pole)
Aktualizace dalších polí v záznamu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | integer | ||
|
Název
|
SearchClause | string | ||
|
Hodnota
|
Value | string | ||
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMRecordsResponse
Aktualizovat záznam (Dispose)
Dispose of a Record
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
Chcete pokračovat v chybě?
|
ContinueOnError | boolean | ||
|
Způsob likvidace
|
MethodOfDisposal | string | ||
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMRecordsResponse
Aktualizovat záznam (nahradit řízení přístupu)
SetAccessControl
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
Jedinečné ID
|
Uri | integer |
Jedinečný identifikátor umístění |
Návraty
- Body
- CMRecordsResponse
Aktualizovat záznam (nefinalizovat – nastavit jako koncept)
Aktualizace dokončeného záznamu na koncept
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer |
Návraty
- Body
- CMRecordsResponse
Aktualizovat záznam (odebrat umístění z řízení přístupu)
RemoveAccessControl
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
FunctionEnum
|
FunctionEnum | string | ||
|
Jedinečné ID
|
Uri | integer |
Jedinečný identifikátor umístění |
Návraty
- Body
- CMRecordsResponse
Aktualizovat záznam (odebrat všechny akce)
Odebere všechny akce připojené k zadanému záznamu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMRecordsResponse
Aktualizovat záznam (připojit akci nebo proceduru)
Připojení akce nebo procedury k záznamu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
Akce pro připojení
|
ActionToAttach | True | integer | |
|
Jedinečné ID přiřazené uživatele
|
NewAssignee | integer | ||
|
Možnost přiřazování
|
AssigneeOption | string | ||
|
Datum zahájení plánu
|
ScheduleStartDate | date | ||
|
Existující akce
|
RecordAction | integer | ||
|
Vložit pozici
|
InsertPos | string | ||
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMRecordsResponse
Aktualizovat záznam (připojit elektronický soubor)
Připojení elektronického souboru k záznamu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
File
|
File | True | file |
Obsah souboru/text elektronického dokumentu, který se má připojit |
|
Jedinečný identifikátor
|
Uri | True | string |
Jedinečné ID záznamu |
Návraty
- Body
- CMRecordsResponse
Aktualizovat záznam (připojit kontakt)
Připojení kontaktu k záznamu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
Typ kontaktu
|
ContactType | True | string | |
|
Umístění kontaktu
|
ContactLocation | True | string |
Jedinečné ID nebo e-mailová adresa místa |
|
Nastavit jako primární kontakt?
|
IsPrimary | True | boolean | |
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMRecordsResponse
Aktualizovat záznam (upřesnit)
Aktualizace záznamu pomocí rozšířených vlastností
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
Typ záznamu
|
RecordRecordType | string | ||
|
Classification
|
RecordClassification | string |
Zadejte jedinečný identifikátor klasifikace. |
|
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
|
|
Author
|
RecordAuthor | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Číslo přistoupení
|
RecordAccessionNumber | string | ||
|
Adresát
|
RecordAddressee | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Alternativní kontejner
|
RecordAlternativeContainer | string | ||
|
Pověřený
|
RecordAssignee | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Úroveň spolehlivosti automatické klasifikace
|
RecordAutoClassificationConfidenceLevel | string | ||
|
Automatické vykreslení do PDF při uložení
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Obejití řízení přístupu typu záznamu
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Nepoužívat možnost Uložit?
|
ByPassSave | boolean |
True, pokud objekt neuložíte. Jedním z těchto možností je nastavení jedné nebo více vlastností v příspěvku záznamu a vrácení formuláře pro zadávání dat. Formulář pro zadávání dat pak bude odrážet různé vlastnosti nastavené na původním záznamu. |
|
|
Změnit pozici v oblíbených položkách
|
ChangePositionWithinFavorites | string |
Pokud se nepoužije jiné řazení, vrátí se při hledání oblíbených položek v tomto pořadí. |
|
|
Změnit pozici v popisku uživatele
|
ChangePositionWithinUserLabel | string |
Při vyhledávání podle UserLabel budou vráceny v tomto pořadí, pokud není použito jiné řazení., |
|
|
Vrátit se změnami jako
|
CheckinAs | string |
Nastavte vlastnost Zdroj elektronického dokumentu. |
|
|
Třída záznamu
|
RecordClassOfRecord | string | ||
|
Klient
|
RecordClient | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Záznam klienta
|
RecordClientRecord | string | ||
|
Comments
|
comments | string |
Komentáře pro přechod do poznámek k záznamu při nahrání dokumentu |
|
|
Zásilka
|
RecordConsignment | string | ||
|
Objekt zásilky
|
RecordConsignmentObject | string | ||
|
Container
|
RecordContainer | string | ||
|
Kopírování dokumentu ze záznamu
|
CopyDocumentFromRecord | string |
Zadejte jedinečné ID záznamu, ze kterého chcete zkopírovat elektronický dokument pro tento záznam. |
|
|
Tvůrce
|
RecordCreator | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Datum vytvoření
|
RecordDateCreated | string | ||
|
Termín splnění
|
RecordDateDue | string | ||
|
Datum publikování
|
RecordDatePublished | string | ||
|
Datum přijetí
|
RecordDateReceived | string | ||
|
Editor
|
RecordEditor | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Elektronické úložiště dokumentů
|
RecordEStore | string | ||
|
Externí odkaz
|
RecordExternalReference | string | ||
|
Upozornění selžou?
|
FailOnWarnings | boolean |
Ano, pokud objekt nevytvoříte nebo neuložíte, pokud se zobrazí upozornění. |
|
|
Název souboru ve složce Uploads
|
RecordFilePath | string |
Název souboru, který se zobrazí ve složce Uploads. |
|
|
Dokončení při uložení
|
RecordFinalizeOnSave | boolean | ||
|
Cizí čárový kód
|
RecordForeignBarcode | string | ||
|
Poloha GPS
|
RecordGpsLocation | string | ||
|
Umístění domovské stránky
|
RecordHomeLocation | string |
Jedinečné ID umístění |
|
|
Domovský prostor
|
RecordHomeSpace | string | ||
|
Je uzavřeno.
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Zachovat rezervovaný
|
keepBookedOut | boolean |
Ano, pokud chcete záznam nechat rezervovaný po nahrání elektronického dokumentu. |
|
|
Datum poslední akce
|
RecordLastActionDate | string | ||
|
Dlouhé číslo
|
RecordLongNumber | string | ||
|
Nastavit jako aktivní
|
MakeActive | string |
Vrátí stav záznamu (a jeho obsah), aby už nebyl neaktivní. Při zpracování obsahu můžete určit, jestli se má úloha zastavit, pokud dojde k nějakým selháním. |
|
|
Neaktivní
|
MakeInactive | string |
Nastaví dateInactive pro tento záznam a veškerý jeho obsah. Při zpracování obsahu můžete určit, jestli se má úloha zastavit, pokud dojde k nějakým selháním. |
|
|
Vytvořit novou revizi
|
makeNewRevision | boolean |
True pro vytvoření nové revize s tímto elektronickým dokumentem false nahradit aktuální revize. |
|
|
Datum ručního zničení
|
RecordManualDestructionDate | string | ||
|
Záznam hmoty
|
RecordMatterRecord | string | ||
|
Typ média
|
RecordMediaType | string | ||
|
Moje autorizační komentáře
|
RecordMyAuthorizationComments | string | ||
|
Moje autorizace byla dokončena.
|
RecordMyAuthorizationComplete | boolean | ||
|
Moje revize komentářů
|
RecordMyReviewComments | string | ||
|
Moje kontrola je dokončená
|
RecordMyReviewComplete | boolean | ||
|
Potřebujete autorizaci?
|
RecordNeedsAuthorization | boolean | ||
|
Potřebujete zkontrolovat?
|
RecordNeedsReview | boolean | ||
|
Nové pravidlo vytváření částí
|
RecordNewPartCreationRule | string |
Jedinečné ID pravidla automatického vytváření částí |
|
|
Poznámky
|
RecordNotes | string | ||
|
Typ aktualizace poznámek
|
NotesUpdateType | string | ||
|
Jiný kontakt
|
RecordOtherContact | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Umístění vlastníka
|
RecordOwnerLocation | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Preserver Hierarchy On Data Entry?
|
RecordPreserveHierarchyOnDataEntry | boolean | ||
|
Záznam předchozí části
|
RecordPrevPartRecord | string | ||
|
Priority
|
RecordPriority | string | ||
|
Záznam nového typu
|
RecordNewType | string |
Ponechte výchozí nastavení, pokud se nevytvoí nová verze nebo kopie. |
|
|
Související záznam
|
RecordRelatedRecord | string | ||
|
Zástupce
|
RecordRepresentative | string | ||
|
Plán uchovávání informací
|
RecordRetentionSchedule | string | ||
|
Datum revize
|
RecordReviewDate | string | ||
|
Zkontrolovat termín splnění
|
RecordReviewDueDate | string | ||
|
Zkontrolovat stav
|
RecordReviewState | string | ||
|
Zabezpečení
|
RecordSecurity | string | ||
|
Záznam řady
|
RecordSeriesRecord | string | ||
|
Název (část Volný text)
|
RecordTypedTitle | string | ||
|
Řetězec dotazu
|
q | string |
Sem zadejte dotaz, který použije aktualizaci na sadu záznamů, a ne jenom na jeden (jak je určeno jedinečným ID). |
Návraty
- Body
- CMRecordsResponse
Aktualizovat záznam (vlastnosti)
Aktualizace záznamu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | integer | ||
|
Query
|
q | string |
Sem zadejte dotaz, který použije aktualizaci na sadu záznamů, a ne pouze jeden (jak je určeno jedinečným ID). |
|
|
Název (část Volný text)
|
RecordTypedTitle | string | ||
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
|
|
Author
|
RecordAuthor | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Container
|
RecordContainer | string | ||
|
Classification
|
RecordClassification | string |
Zadejte jedinečný identifikátor klasifikace. |
|
|
Adresát
|
RecordAddressee | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Alternativní kontejner
|
RecordAlternativeContainer | string | ||
|
Pověřený
|
RecordAssignee | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Automatické vykreslení do PDF při uložení
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Obejití řízení přístupu typu záznamu
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Vrátit se změnami jako
|
CheckinAs | string |
Nastavte vlastnost Zdroj elektronického dokumentu. |
|
|
Klient
|
RecordClient | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Záznam klienta
|
RecordClientRecord | string | ||
|
Kopírování dokumentu ze záznamu
|
CopyDocumentFromRecord | string |
Zadejte jedinečné ID záznamu, ze kterého chcete zkopírovat elektronický dokument pro tento záznam. |
|
|
Tvůrce
|
RecordCreator | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Datum vytvoření
|
RecordDateCreated | string | ||
|
Termín splnění
|
RecordDateDue | string | ||
|
Datum publikování
|
RecordDatePublished | string | ||
|
Datum přijetí
|
RecordDateReceived | string | ||
|
Externí odkaz
|
RecordExternalReference | string | ||
|
Upozornění selžou?
|
FailOnWarnings | boolean |
Ano, pokud objekt nevytvoříte nebo neuložíte, pokud se zobrazí upozornění. |
|
|
Název souboru ve složce Uploads
|
RecordFilePath | string |
Název souboru, který se zobrazí ve složce Uploads. |
|
|
Dokončení při uložení
|
RecordFinalizeOnSave | boolean | ||
|
Cizí čárový kód
|
RecordForeignBarcode | string | ||
|
Poloha GPS
|
RecordGpsLocation | string | ||
|
Umístění domovské stránky
|
RecordHomeLocation | string |
Jedinečné ID umístění |
|
|
Domovský prostor
|
RecordHomeSpace | string | ||
|
Je uzavřeno.
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Zachovat rezervovaný
|
keepBookedOut | boolean |
Ano, pokud chcete záznam nechat rezervovaný po nahrání elektronického dokumentu. |
|
|
Dlouhé číslo
|
RecordLongNumber | string | ||
|
Typ média
|
RecordMediaType | string | ||
|
Poznámky
|
RecordNotes | string | ||
|
Typ aktualizace poznámek
|
NotesUpdateType | string | ||
|
Jiný kontakt
|
RecordOtherContact | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Umístění vlastníka
|
RecordOwnerLocation | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Související záznam
|
RecordRelatedRecord | string | ||
|
Zástupce
|
RecordRepresentative | string | ||
|
Datum revize
|
RecordReviewDate | string | ||
|
Zkontrolovat termín splnění
|
RecordReviewDueDate | string | ||
|
Zkontrolovat stav
|
RecordReviewState | string | ||
|
Zabezpečení
|
RecordSecurity | string |
Návraty
- Body
- CMRecordsResponse
Aktualizovat záznam (zavřít)
Pomocí funkce CloseRecord zavřete kontejner – pokud chcete, aby datum uzavření bylo nyní prázdné. Protože uzavření záznamu může vyžadovat aktualizaci mnoha obsažených záznamů, tato funkce změny potvrdí automaticky.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
Chcete pokračovat při chybě?
|
ContinueOnError | boolean | ||
|
Uzavřít obsah?
|
EncloseContents | boolean | ||
|
Finalizovat obsah?
|
FinalizeContents | boolean | ||
|
Protokolovat pouze chyby?
|
LogErrorsOnly | boolean | ||
|
Výsledky protokolu?
|
LogResults | boolean |
Vrátí textový protokol záznamů uzavřených ve vlastnosti Zpráva protokolu? |
|
|
Vyprázdnit revize obsahu?
|
PurgeContentRevisions | boolean | ||
|
Konkrétní datum uzavření?
|
SpecificCloseDate | date | ||
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMLogResponse
Aktualizovat záznam (změna přiřazení akce)
Znovu přiřazuje nominovanou akci k zadanému umístění.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
Nový přiřazený
|
NewAssignee | True | string |
Jedinečné ID nebo e-mailová adresa nového přiřazeného uživatele |
|
Akce k opětovnému přiřazení
|
RecordActionUri | True | integer | |
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMRecordsResponse
Aktualizovat záznam (znovu otevřít)
Pomocí funkce ReopenRecord znovu otevřete uzavřený kontejner. Protože opětovné otevření záznamu může vyžadovat aktualizaci mnoha obsažených záznamů, tato funkce změny potvrdí automaticky.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
Chcete pokračovat při chybě?
|
ContinueOnError | boolean | ||
|
Výsledky protokolu?
|
LogResults | boolean |
Vrátí textový protokol záznamů znovu otevřených ve vlastnosti Zpráva protokolu? |
|
|
Zrušit finalizaci obsahu?
|
UnfinalizeContents | boolean | ||
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMLogResponse
Aktualizovat záznam (úplné akce)
Dokončení jedné nebo všech akcí s termínem splnění u konkrétního záznamu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
Complete
|
Complete | True | string |
Zadejte, které akce záznamu se mají dokončit. |
|
Dokončení předchozích akcí
|
CompletePrevious | boolean |
Dokončení všech akcí záznamu před zadaným záznamem |
|
|
Datum dokončení
|
CompletionDate | date |
Datum, které se nastaví jako datum dokončení |
|
|
Jedinečné ID akce záznamu
|
RecordActionUri | integer |
Jedinečné ID akce záznamu, které se má dokončit, pokud je vybrána možnost Jedinečný identifikátor |
|
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMRecordsResponse
Nahrání elektronického souboru
Nahrání elektronického souboru, který může být později připojen k záznamu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Název souboru
|
RecordFilePath | True | string | |
|
Jedinečný identifikátor
|
Uri | True | string |
Najít umístění
Hledání umístění (načtení kolekce umístění pomocí vyhledávacího řetězce)
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Query
|
q | True | string |
Zadejte vyhledávací dotaz, například "all", abyste získali všechny objekty. |
|
Použít výchozí hodnoty
|
ApplyDefaults | boolean |
True pro použití výchozího filtru a řazení uživatele na toto hledání |
|
|
Počet výsledků
|
CountResults | boolean |
Hodnota True pro zahrnutí počtu výsledků |
|
|
Vyloučit počet
|
ExcludeCount | boolean |
Hodnota True pro vyloučení počtu výsledků |
|
|
Filter
|
filter | string |
Seznam vyhledávacích klauzulí oddělených mezerami, které se mají použít jako filtr. |
|
|
Z hledání
|
fromSearch | string |
Jedinečné ID uloženého hledání, ze kterého se má toto hledání vytvořit |
|
|
Vlastnosti potomků
|
descendantProperties | string |
Čárkami oddělený seznam vlastností objektu se vztahuje pouze na vlastnosti objektu této a nižší úrovně, například RecordNumber,RecordTitle. |
|
|
Zahrnout definice vlastností
|
IncludePropertyDefs | boolean |
True pro vrácení pole definic vlastností používaných vlastnostmi v této odpovědi |
|
|
Možnosti
|
Options | string |
Pro toto vyhledávání nastavte jednu nebo více možností, které jsou obvykle nastavené v možnostech uživatelů. Používáte ID z objektu /PropertyDef? Get=SearchOptions service, připojte znaménko minus, které se nastaví na false, jinak se předpokládá hodnota true. |
|
|
Vlastnosti
|
properties | string |
Čárkami oddělený seznam vlastností objektu, například RecordNumber,RecordTitle |
|
|
Sady vlastností
|
propertySets | string |
Jednu nebo více předdefinovaných sad vlastností, vyberte z DataGridVisible, Detailed, FromSearch, All nebo vlastní sady vlastností definované v konfiguraci služby. |
|
|
Hodnota vlastnosti
|
PropertyValue | string |
Do výsledků zahrňte nezpracovanou hodnotu, řetězcovou hodnotu nebo obojí. |
|
|
Velikost stránky
|
pageSize | string |
Počet položek, které se mají vrátit na každé stránce výsledků |
|
|
Účel
|
purpose | string |
Speciální vlastnost pro filtrování výsledků hledání na základě hodnot výčtu účelu objektu |
|
|
Účel navíc
|
purposeExtra | string |
Nezbytné jako doplněk k některým účelům. Služba ObjectDef poskytuje informace o výčtu nebo TrimMainObject typ určit, zejména ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes a HaveExtraPurposeParameter. |
|
|
Řadit podle
|
sortBy | string |
Čárkami oddělený seznam ID vyhledávací klauzule |
|
|
Začátek
|
start | string |
Pozice v sadě výsledků, která má začínat, vyprázdnit (nebo 1), která má začínat na začátku, 2 začít u druhého objektu, 3 na třetí atd. |
|
|
Typ zobrazení řetězce
|
stringDisplayType | string |
Pokud se vrátí řetězcová hodnota, která má být použitá. |
Návraty
- Body
- CMLocationsResponse
Najít umístění podle ID
Načtení jednoho umístění podle jedinečného ID nebo názvu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Id | True | string |
Jedinečné ID objektu nebo název |
|
Vlastnosti potomků
|
descendantProperties | string |
Čárkami oddělený seznam vlastností objektu se vztahuje pouze na vlastnosti objektu této a nižší úrovně, například Příjmení,GivenNames. |
|
|
Zahrnout definice vlastností
|
IncludePropertyDefs | boolean |
True pro vrácení pole definic vlastností používaných vlastnostmi v této odpovědi |
|
|
Vlastnosti
|
properties | string |
Čárkami oddělený seznam vlastností objektu, například Příjmení, GivenNames |
|
|
Sady vlastností
|
propertySets | string |
Jednu nebo více předdefinovaných sad vlastností, vyberte z DataGridVisible, Detailed, FromSearch, All nebo vlastní sady vlastností definované v konfiguraci služby. |
|
|
Hodnota vlastnosti
|
PropertyValue | string |
Do výsledků zahrňte nezpracovanou hodnotu, řetězcovou hodnotu nebo obojí. |
|
|
Typ zobrazení řetězce
|
stringDisplayType | string |
Vrátí řetězcovou hodnotu, která se má použít. |
Návraty
- Body
- CMLocationsResponse
Najít záznam podle ID
Načtení jednoho záznamu podle jedinečného ID nebo názvu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
ID
|
Id | True | string |
Jedinečné ID objektu nebo název |
|
Zahrnout definice vlastností
|
IncludePropertyDefs | boolean |
True pro vrácení pole definic vlastností používaných vlastnostmi v této odpovědi |
|
|
Vlastnosti potomků
|
descendantProperties | string |
Čárkami oddělený seznam vlastností objektu se vztahuje pouze na vlastnosti objektu této a nižší úrovně, například RecordNumber,RecordTitle. |
|
|
Vlastnosti
|
properties | string |
Čárkami oddělený seznam vlastností objektu, například RecordNumber,RecordTitle. |
|
|
Sady vlastností
|
propertySets | string |
Jednu nebo více předdefinovaných sad vlastností, vyberte z DataGridVisible, Detailed, FromSearch, All nebo vlastní sady vlastností definované v konfiguraci služby. |
|
|
Hodnota vlastnosti
|
PropertyValue | string |
Do výsledků zahrňte nezpracovanou hodnotu, řetězcovou hodnotu nebo obojí. |
|
|
Typ zobrazení řetězce
|
stringDisplayType | string |
Pokud se vrátí řetězcová hodnota, která má být použitá. |
Návraty
- Body
- CMRecordsResponse
Najít záznamy
Hledání záznamů (načtení kolekce záznamů pomocí vyhledávacího řetězce)
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Query
|
q | True | string |
Vyhledávací dotaz |
|
Vlastnosti
|
properties | True | string |
Čárkami oddělený seznam vlastností, které se mají vrátit |
Návraty
- Body
- CMRecordsResponse
Najít záznamy (upřesnit)
Vyhledejte záznamy (načtěte kolekci záznamů pomocí vyhledávacího řetězce). Vrátí nezpracovanou odpověď ServiceAPI Správce obsahu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Query
|
q | True | string |
Vyhledávací dotaz |
|
Vlastnosti
|
properties | True | string |
Čárkami oddělený seznam vlastností, které se mají vrátit |
Návraty
- response
- object
Odstranit záznam
Odstranění záznamu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer |
Jedinečné ID záznamu, který se má odstranit |
|
Chcete odstranit obsah?
|
DeleteContents | True | boolean | |
|
Nová domovská stránka pro obsah
|
NewHomeForContents | string |
Jedinečné ID nebo e-mailová adresa nového umístění domovské stránky pro obsah |
Návraty
- Body
- CMRecordsResponse
Stáhnout elektronický soubor
Stažení elektronického souboru záznamu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Jedinečný identifikátor
|
uri | True | string |
Jedinečné ID nebo číslo záznamu |
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
Návraty
- response
- binary
Umístění aktualizace (adresa)
Vytvoření nebo aktualizace adresy umístění pomocí jedinečného ID adresy
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer |
Identifikátor URI existujícího umístění, které se má aktualizovat |
|
Jedinečné ID
|
Uri | integer |
Identifikátor URI stávající ulice nebo poštovní adresy, které se mají aktualizovat |
|
|
Typ
|
LocationAddressAddressType | string |
Vyberte typ adresy. Limit jednoho typu. |
|
|
Ulice
|
LocationAddressAddressLines | string | ||
|
Předměstí / Město
|
LocationAddressCity | string | ||
|
Stát
|
LocationAddressState | string | ||
|
PSČ
|
LocationAddressPostcode | string | ||
|
Country
|
LocationAddressCountry | string |
Návraty
- Body
- CMLocationsResponse
Umístění aktualizace (další pole)
Aktualizace dalších polí v umístění
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | integer | ||
|
Název
|
SearchClause | string | ||
|
Hodnota
|
Value | string |
Návraty
- Body
- CMLocationsResponse
Umístění aktualizace (jiné)
Aktualizace umístění
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | integer | ||
|
Řetězec dotazu
|
q | string |
Sem zadejte dotaz, který použije aktualizaci na sadu umístění, a ne jenom na jeden (jak je určeno jedinečným ID). |
|
|
Název
|
LocationSortName | string | ||
|
Jedinečný název
|
LocationNickName | string | ||
|
Číslo ID
|
LocationIdNumber | string | ||
|
Telefon do zaměstnání
|
LocationPhoneNumber | string | ||
|
Mobilní telefon
|
LocationMobileNumber | string | ||
|
Fax
|
LocationFaxNumber | string | ||
|
Telefon domů
|
LocationAfterHoursPhoneNumber | string | ||
|
Stejné jako adresa
|
LocationUseAddressOf | integer |
Jedinečné ID umístění |
|
|
Nastavit jako výchozí
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
Související jedinečné ID
|
AddRelationshipRelatedLocation | integer | ||
|
Typ
|
AddRelationshipRelationshipType | string | ||
|
E-mailová adresa
|
LocationEmailAddress | string | ||
|
Od
|
SetActiveDateRangeValidFromDate | string |
dd/mm/yyyyy |
|
|
To
|
SetActiveDateRangeValidToDate | string |
dd/mm/yyyyy |
|
|
Poznámky
|
LocationNotes | string | ||
|
Typ aktualizace poznámek
|
NotesUpdateType | string | ||
|
Související jedinečné ID
|
RemoveRelationshipRelatedLocation | integer |
Návraty
- Body
- CMLocationsResponse
Update Record (Attach Thesaurus Term)
Připojení termínu tesaurus k záznamu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Záznam
|
Uri | True | integer |
Jedinečné ID záznamu pro připojení termínu Tesaurus k |
|
Tesaurus – termín
|
Keyword | True | string |
Jedinečné ID nebo název termínu Tesaurus, které se mají připojit |
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMRecordsResponse
Update Record (Request Rendition)
Umožňuje vytvořit žádost pro modul automatického vykreslování, aby se vytvořila verze záznamu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
Typ verze
|
RenditionType | True | string | |
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMRecordsResponse
Update Record (Set Assignee)
Nastavte přiřazeného k určitému umístění zpět na domovskou stránku nebo se zaregistrujte jako Chybějící.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
Nový přiřazený
|
NewAssignee | string |
Jedinečné ID nebo e-mailová adresa nového přiřazeného uživatele |
|
|
Typ přiřazené uživatele
|
AssigneeType | string | ||
|
Termín vrácení podle data
|
DueForReturnByDate | date | ||
|
Došlo ke skutečné změně času
|
ActualTimeChangeOccurred | date-time | ||
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMRecordsResponse
Update Record (Undispose)
Vrátí stav záznamu (a veškerý jeho obsah), aby se již nezlikvidoval.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
Chcete pokračovat v chybě?
|
ContinueOnError | boolean | ||
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMRecordsResponse
Vyhledání jedinečného ID adresy umístění
Získání jedinečného ID podřízené adresy umístění
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Typ
|
type | string |
Vybrat typ adresy |
|
|
Jedinečný identifikátor
|
LocationUri | True | string |
Jedinečné ID umístění |
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
Návraty
- Podřízená adresa
- CMLocationAddressUri
Vyhledání objektů CM
Hledání objektů CM
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Vyhledat
|
TrimType | True | string | |
|
Řetězec dotazu
|
q | True | string |
Zadejte vyhledávací dotaz, například "all", abyste získali všechny objekty. |
|
Použít výchozí hodnoty
|
ApplyDefaults | boolean |
Ano, pokud chcete použít výchozí filtr a řazení uživatele na toto hledání. |
|
|
Počet výsledků
|
CountResults | boolean |
Funkce CountResults vrátí nejspolehlivější a nejpomalejší počet celkových výsledků hledání. Výsledný počet je ve vlastnosti Počet odpovědí. |
|
|
Vlastnosti potomků
|
DescendantProperties | string |
Čárkami oddělený seznam vlastností objektu se vztahuje pouze na vlastnosti objektu této a nižší úrovně, například RecordNumber,RecordTitle. |
|
|
Vyloučit počet
|
ExcludeCount | boolean |
Vrácení hodnoty TotalResults a SearchTitle může snížit výkon. Pokud nejsou požadovány hodnoty TotalResults a SearchTitle, nastavte na hodnotu true. |
|
|
Filter
|
Filter | string |
Seznam vyhledávacích klauzulí oddělených mezerami, které se mají použít jako filtr. |
|
|
Z hledání
|
FromSearch | integer |
Jedinečné ID uloženého hledání, ze kterého se má toto hledání vytvořit. |
|
|
Zahrnout defs vlastnost
|
IncludePropertyDefs | boolean |
Hodnota True vrátí pole definic vlastností používaných vlastnostmi v této odpovědi. |
|
|
Možnosti
|
Options | string |
Pro toto vyhledávání nastavte jednu nebo více možností, které jsou obvykle nastavené v možnostech uživatelů. Používáte ID z objektu /PropertyDef? Get=SearchOptions service, připojte znaménko minus, které se nastaví na false, jinak se předpokládá hodnota true. |
|
|
Velikost stránky
|
pageSize | integer |
Početpoložekch Pokud je hodnota prázdná, nastaví se výchozí hodnota nastavená v konfiguraci. |
|
|
Hodnota vlastnosti
|
PropertyValue | string |
Do výsledků zahrňte nezpracovanou hodnotu, řetězcovou hodnotu nebo obojí. |
|
|
Sady vlastností
|
PropertySets | string |
Jednu nebo více předdefinovaných sad vlastností, vyberte z DataGridVisible, Detailed, FromSearch, All nebo vlastní sady vlastností definované v konfiguraci služby. |
|
|
Účel
|
purpose | integer |
Speciální vlastnost pro filtrování výsledků hledání na základě hodnot výčtu účelu objektu. |
|
|
Účel navíc
|
purposeExtra | integer |
Nezbytné jako doplněk k některým účelům. Služba ObjectDef poskytuje informace o výčtu nebo TrimMainObject typ určit, zejména ObjectDef.ExtraPurposeEnums, ObjectDef.ExtraPurposeObjectTypes a HaveExtraPurposeParameter. |
|
|
Řadit podle
|
sortBy | string |
Čárkami oddělený seznam ID vyhledávací klauzule. Slouží k určení sestupně.
|
|
|
Začátek
|
start | integer |
Pozice v sadě výsledků, která má začínat, vyprázdnit (nebo 1), která má začínat na začátku, 2 začít u druhého objektu, 3 na třetí atd. |
|
|
StringDisplayType
|
StringDisplayType | string |
Pokud se vrátí řetězcová hodnota, která se má použít. |
|
|
Vlastnosti
|
properties | string |
Čárkami oddělený seznam vlastností objektu, např. Uri, NameString |
Návraty
- Body
- CMBobResponse
Vytvoření záznamu (složka)
Vytvoření záznamu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Typ záznamu
|
RecordRecordType | True | string | |
|
Název (část Volný text)
|
RecordTypedTitle | True | string | |
|
Classification
|
RecordClassification | string |
Zadejte jedinečný identifikátor klasifikace. |
|
|
Container
|
RecordContainer | string | ||
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
|
|
Author
|
RecordAuthor | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Adresát
|
RecordAddressee | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Alternativní kontejner
|
RecordAlternativeContainer | string | ||
|
Pověřený
|
RecordAssignee | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Obejití řízení přístupu typu záznamu
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Klient
|
RecordClient | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Tvůrce
|
RecordCreator | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Datum vytvoření
|
RecordDateCreated | string | ||
|
Termín splnění
|
RecordDateDue | string | ||
|
Datum publikování
|
RecordDatePublished | string | ||
|
Externí odkaz
|
RecordExternalReference | string | ||
|
Upozornění selžou?
|
FailOnWarnings | boolean |
Ano, pokud objekt nevytvoříte nebo neuložíte, pokud se zobrazí upozornění. |
|
|
Název souboru ve složce Uploads
|
RecordFilePath | string |
Název souboru, který se zobrazí ve složce Uploads. |
|
|
Cizí čárový kód
|
RecordForeignBarcode | string | ||
|
Poloha GPS
|
RecordGpsLocation | string | ||
|
Umístění domovské stránky
|
RecordHomeLocation | string |
Jedinečné ID umístění |
|
|
Domovský prostor
|
RecordHomeSpace | string | ||
|
Je uzavřeno.
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Datum poslední akce
|
RecordLastActionDate | string | ||
|
Dlouhé číslo
|
RecordLongNumber | string | ||
|
Poznámky
|
RecordNotes | string | ||
|
Typ aktualizace poznámek
|
NotesUpdateType | string | ||
|
Jiný kontakt
|
RecordOtherContact | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Umístění vlastníka
|
RecordOwnerLocation | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Související záznam
|
RecordRelatedRecord | string | ||
|
Zástupce
|
RecordRepresentative | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Datum revize
|
RecordReviewDate | string | ||
|
Zkontrolovat termín splnění
|
RecordReviewDueDate | string | ||
|
Zkontrolovat stav
|
RecordReviewState | string | ||
|
Zabezpečení
|
RecordSecurity | string |
Návraty
- Body
- CMRecordsResponse
Vytvoření záznamu (upřesnit)
Vytvoření záznamu s rozšířenými poli
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Typ záznamu
|
RecordRecordType | True | string | |
|
Název (část Volný text)
|
RecordTypedTitle | True | string | |
|
Classification
|
RecordClassification | string |
Zadejte jedinečný identifikátor klasifikace. |
|
|
Author
|
RecordAuthor | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
|
|
Číslo přistoupení
|
RecordAccessionNumber | string | ||
|
Adresát
|
RecordAddressee | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Alternativní kontejner
|
RecordAlternativeContainer | string | ||
|
Pověřený
|
RecordAssignee | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Úroveň spolehlivosti automatické klasifikace
|
RecordAutoClassificationConfidenceLevel | string | ||
|
Automatické vykreslení do PDF při uložení
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Obejití řízení přístupu typu záznamu
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Nepoužívat možnost Uložit?
|
ByPassSave | boolean |
True, pokud objekt neuložíte. Jedním z těchto možností je nastavení jedné nebo více vlastností v příspěvku záznamu a vrácení formuláře pro zadávání dat. Formulář pro zadávání dat pak bude odrážet různé vlastnosti nastavené na původním záznamu. |
|
|
Změnit pozici v oblíbených položkách
|
ChangePositionWithinFavorites | string |
Pokud se nepoužije jiné řazení, vrátí se při hledání oblíbených položek v tomto pořadí. |
|
|
Změnit pozici v popisku uživatele
|
ChangePositionWithinUserLabel | string |
Při vyhledávání podle UserLabel budou vráceny v tomto pořadí, pokud není použito jiné řazení., |
|
|
Vrátit se změnami jako
|
CheckinAs | string |
Nastavte vlastnost Zdroj elektronického dokumentu. |
|
|
Třída záznamu
|
RecordClassOfRecord | string | ||
|
Klient
|
RecordClient | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Záznam klienta
|
RecordClientRecord | string | ||
|
Comments
|
comments | string |
Komentáře pro přechod do poznámek k záznamu při nahrání dokumentu |
|
|
Zásilka
|
RecordConsignment | string | ||
|
Objekt zásilky
|
RecordConsignmentObject | string | ||
|
Container
|
RecordContainer | string | ||
|
Kopírování dokumentu ze záznamu
|
CopyDocumentFromRecord | string |
Zadejte jedinečné ID záznamu, ze kterého chcete zkopírovat elektronický dokument pro tento záznam. |
|
|
Tvůrce
|
RecordCreator | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Datum vytvoření
|
RecordDateCreated | string | ||
|
Termín splnění
|
RecordDateDue | string | ||
|
Datum publikování
|
RecordDatePublished | string | ||
|
Datum přijetí
|
RecordDateReceived | string | ||
|
Editor
|
RecordEditor | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Externí odkaz
|
RecordExternalReference | string | ||
|
Upozornění selžou?
|
FailOnWarnings | boolean |
Ano, pokud objekt nevytvoříte nebo neuložíte, pokud se zobrazí upozornění. |
|
|
Název souboru ve složce Uploads
|
RecordFilePath | string |
Název souboru, který se zobrazí ve složce Uploads. |
|
|
Dokončení při uložení
|
RecordFinalizeOnSave | boolean | ||
|
Cizí čárový kód
|
RecordForeignBarcode | string | ||
|
Poloha GPS
|
RecordGpsLocation | string | ||
|
Umístění domovské stránky
|
RecordHomeLocation | string |
Jedinečné ID umístění |
|
|
Domovský prostor
|
RecordHomeSpace | string | ||
|
Inicializovat šablonu
|
RecordInitiateTemplate | string | ||
|
Je uzavřeno.
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Zachovat rezervovaný
|
keepBookedOut | boolean |
Ano, pokud chcete záznam nechat rezervovaný po nahrání elektronického dokumentu. |
|
|
Datum poslední akce
|
RecordLastActionDate | string | ||
|
Dlouhé číslo
|
RecordLongNumber | string | ||
|
Nastavit jako aktivní
|
MakeActive | string |
Vrátí stav záznamu (a jeho obsah), aby už nebyl neaktivní. Při zpracování obsahu můžete určit, jestli se má úloha zastavit, pokud dojde k nějakým selháním. |
|
|
Neaktivní
|
MakeInactive | string |
Nastaví dateInactive pro tento záznam a veškerý jeho obsah. Při zpracování obsahu můžete určit, jestli se má úloha zastavit, pokud dojde k nějakým selháním. |
|
|
Vytvořit novou revizi
|
makeNewRevision | boolean |
True pro vytvoření nové revize s tímto elektronickým dokumentem false nahradit aktuální revize. |
|
|
Datum ručního zničení
|
RecordManualDestructionDate | string | ||
|
Záznam hmoty
|
RecordMatterRecord | string | ||
|
Typ média
|
RecordMediaType | string | ||
|
Moje autorizační komentáře
|
RecordMyAuthorizationComments | string | ||
|
Moje autorizace byla dokončena.
|
RecordMyAuthorizationComplete | boolean | ||
|
Moje revize komentářů
|
RecordMyReviewComments | string | ||
|
Moje kontrola je dokončená
|
RecordMyReviewComplete | boolean | ||
|
Potřebujete autorizaci?
|
RecordNeedsAuthorization | boolean | ||
|
Potřebujete zkontrolovat?
|
RecordNeedsReview | boolean | ||
|
Nové pravidlo vytváření částí
|
RecordNewPartCreationRule | string |
Jedinečné ID pravidla automatického vytváření částí |
|
|
Poznámky
|
RecordNotes | string | ||
|
Typ aktualizace poznámek
|
NotesUpdateType | string | ||
|
Jiný kontakt
|
RecordOtherContact | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Umístění vlastníka
|
RecordOwnerLocation | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Preserver Hierarchy On Data Entry?
|
RecordPreserveHierarchyOnDataEntry | boolean | ||
|
Záznam předchozí části
|
RecordPrevPartRecord | string | ||
|
Priority
|
RecordPriority | string | ||
|
Záznam nového typu
|
RecordNewType | string |
Ponechte výchozí nastavení, pokud se nevytvoí nová verze nebo kopie. |
|
|
Související záznam
|
RecordRelatedRecord | string | ||
|
Zástupce
|
RecordRepresentative | string | ||
|
Plán uchovávání informací
|
RecordRetentionSchedule | string | ||
|
Datum revize
|
RecordReviewDate | string | ||
|
Zkontrolovat termín splnění
|
RecordReviewDueDate | string | ||
|
Zkontrolovat stav
|
RecordReviewState | string | ||
|
Zabezpečení
|
RecordSecurity | string | ||
|
Záznam řady
|
RecordSeriesRecord | string | ||
|
Sady vlastností
|
propertySets | string |
Kromě odeslaných položek, které se mají vrátit požadavkem, zadejte sady vlastností. |
|
|
Řetězec dotazu
|
q | string |
Sem zadejte dotaz, který použije aktualizaci na sadu záznamů, a ne jenom na jeden (jak je určeno jedinečným ID). |
Návraty
- Body
- CMRecordsResponse
Vytvořit umístění (jiné)
Vytvoření umístění libovolného typu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Typ umístění
|
LocationTypeOfLocation | string | ||
|
Název
|
LocationSortName | True | string | |
|
Jedinečný název
|
LocationNickName | string | ||
|
Číslo ID
|
LocationIdNumber | string | ||
|
Interní
|
LocationIsWithin | boolean | ||
|
Telefon do zaměstnání
|
LocationPhoneNumber | string | ||
|
Mobilní telefon
|
LocationMobileNumber | string | ||
|
Fax
|
LocationFaxNumber | string | ||
|
Telefon domů
|
LocationAfterHoursPhoneNumber | string | ||
|
Stejné jako adresa
|
LocationUseAddressOf | integer |
Jedinečné ID umístění |
|
|
Typ adresy
|
LocationAddressAddressType | string |
Vyberte typ adresy. Limit jednoho typu. |
|
|
Ulice
|
LocationAddressAddressLines | string | ||
|
Předměstí / Město
|
LocationAddressCity | string | ||
|
Stát
|
LocationAddressState | string | ||
|
PSČ
|
LocationAddressPostcode | string | ||
|
Country
|
LocationAddressCountry | string | ||
|
Nastavit jako výchozí
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
Související jedinečné ID
|
AddRelationshipRelatedLocation | integer | ||
|
Typ
|
AddRelationshipRelationshipType | string | ||
|
E-mailová adresa
|
LocationEmailAddress | string | ||
|
Od
|
SetActiveDateRangeValidFromDate | string |
dd/mm/yyyyy |
|
|
To
|
SetActiveDateRangeValidToDate | string |
dd/mm/yyyyy |
|
|
Poznámky
|
LocationNotes | string | ||
|
Typ aktualizace poznámek
|
NotesUpdateType | string |
Návraty
- Body
- CMLocationsResponse
Vytvořit umístění (osoba)
Vytvoření umístění osoby
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Title
|
LocationHonorific | string | ||
|
Příjmení
|
LocationSurname | string | ||
|
Křestní jméno
|
LocationGivenNames | string | ||
|
Interní
|
LocationIsWithin | boolean | ||
|
Název pracovní pozice
|
LocationJobDescription | string | ||
|
Datum narození
|
LocationDateOfBirth | string | ||
|
Oslovení
|
LocationSalutation | string | ||
|
Jedinečný název
|
LocationNickName | string | ||
|
Číslo ID
|
LocationIdNumber | string | ||
|
Telefon do zaměstnání
|
LocationPhoneNumber | string | ||
|
Mobilní telefon
|
LocationMobileNumber | string | ||
|
Fax
|
LocationFaxNumber | string | ||
|
Telefon domů
|
LocationAfterHoursPhoneNumber | string | ||
|
Stejné jako adresa
|
LocationUseAddressOf | integer |
Jedinečné ID umístění |
|
|
Typ adresy
|
LocationAddressAddressType | string |
Vyberte typ adresy. Limit jednoho typu. |
|
|
Ulice
|
LocationAddressAddressLines | string | ||
|
Předměstí / Město
|
LocationAddressCity | string | ||
|
Stát
|
LocationAddressState | string | ||
|
PSČ
|
LocationAddressPostcode | string | ||
|
Country
|
LocationAddressCountry | string | ||
|
Nastavit jako výchozí
|
AddRelationshipMakeThisTheDefaultRelationship | boolean | ||
|
Související jedinečné ID
|
AddRelationshipRelatedLocation | integer | ||
|
Typ
|
AddRelationshipRelationshipType | string | ||
|
E-mailová adresa
|
LocationEmailAddress | string | ||
|
Pohlaví
|
LocationGenderValue | string | ||
|
Přijetí přihlášení
|
LocationCanLogin | boolean | ||
|
Přihlášení k síti
|
LocationLogsInAs | string | ||
|
Další přihlášení k síti
|
LocationAdditionalLogin | string | ||
|
Platnost přihlášení vyprší dne
|
LocationLoginExpires | string | ||
|
Profil uživatele
|
LocationUseProfileOf | integer |
Jedinečné ID umístění |
|
|
Typ uživatele
|
LocationUserType | string | ||
|
Řetězec zabezpečení
|
LocationSecurityString | string | ||
|
Od
|
SetActiveDateRangeValidFromDate | string |
dd/mm/yyyyy |
|
|
To
|
SetActiveDateRangeValidToDate | string |
dd/mm/yyyyy |
|
|
Poznámky
|
LocationNotes | string | ||
|
Typ aktualizace poznámek
|
NotesUpdateType | string |
Návraty
- Body
- CMLocationsResponse
Vytvořit záznam (dokument)
Vytvoření záznamu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Typ záznamu
|
RecordRecordType | True | string | |
|
Název (část Volný text)
|
RecordTypedTitle | True | string | |
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
|
|
Author
|
RecordAuthor | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Adresát
|
RecordAddressee | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Alternativní kontejner
|
RecordAlternativeContainer | string | ||
|
Pověřený
|
RecordAssignee | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Automatické vykreslení do PDF při uložení
|
RecordAutoRenderToPDFOnSave | boolean | ||
|
Obejití řízení přístupu typu záznamu
|
RecordBypassRecordTypeAccessControls | boolean | ||
|
Vrátit se změnami jako
|
CheckinAs | string |
Nastavte vlastnost Zdroj elektronického dokumentu. |
|
|
Classification
|
RecordClassification | string |
Zadejte jedinečný identifikátor klasifikace. |
|
|
Klient
|
RecordClient | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Záznam klienta
|
RecordClientRecord | string | ||
|
Container
|
RecordContainer | string | ||
|
Kopírování dokumentu ze záznamu
|
CopyDocumentFromRecord | string |
Zadejte jedinečné ID záznamu, ze kterého chcete zkopírovat elektronický dokument pro tento záznam. |
|
|
Tvůrce
|
RecordCreator | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Datum vytvoření
|
RecordDateCreated | string | ||
|
Termín splnění
|
RecordDateDue | string | ||
|
Datum publikování
|
RecordDatePublished | string | ||
|
Datum přijetí
|
RecordDateReceived | string | ||
|
Externí odkaz
|
RecordExternalReference | string | ||
|
Upozornění selžou?
|
FailOnWarnings | boolean |
Ano, pokud objekt nevytvoříte nebo neuložíte, pokud se zobrazí upozornění. |
|
|
Název souboru ve složce Uploads
|
RecordFilePath | string |
Název souboru, který se zobrazí ve složce Uploads. |
|
|
Dokončení při uložení
|
RecordFinalizeOnSave | boolean | ||
|
Cizí čárový kód
|
RecordForeignBarcode | string | ||
|
Poloha GPS
|
RecordGpsLocation | string | ||
|
Umístění domovské stránky
|
RecordHomeLocation | string |
Jedinečné ID umístění |
|
|
Domovský prostor
|
RecordHomeSpace | string | ||
|
Je uzavřeno.
|
RecordIsEnclosed | boolean | ||
|
Jurisdiction
|
RecordJurisdictions | string | ||
|
Zachovat rezervovaný
|
keepBookedOut | boolean |
Ano, pokud chcete záznam nechat rezervovaný po nahrání elektronického dokumentu. |
|
|
Datum poslední akce
|
RecordLastActionDate | string | ||
|
Dlouhé číslo
|
RecordLongNumber | string | ||
|
Typ média
|
RecordMediaType | string | ||
|
Poznámky
|
RecordNotes | string | ||
|
Typ aktualizace poznámek
|
NotesUpdateType | string | ||
|
Jiný kontakt
|
RecordOtherContact | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Umístění vlastníka
|
RecordOwnerLocation | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Související záznam
|
RecordRelatedRecord | string | ||
|
Zástupce
|
RecordRepresentative | string |
Jedinečné ID nebo e-mailová adresa místa |
|
|
Datum revize
|
RecordReviewDate | string | ||
|
Zkontrolovat termín splnění
|
RecordReviewDueDate | string | ||
|
Zkontrolovat stav
|
RecordReviewState | string | ||
|
Zabezpečení
|
RecordSecurity | string |
Návraty
- Body
- CMRecordsResponse
Záznam aktualizace (Finale)
Aktualizace konceptu záznamu
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Uživatel, který se má zosobnit
|
userToImpersonate | string |
Přihlášení k síti nebo alternativní přihlášení umístění v CM pro zosobnění |
|
|
Jedinečný identifikátor
|
Uri | True | integer | |
|
Odebrat staré revize
|
SetAsFinalRemoveOldRevisions | boolean | ||
|
Vlastnosti
|
Properties | string |
Seznam vlastností oddělených čárkami, které se mají vrátit |
Návraty
- Body
- CMRecordsResponse
Získání souboru z adresy URL
Stažení souboru z adresy URL do pracovní oblasti pomocí modulu plug-in rozhraní API služby CM GetFileFromUrl
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Adresa URL souboru
|
url | True | string |
Nekódovaná adresa URL souboru ke stažení |
|
Název souboru pro uložení jako
|
filename | string |
Název souboru pro uložení stažené adresy URL jako (pouze název souboru s příponou, nezahrnujte celý adresář). |
|
|
Typ obsahu
|
contentType | string |
Typický řetězec nalezený ve většině záhlaví Content-Type (např. obrázek/png, text/plain, application/pdf). |
Návraty
Odpověď z modulu plug-in rozhraní API služby CM GetFileFromUrl.
Čtení dat událostí
Transformace dat událostí Kapish Dispatch pro spotřebu toků
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Content
|
Content | string |
Obsah akce Service Bus, která načetla data události CM |
Návraty
- Body
- CMEventData
Definice
Záznam CMRecord
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Cesta k souboru
|
RecordFilePath | string |
Název souboru, který se zobrazí ve složce Uploads |
|
Číslo přistoupení
|
RecordAccessionNumber | integer | |
|
Adresát
|
RecordAddressee | integer | |
|
Alternativní kontejner
|
RecordAlternativeContainer | integer | |
|
Pověřený
|
RecordAssignee | integer | |
|
Author
|
RecordAuthor | integer | |
|
Metoda autorizace
|
RecordAuthorizationMethod | string | |
|
Úroveň spolehlivosti automatické klasifikace
|
RecordAutoClassificationConfidenceLevel | integer | |
|
Automatické vykreslení do PDF při uložení
|
RecordAutoRenderToPDFOnSave | boolean | |
|
Název modrého tisku
|
RecordBlueprintTitle | string | |
|
Obejití řízení přístupu typu záznamu
|
RecordBypassRecordTypeAccessControls | boolean | |
|
Vráceno se změnami
|
RecordCheckedInBy | integer | |
|
Rezervováno do
|
RecordCheckedOutTo | integer | |
|
Classification
|
RecordClassification | integer | |
|
Třída záznamu
|
RecordClassOfRecord | string | |
|
Klient
|
RecordClient | integer | |
|
Záznam klienta
|
RecordClientRecord | integer | |
|
Zásilka
|
RecordConsignment | string | |
|
Objekt zásilky
|
RecordConsignmentObject | string | |
|
Container
|
RecordContainer | integer | |
|
Tvůrce
|
RecordCreator | integer | |
|
Aktuální verze
|
RecordCurrentVersion | string | |
|
Datum uzavření
|
RecordDateClosed | date-time | |
|
Datum vytvoření
|
RecordDateCreated | date-time | |
|
Termín splnění
|
RecordDateDue | date-time | |
|
Datum dokončení
|
RecordDateFinalized | date-time | |
|
Datum importu
|
RecordDateImported | date-time | |
|
Neaktivní datum
|
RecordDateInactive | date-time | |
|
Datum změny
|
RecordDateModified | date-time | |
|
Datum publikování
|
RecordDatePublished | date-time | |
|
Datum přijetí
|
RecordDateReceived | date-time | |
|
Datum registrace
|
RecordDateRegistered | date-time | |
|
Čekající připojení dokumentu
|
RecordDocumentAttachPending | boolean | |
|
Velikost dokumentu
|
RecordDocumentSize | integer | |
|
Typ dokladu
|
RecordDocumentType | string | |
|
Editor
|
RecordEditor | integer | |
|
Elektronické úložiště dokumentů
|
RecordEStore | integer | |
|
Rozšíření dokumentu
|
RecordExtension | string | |
|
Externí odkaz
|
RecordExternalReference | string | |
|
Dokončení při uložení
|
RecordFinalizeOnSave | boolean | |
|
Původ složky
|
RecordFolderOrigin | integer | |
|
Cizí čárový kód
|
RecordForeignBarcode | string | |
|
Vygenerovaný název
|
RecordGeneratedTitle | string | |
|
Poloha GPS
|
RecordGpsLocation | string | |
|
Umístění domovské stránky
|
RecordHomeLocation | integer | |
|
Domovský prostor
|
RecordHomeSpace | integer | |
|
Inicializovat šablonu
|
RecordInitiateTemplate | string |
Jedinečné ID šablony pracovního postupu |
|
Je uzavřeno.
|
RecordIsEnclosed | boolean | |
|
Jurisdiction
|
RecordJurisdictions | string | |
|
Datum poslední akce
|
RecordLastActionDate | date-time | |
|
Záznam poslední části
|
RecordLastPartRecord | integer | |
|
Nejnovější verze
|
RecordLatestVersion | integer | |
|
Rozbalené číslo
|
RecordLongNumber | string | |
|
Číslo záznamu
|
RecordNumber | string | |
|
Datum ručního zničení
|
RecordManualDestructionDate | date-time | |
|
Záznam hmoty
|
RecordMatterRecord | integer | |
|
Typ média
|
RecordMediaType | string | |
|
Schůzka
|
RecordMeeting | integer | |
|
Typ MIME
|
RecordMimeType | string | |
|
Moje autorizační komentáře
|
RecordMyAuthorizationComments | string | |
|
Moje autorizace byla dokončena.
|
RecordMyAuthorizationComplete | boolean | |
|
Moje revize komentářů
|
RecordMyReviewComments | string | |
|
Moje kontrola je dokončená
|
RecordMyReviewComplete | boolean | |
|
Číslování stránek?
|
RecordNbrPages | integer | |
|
Potřebujete autorizaci?
|
RecordNeedsAuthorization | boolean | |
|
Potřebujete zkontrolovat?
|
RecordNeedsReview | boolean | |
|
Nové pravidlo vytváření částí
|
RecordNewPartCreationRule | string |
Jedinečné ID pravidla automatického vytváření částí |
|
Další záznam části
|
RecordNextPartRecord | integer | |
|
Typ aktualizace poznámek
|
NotesUpdateType | string | |
|
Poznámky
|
RecordNotes | string | |
|
Pochází z
|
RecordOriginatedFrom | string | |
|
Pochází ze spuštění
|
RecordOriginatedFromRun | string | |
|
Jiný kontakt
|
RecordOtherContact | integer | |
|
Umístění vlastníka
|
RecordOwnerLocation | integer | |
|
Preserver Hierarchy On Data Entry?
|
RecordPreserveHierarchyOnDataEntry | boolean | |
|
Záznam předchozí části
|
RecordPrevPartRecord | integer | |
|
Primární kontakt
|
RecordPrimaryContact | integer | |
|
Priority
|
RecordPriority | string | |
|
Typ záznamu
|
RecordRecordType | integer | |
|
Související záznam
|
RecordRelatedRecord | integer | |
|
Zástupce
|
RecordRepresentative | integer | |
|
Plán uchovávání informací
|
RecordRetentionSchedule | integer | |
|
Datum revize
|
RecordReviewDate | date-time | |
|
Zkontrolovat termín splnění
|
RecordReviewDueDate | date-time | |
|
Zkontrolovat stav
|
RecordReviewState | string | |
|
Záznam kořenové části
|
RecordRootPartRecord | integer | |
|
Zabezpečení
|
RecordSecurity | string | |
|
Záznam řady
|
RecordSeriesRecord | integer | |
|
Title
|
RecordTitle | string | |
|
Název (část Volný text)
|
RecordTypedTitle | string | |
|
Jedinečný identifikátor
|
Uri | integer | |
|
Další pole
|
Fields | object |
CMEventData
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Jedinečný identifikátor události
|
OnlineEventUri | integer | |
|
ID typu události
|
EventType | integer | |
|
Typ události
|
EventTypeString | string | |
|
Datum události
|
EventDate | date-time | |
|
ID typu objektu
|
ObjectType | integer | |
|
Typ objektu
|
ObjectTypeString | string | |
|
Jedinečné ID objektu
|
ObjectUri | integer | |
|
ID souvisejícího typu objektu
|
RelatedObjectType | integer | |
|
Související typ objektu
|
RelatedObjectTypeString | string | |
|
Jedinečné ID souvisejícího objektu
|
RelatedObjectUri | integer | |
|
Z počítače
|
FromMachine | string | |
|
IP adresa připojení
|
ConnectionIPAddress | string | |
|
IP adresa klienta
|
ClientIPAddress | string | |
|
Z časového pásma
|
FromTimeZone | integer | |
|
Přihlašovací jméno
|
LoginName | string | |
|
Jedinečné ID přihlášení
|
LoginUri | integer | |
|
Další podrobnosti
|
ExtraDetails | string |
CMLogMessage
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Zpráva protokolu
|
LogMessage | string | |
|
Vyhledat
|
TrimType | CMTrimType | |
|
Jedinečný identifikátor
|
Uri | integer |
CMRecordsResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Results
|
Results | array of CMRecord | |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Celkový počet výsledků
|
TotalResults | integer | |
|
Count String Ex
|
CountStringEx | string | |
|
Minimální počet
|
MinimumCount | integer | |
|
Počet
|
Count | integer | |
|
Obsahuje další položky
|
HasMoreItems | boolean | |
|
Název hledání
|
SearchTitle | string | |
|
Stiskněte zvýraznit řetězec
|
HitHighlightString | string | |
|
Vyhledat
|
TrimType | CMTrimType | |
|
Stav odpovědi
|
ResponseStatus | CMResponseStatus |
Stav odpovědi |
CMLogResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Results
|
Results | array of CMLogMessage | |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Celkový počet výsledků
|
TotalResults | integer | |
|
Count String Ex
|
CountStringEx | string | |
|
Minimální počet
|
MinimumCount | integer | |
|
Počet
|
Count | integer | |
|
Obsahuje další položky
|
HasMoreItems | boolean | |
|
Název hledání
|
SearchTitle | string | |
|
Stiskněte zvýraznit řetězec
|
HitHighlightString | string | |
|
Vyhledat
|
TrimType | CMTrimType | |
|
Stav odpovědi
|
ResponseStatus | CMResponseStatus |
Stav odpovědi |
CMUpdateErrorResponse
Odpověď na chybu aktualizace
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Kód chyby
|
ErrorCode | string | |
|
Jedinečný identifikátor
|
Uri | integer | |
|
Message
|
Message | string | |
|
Název
|
Name | string | |
|
Název (navíc)
|
NameExtra | string |
CMResponseStatus
Stav odpovědi
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Kód chyby
|
ErrorCode | string | |
|
Message
|
Message | string | |
|
StackTrace
|
StackTrace | string | |
|
Errors
|
Errors | array of CMResponseError | |
|
Meta
|
Meta | object |
Řetězec slovníku<, řetězec> |
CMResponseError
Chyba odpovědi
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Kód chyby
|
ErrorCode | string | |
|
Název pole
|
FieldName | string | |
|
Message
|
Message | string | |
|
Meta
|
Meta | object |
Řetězec slovníku<, řetězec> |
CMTrimType
- Vyhledat
- string
CMLocation
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Jedinečný identifikátor
|
Uri | integer | |
|
Název
|
NameString | string | |
|
Název umístění s úplným formátováním
|
LocationFullFormattedName | string | |
|
Název řazení umístění
|
LocationSortName | string |
CMBob
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Jedinečný identifikátor
|
Uri | integer | |
|
Název
|
NameString | string |
CMLocationsResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Results
|
Results | array of CMLocation |
Results |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Celkový počet výsledků
|
TotalResults | integer | |
|
Count String Ex
|
CountStringEx | string | |
|
Minimální počet
|
MinimumCount | integer | |
|
Počet
|
Count | integer | |
|
Obsahuje další položky
|
HasMoreItems | boolean | |
|
Název hledání
|
SearchTitle | string | |
|
Stiskněte zvýraznit řetězec
|
HitHighlightString | string | |
|
Vyhledat
|
TrimType | CMTrimType | |
|
Stav odpovědi
|
ResponseStatus | CMResponseStatus |
Stav odpovědi |
CMBobResponse
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Results
|
Results | array of CMBob |
Results |
|
UpdateErrorResults
|
UpdateErrorResults | array of CMUpdateErrorResponse | |
|
Celkový počet výsledků
|
TotalResults | integer | |
|
Count String Ex
|
CountStringEx | string | |
|
Minimální počet
|
MinimumCount | integer | |
|
Počet
|
Count | integer | |
|
Obsahuje další položky
|
HasMoreItems | boolean | |
|
Název hledání
|
SearchTitle | string | |
|
Stiskněte zvýraznit řetězec
|
HitHighlightString | string | |
|
Vyhledat
|
TrimType | CMTrimType | |
|
Stav odpovědi
|
ResponseStatus | CMResponseStatus |
Stav odpovědi |
GetFileFromUrlResponse
Odpověď z modulu plug-in rozhraní API služby CM GetFileFromUrl.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Cesta k souboru
|
Filepath | string |
Místní cesta k souboru staženého z adresy URL. |
|
Message
|
Message | string |
CMLocationAddressUri
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Jedinečné ID
|
Uri | integer |
binární
Toto je základní datový typ Binary.
objekt
Toto je typ "object".