Dela via


iManage Work

Med iManage Work-anslutningsappen kan användarna automatisera repetitiva uppgifter och godkännandeprocesser medan de håller alla sina filer säkra i iManage Work-miljön.

Den här anslutningsappen är tillgänglig i följande produkter och regioner:

Tjänster Class Regioner
Copilot Studio Premie Alla Power Automate-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Logiska appar Norm Alla Logic Apps-regioner utom följande:
     – Azure Government-regioner
     – Regioner i Azure Kina
     - US Department of Defense (DoD)
Power Apps Premie Alla Power Apps-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Power Automate Premie Alla Power Automate-regioner utom följande:
     - Amerikanska myndigheter (GCC)
     - Amerikanska myndigheter (GCC High)
     – China Cloud drivs av 21Vianet
     - US Department of Defense (DoD)
Kontakt
Namn iManage LLC
URL https://docs.imanage.com
E-postmeddelande cloudsupport@imanage.com
Metadata för anslutningsprogram
Utgivare iManage Power Platform Connector
Webbplats https://imanage.com
Sekretesspolicy https://imanage.com/about/privacy-notice/
Kategorier Innehåll och filer; Produktivitet

iManage Work

iManage är den branschledande leverantören av lösningar för dokument- och e-posthantering för kunskapsarbetare. iManage-plattformen organiserar och skyddar informationen i dokument och e-postmeddelanden, så att proffs kan söka efter det de behöver, agera på den och samarbeta mer effektivt. Med anslutningsappen iManage Work kan användarna automatisera repetitiva uppgifter och godkännandeprocesser medan de håller alla sina filer säkra i iManage Work-miljön.

Förutsättningar

Anslutningsappen är tillgänglig för alla iManage Work-kunder som ansluter till cloudimanage.com. Först måste Power Automate-programmet aktiveras av en administratör för din iManage Work-miljö. När du är aktiverad behöver du den specifika URL:en för din miljö och ett inloggningskonto och lösenord där anslutningsappen kan utföra åtgärder. Mer information finns i Vanliga frågor och svar.

Hämta autentiseringsuppgifter

Om du är en befintlig iManage Work-användare anger du dina iManage Work-autentiseringsuppgifter för inloggning. Annars kan du kontakta systemadministratören om du vill ha hjälp.

Kom igång med iManage Work-anslutningsappen

Utför följande steg för att komma igång med iManage Work-anslutningsappen:

  • Skapa ett omedelbart molnflöde och välj + Nytt steg.
  • Sök efter iManage Work för att se alla tillgängliga iManage Work-åtgärder.
  • Välj önskad iManage Work-åtgärd.
  • Om du inte redan är inloggad på iManage Work uppmanas du att logga in.
    • Välj Logga in.
    • Ange den URL som du använder för att ansluta till iManage Work, till exempel cloudimanage.com.
    • Ange ditt iManage Work-användar-ID.
    • Ange lösenordet för det valda kontot och välj Logga in. Från och med nu ansluter alla flöden som använder iManage Work-åtgärder med hjälp av dessa användarautentiseringsuppgifter. Ett annat iManage-användarkonto kan användas genom att lägga till en ny anslutning under Mina anslutningar och växla till den.

Kända problem och begränsningar

En lista över kända problem och begränsningar finns i https://docs.imanage.com/power-automate/index.html.

Vanliga fel och åtgärder

En lista över vanliga fel och åtgärder finns i https://docs.imanage.com/power-automate/index.html.

Vanliga frågor

En lista över vanliga frågor och svar finns i https://docs.imanage.com/power-automate/index.html.

Begränsningar för strypning

Namn Samtal Förnyelseperioden
API-anrop per anslutning 100 60 sekunder

Åtgärder

Ange viktiga utökade metadataegenskaper för ett dokument

Anger grundläggande utökade metadataegenskaper för ett dokument.

Flytta dokument

Flyttar ett dokument till den angivna mappen.

Flytta upp dokumentversion

Höjer upp en befintlig version av ett dokument till den senaste versionen. En ny version skapas från ett angivet journal-ID eller version och uppgraderas sedan till den senaste. Du måste ange antingen journal-ID eller version, men inte båda.

Hämta användarinformation

Hämtar information om en användare från det angivna biblioteket.

Hämta arbetsytemallar

Hämtar en lista över tillgängliga mallar i ett bibliotek. En arbetsytemall är en fördefinierad arbetsyta vars struktur kopieras för den nya arbetsytan.

Hämta arbetsyteprofil

Hämtar arbetsyteprofilen och eventuellt listan över tillåtna åtgärder för arbetsytan.

Hämta behörigheter

Hämtar behörighetsegenskaper för användare eller grupper för ett dokument, en mapp eller en arbetsyta. Svarsegenskaperna kan variera med användar- eller gruppbehörigheter.

Hämta bibliotek

Hämtar en lista över bibliotek som användaren har åtkomst till.

Hämta dokumentprofil

Hämtar dokumentegenskaperna som är associerade med ett specifikt dokument-ID.

Hämta dokumentversioner

Hämtar profiler för alla versioner som den aktuella användaren har åtkomst till för ett angivet dokument.

Hämta grundläggande utökade metadataegenskaper för ett dokument

Hämtar grundläggande utökade metadataegenskaper för ett dokument.

Hämta gruppmedlemmar

Hämta information om användare som tillhör den angivna gruppen och matcha de angivna kriterierna.

Hämta klasser

Hämtar listan över dokumentklasser som är tillgängliga i ett bibliotek som matchar de angivna kriterierna.

Hämta underklasser

Hämtar alla biblioteksunderklasser som matchar de angivna kriterierna.

Kopiera behörigheter

Kopierar åtkomstbehörigheterna, och eventuellt standardsäkerheten, från ett iManage Work-objekt till ett annat. "Kopieringstyp" ger dig alternativ för hur du hanterar kombinationen av käll- och målbehörigheter. "Skriv över" uppdaterar målobjektets användare, grupper och behörighetsnivåer för att exakt matcha källobjektets. "Sammanfogning" behåller alla användare och grupper på målobjektet och kombinerar dem med källan, men i händelse av en konflikt på behörighetsnivå på en individ eller grupp: "Sammanslagning (pessimistisk)" tar den lägre behörigheten, medan "Merge (Optimistic)" tar den högre behörigheten för den konfliktande användaren eller gruppen.

Kopiera dokument

Kopierar ett dokument till den angivna mappen.

Ladda ned dokument

Laddar ned en version av ett visst dokument baserat på dokument-ID:t. Om den senaste är sann laddas den senaste versionen av det här dokumentet ned. Nedladdningen är en dataström och sparas inte lokalt.

Ladda upp dokument

Laddar upp en fil som ett nytt dokument till den angivna mappen.

Lägg till dokumentreferens

Lägger till dokumentreferens eller dokumentgenväg i en annan mapp.

Lägg till post för dokumenthistorik

Lägger till en post som en händelse i dokumentets historik.

Redigera namn/värde-par

Skapar, uppdaterar eller tar bort namn/värde-paregenskaper för ett dokument, en mapp eller en arbetsyta. Om du vill ta bort ett namn/värde-par anger du värdet för nyckeln till en tom sträng omsluten med enkla eller dubbla citattecken.

Skaffa förvaltare

Hämtar en lista över förvaltare med vissa behörigheter för ett dokument, en mapp eller en arbetsyta. En förvaltare kan vara en användare eller grupp.

Skapa arbetsyta

Skapar en ny arbetsyta baserat på den valda mallen. En arbetsytemall är en fördefinierad arbetsyta vars struktur kopieras till den nya arbetsytan. Begränsningar för arbetsytemallen tillämpas automatiskt när den nya arbetsytan skapas.

Skapa dokumentrelation

Skapar en relation mellan angivna dokument i ett bibliotek.

Sök användare

Söker efter iManage Work-användare som matchar de angivna sökvillkoren.

Sök efter arbetsytor

Sök efter arbetsytor.

Sök efter mappar

Sök efter mappar.

Sök igenom utökade metadatataxonominodvärden för sökkärnor

Söker efter grundläggande utökade metadatataxonominodvärden som matchar de angivna sökvillkoren.

Ta bort dokument

Tar bort det angivna dokumentet.

Ta bort dokumentreferens

Tar bort dokumentreferensen från den angivna mappen.

Ta bort dokumentrelation

Tar bort en relation mellan angivna dokument i ett bibliotek.

Uppdatera aktuell eller skapa ny dokumentversion

Uppdaterar den angivna versionen av ett dokument eller skapar en ny version. Den här åtgärden kan uppdatera profilen och innehållet i ett dokument. Om alternativet Uppdatera aktuell version har angetts ersätts dokumentet med ett nytt och profilen för det tidigare dokumentet bibehålls. Om "Skapa ny version" har angetts skapas en ny version av dokumentet som ärver mappens profil. När åtgärden har körts returneras dokumentprofilen.

Uppdatera arbetsflödestillstånd

Uppdaterar tillståndet för en arbetsflödeskörning. Den här åtgärden kan bara användas i ett arbetsflöde som har skapats för att börja med en utlösare som tillhandahålls av iManage.

Uppdatera arbetsyta

Uppdaterar information om den angivna arbetsytan. Om du vill ta bort det befintliga värdet för ett strängfält anger du värdet för fältet till en tom sträng omsluten med enkla eller dubbla citattecken.

Uppdatera behörigheter

Uppdaterar behörigheter för ett objekt.

Uppdatera dokumentprofil

Uppdaterar dokumentprofilen. Ett dokument får inte användas när profilen uppdateras och det går inte att uppdatera profilen för ett utcheckat dokument. Returnerar en uppdaterad dokumentprofil efter åtgärden.

Uppdatera standardsäkerhet

Uppdaterar standardsäkerheten för ett dokument, en mapp eller en arbetsyta.

Ange viktiga utökade metadataegenskaper för ett dokument

Anger grundläggande utökade metadataegenskaper för ett dokument.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Dokument-ID
documentId True string

Anger dokumentets ID. Till exempel "ACTIVE_US!453.1".

Namn
key True string

Anger namnet på den utökade metadataegenskapen.

Värde
value True string

Anger ett eller flera värden som ska anges för egenskapen för utökade kärnmetadata, avgränsade med semikolon. Om du vill ta bort värdet anger du värdet för nyckeln till en tom sträng omsluten med enkla eller dubbla citattecken.

Flytta dokument

Flyttar ett dokument till den angivna mappen.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Överordnat mapp-ID
folderId True string

Anger mapp-ID för den överordnade mappen. Till exempel "ACTIVE_US!987".

Dokument-ID
documentId True string

Anger dokumentets ID. Till exempel "ACTIVE_US!453.1".

Målmapps-ID
destination_folder_id True string

Anger målmappens ID som dokumentet ska flyttas till. Till exempel "ACTIVE_US!987".

Använd målprofil
update_profile boolean

Anger om dokumentprofilen ska uppdateras med målmappsprofilen.

Tillämpa målsäkerhet
update_security boolean

Anger om dokumentsäkerheten ska uppdateras med målmappens säkerhet. Den här parametern gäller endast när uppdateringsprofilen är inställd på true.

Tidslinjekommentar
comments string

Anger ytterligare information om åtgärden. Dessa kommentarer visas i dokumentets tidslinje.

Flytta upp dokumentversion

Höjer upp en befintlig version av ett dokument till den senaste versionen. En ny version skapas från ett angivet journal-ID eller version och uppgraderas sedan till den senaste. Du måste ange antingen journal-ID eller version, men inte båda.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Dokument-ID
documentId True string

Anger dokumentets ID. Till exempel "ACTIVE_US!453.1".

Utgåva
version integer

Anger det versionsnummer som ska användas som grund för den nya, upphöjda versionen.

Journal-ID
journalId string

Anger journal-ID:t som ska användas som grund för den nya, upphöjda versionen.

Comment
comment string

Anger ytterligare information om dokumentet.

Alias
alias string

Anger aliaset för det här dokumentet.

Author
author string

Anger ID för användaren som skapade dokumentet. Till exempel "JSMITH".

Dokumentklass
class string

Anger dokumentklassen.

Standardsäkerhet för dokument
default_security string

Anger standardnivån för säkerhetsåtkomst.

Deklareras
is_declared boolean

Anger om den nya versionen av dokumentet ska deklareras som en post. Ett dokument som deklareras som en post kan inte redigeras eller tas bort, förutom av en systemadministratör för iManage Work.

Är HIPAA
is_hipaa boolean

Anger om den nya versionen av dokumentet ska krypteras.

Dokumentnamn
name string

Anger dokumentets filnamn.

Operator
operator string

Anger ID:t för den användare som har dokumentet utcheckat eller som för närvarande redigerar dokumentets profil. Till exempel "JSMITH".

Behålla dagar
retain_days integer

Anger antalet dagar innan det inaktiva dokumentet är berättigat till arkivering.

Underklass
subclass string

Anger dokumentets underklass.

Anpassad1
custom1 string

Anger värdet för custom1.

Anpassad 2
custom2 string

Anger värdet för custom2. Om du vill ange ett värde för custom2 måste du också ange ett värde för custom1 i samma begäran, vilket beror på relationen mellan överordnad och underordnad.

Anpassad 3
custom3 string

Anger värdet för custom3.

Anpassad 4
custom4 string

Anger värdet för custom4.

Anpassad 5
custom5 string

Anger värdet för custom5.

Anpassad 6
custom6 string

Anger värdet för custom6.

Anpassad 7
custom7 string

Anger värdet för custom7.

Anpassad8
custom8 string

Anger värdet för custom8.

Anpassad9
custom9 string

Anger värdet för custom9.

Custom10
custom10 string

Anger värdet för custom10.

Custom11
custom11 string

Anger värdet för custom11.

Custom12
custom12 string

Anger värdet för custom12.

Custom13
custom13 string

Anger värdet för custom13.

Custom14
custom14 string

Anger värdet för custom14.

Anpassad 15
custom15 string

Anger värdet för custom15.

Anpassad 16
custom16 string

Anger värdet för custom16.

Anpassad 17
custom17 double

Anger värdet för custom17.

Anpassad 18
custom18 double

Anger värdet för custom18.

Anpassad 19
custom19 double

Anger värdet för custom19.

Custom20
custom20 double

Anger värdet för custom20.

Custom21
custom21 string

Anger värdet för egenskapen custom21 i ISO 8601 datetime-format.

Anpassad 22
custom22 string

Anger värdet för egenskapen custom22 i ISO 8601 datetime-format.

Anpassad 23
custom23 string

Anger värdet för egenskapen custom23 i ISO 8601 datetime-format.

Anpassad 24
custom24 string

Anger värdet för egenskapen custom24 i ISO 8601 datetime-format.

Anpassad 25
custom25 boolean

Anger värdet för custom25.

Anpassad 26
custom26 boolean

Anger värdet för custom26.

Anpassad 27
custom27 boolean

Anger värdet för custom27.

Anpassad 28
custom28 boolean

Anger värdet för custom28.

Anpassad 29
custom29 string

Anger värdet för custom29.

Custom30
custom30 string

Anger värdet för custom30. Om du vill ange ett värde för custom30 måste du också ange ett värde för custom29 i samma begäran, vilket beror på relationen mellan överordnad och underordnad.

Hämta användarinformation

Hämtar information om en användare från det angivna biblioteket.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Biblioteks-ID
libraryId True string

Anger målanvändarens biblioteks-ID.

Användar-ID
userId True string

Anger ID:t för användaren för vilken detaljerad profilinformation ska hämtas. Till exempel "JSMITH".

Returnerar

Namn Stig Typ Beskrivning
data
data UserProfile

Anger information om en användare.

Hämta arbetsytemallar

Hämtar en lista över tillgängliga mallar i ett bibliotek. En arbetsytemall är en fördefinierad arbetsyta vars struktur kopieras för den nya arbetsytan.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Biblioteks-ID
libraryId True string

Anger biblioteks-ID för målarbetsytan.

Anpassad1
custom1 string

Anger ett värde som ska matchas med custom1-värdet som är associerat med arbetsytemallen. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad 2
custom2 string

Anger ett värde som ska matchas med custom2-värdet som är associerat med arbetsytemallen. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad 3
custom3 string

Anger ett värde som ska matchas med custom3-värdet som är associerat med arbetsytemallen. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad 4
custom4 string

Anger ett värde som ska matchas med custom4-värdet som är associerat med arbetsytemallen. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad 5
custom5 string

Anger ett värde som ska matchas med custom5-värdet som är associerat med arbetsytemallen. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad 6
custom6 string

Anger ett värde som ska matchas med custom6-värdet som är associerat med arbetsytemallen. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad 7
custom7 string

Anger ett värde som ska matchas med anpassat7-värde som är associerat med arbetsytemallen. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad8
custom8 string

Anger ett värde som ska matchas med custom8-värdet som är associerat med arbetsytemallen. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad9
custom9 string

Anger ett värde som ska matchas med det anpassade9-värdet som är associerat med arbetsytemallen. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Custom10
custom10 string

Anger ett värde som ska matchas med custom10-värdet som är associerat med arbetsytemallen. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Custom11
custom11 string

Anger ett värde som ska matchas med custom11-värdet som är associerat med arbetsytemallen. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Custom12
custom12 string

Anger ett värde som ska matchas med custom12-värdet som är associerat med arbetsytemallen. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad 17
custom17 double

Anger värdet för custom17.

Anpassad 18
custom18 double

Anger värdet för custom18.

Anpassad 19
custom19 double

Anger värdet för custom19.

Custom20
custom20 double

Anger värdet för custom20.

Custom21
custom21 string

Anger värdet (i ISO 8601 datetime-format) som ska sökas efter i anpassad 21 som är associerad med arbetsytemallen. Den här sökningen är inte skiftlägeskänslig. För arbetsytor anpassas användningen av den här egenskapen för din iManage Work-installation.

Anpassad 22
custom22 string

Anger det värde (i ISO 8601 datetime-format) som ska sökas efter i custom22 som är associerat med arbetsytemallen. Den här sökningen är inte skiftlägeskänslig. För arbetsytor anpassas användningen av den här egenskapen för din iManage Work-installation.

Anpassad 23
custom23 string

Anger det värde (i ISO 8601 datetime-format) som ska sökas efter i anpassad 23 som är associerad med arbetsytemallen. Den här sökningen är inte skiftlägeskänslig. För arbetsytor anpassas användningen av den här egenskapen för din iManage Work-installation.

Anpassad 24
custom24 string

Anger det värde (i ISO 8601 datetime-format) som ska sökas efter i anpassad 24 som är associerad med arbetsytemallen. Den här sökningen är inte skiftlägeskänslig. För arbetsytor anpassas användningen av den här egenskapen för din iManage Work-installation.

Custom21 (lägre gräns)
custom21_from string

Anger den lägre gränsen för custom21 (i ISO 8601 datetime-format) för sökning. Den här egenskapen är inte reserverad av iManage Work och är inte ett verifierat värde. Den är avsedd att anpassas efter företagets krav.

Custom21 (övre gräns)
custom21_to string

Anger den övre gränsen för custom21 (i ISO 8601 datetime-format) för sökning. Den här egenskapen är inte reserverad av iManage Work och är inte ett verifierat värde. Den är avsedd att anpassas efter företagets krav.

Custom21 (relativ)
custom21_relative string

Anger ett datumintervall som ska sökas, i förhållande till det aktuella datumet. Den här parametern har formatet [begin]:[end][time units (d, m eller y)]. Till exempel anger -15:1d ett datumintervall från 15 dagar före det aktuella datumet till och med en dag efter det aktuella datumet (en dag i framtiden).

Custom22 (lägre gräns)
custom22_from string

Anger den lägre gränsen för custom22 (i ISO 8601 datetime-format) för sökning. Den här egenskapen är inte reserverad av iManage Work och är inte ett verifierat värde. Den är avsedd att anpassas efter företagets krav.

Custom22 (övre gräns)
custom22_to string

Anger den övre gränsen för custom22 (i ISO 8601 datetime-format) för sökning. Den här egenskapen är inte reserverad av iManage Work och är inte ett verifierat värde. Den är avsedd att anpassas efter företagets krav.

Custom22 (relativ)
custom22_relative string

Anger ett datumintervall som ska sökas, i förhållande till det aktuella datumet. Den här parametern har formatet [begin]:[end][time units (d, m eller y)]. Till exempel anger -15:1d ett datumintervall från 15 dagar före det aktuella datumet till och med en dag efter det aktuella datumet (en dag i framtiden).

Custom23 (lägre gräns)
custom23_from string

Anger den lägre gränsen för custom23 (i ISO 8601 datetime-format) för sökning. Den här egenskapen är inte reserverad av iManage Work och är inte ett verifierat värde. Den är avsedd att anpassas efter företagets krav.

Custom23 (övre gräns)
custom23_to string

Anger den övre gränsen för custom23 (i ISO 8601 datetime-format) för sökning. Den här egenskapen är inte reserverad av iManage Work och är inte ett verifierat värde. Den är avsedd att anpassas efter företagets krav.

Custom23 (relativ)
custom23_relative string

Anger ett datumintervall som ska sökas, i förhållande till det aktuella datumet. Den här parametern har formatet [begin]:[end][time units (d, m eller y)]. Till exempel anger -15:1d ett datumintervall från 15 dagar före det aktuella datumet till och med en dag efter det aktuella datumet (en dag i framtiden).

Custom24 (lägre gräns)
custom24_from string

Anger den lägre gränsen för custom24 (i ISO 8601 datetime-format) för sökning. Den här egenskapen är inte reserverad av iManage Work och är inte ett verifierat värde. Den är avsedd att anpassas efter företagets krav.

Custom24 (övre gräns)
custom24_to string

Anger den övre gränsen för custom24 (i ISO 8601 datetime-format) för sökning. Den här egenskapen är inte reserverad av iManage Work och är inte ett verifierat värde. Den är avsedd att anpassas efter företagets krav.

Custom24 (relativ)
custom24_relative string

Anger ett datumintervall som ska sökas, i förhållande till det aktuella datumet. Den här parametern har formatet [begin]:[end][time units (d, m eller y)]. Till exempel anger -15:1d ett datumintervall från 15 dagar före det aktuella datumet till och med en dag efter det aktuella datumet (en dag i framtiden).

Anpassad 25
custom25 boolean

Anger det custom25-värde som ska sökas efter.

Anpassad 26
custom26 boolean

Anger det custom26-värde som ska sökas efter.

Anpassad 27
custom27 boolean

Anger det custom27-värde som ska sökas efter.

Anpassad 28
custom28 boolean

Anger det custom28-värde som ska sökas efter.

Anpassad 29
custom29 string

Anger ett värde som ska matchas med custom29. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Custom30
custom30 string

Anger ett värde som ska matchas med custom30. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Hämta arbetsyteprofil

Hämtar arbetsyteprofilen och eventuellt listan över tillåtna åtgärder för arbetsytan.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Arbetsplats-ID
workspaceId True string

Anger arbetsytans ID. Till exempel "ACTIVE_US!427".

Hämta behörigheter

Hämtar behörighetsegenskaper för användare eller grupper för ett dokument, en mapp eller en arbetsyta. Svarsegenskaperna kan variera med användar- eller gruppbehörigheter.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Objekttyp
objectType True string

Anger typ av objekt.

Objekt-ID
objectId True string

Anger ID för dokumentet, mappen eller arbetsytan. Ett exempel på ett dokument-ID är "ACTIVE_US!453.1". Ett exempel på en mapp eller ett arbetsyte-ID är "ACTIVE_US!123".

Returnerar

Namn Stig Typ Beskrivning
Standardsäkerhet
data.default_security string

Anger standardsäkerheten för objektet. Möjliga värden är "ärver", "offentlig", "vy" eller "privat".

Ärvd standardsäkerhet
data.inherited_default_security string

Anger den ärvda standardsäkerheten för en mapp när standardsäkerheten är inställd på "ärver". Möjliga värden är "public", "view" eller "private".

Åtkomstbehörigheter
data.acl AccessPermissions

Anger en samling åtkomstbehörigheter för en eller flera användare och/eller grupper.

Alla användar-ID:t
data.all_user_ids string

Anger en lista över alla användar-ID:n, sammanfogade som en sträng och avgränsade med semikolon.

Alla grupp-ID:t
data.all_group_ids string

Anger en lista över alla grupp-ID:n, sammanfogade som en sträng och avgränsade med semikolon.

Hämta bibliotek

Hämtar en lista över bibliotek som användaren har åtkomst till.

Returnerar

Namn Stig Typ Beskrivning
data
data array of object

Anger listan över bibliotek som användaren har åtkomst till.

ID-nummer
data.id string

Anger namnet på biblioteket.

Namn
data.display_name string

Anger visningsnamnet för biblioteket.

Typ
data.type string

Anger bibliotekstypen. Möjliga värden är "worksite" eller "linksite".

Är dold
data.is_hidden boolean

Anger om biblioteket är dolt.

Hämta dokumentprofil

Hämtar dokumentegenskaperna som är associerade med ett specifikt dokument-ID.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Dokument-ID
documentId True string

Anger dokumentets ID. Till exempel "ACTIVE_US!453.1".

Hämta den senaste versionen
latest boolean

Anger för att hämta den senaste versionen av dokumentet.

Hämta dokumentversioner

Hämtar profiler för alla versioner som den aktuella användaren har åtkomst till för ett angivet dokument.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Dokument-ID
documentId True string

Anger dokumentets ID. Till exempel "ACTIVE_US!453.1".

Returnerar

Namn Stig Typ Beskrivning
Dokumentprofiler
data array of MinimalDocumentProfileInArray

Hämta grundläggande utökade metadataegenskaper för ett dokument

Hämtar grundläggande utökade metadataegenskaper för ett dokument.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Dokument-ID
documentId True string

Anger dokumentets ID. Till exempel "ACTIVE_US!453.1".

Senast
latest boolean

Anger för att hämta den senaste versionen av dokumentet.

Hämta gruppmedlemmar

Hämta information om användare som tillhör den angivna gruppen och matcha de angivna kriterierna.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Biblioteks-ID
libraryId True string

Anger målgruppens biblioteks-ID.

grupp-id
groupId True string

Anger gruppens ID. Till exempel "MARKNADSFÖRING".

Inloggningsstatus
logon_status string

Anger ett filter för användare baserat på det aktuella egenskapsvärdet "allow_logon" för varje användare.

Limit
limit integer

Anger det maximala antalet medlemmar som ska returneras oavsett det totala antalet medlemmar i gruppen.

Föredraget bibliotek
preferred_library string

Anger att endast användare vars föredragna bibliotek matchar det angivna värdet returneras.

Plats
location string

Anger den plats som ska användas för att hitta användare baserat på deras geografiska plats. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) stöds inte.

Returnerar

Namn Stig Typ Beskrivning
data
data array of UserProfileInArray

Anger listan över användare som tillhör den angivna gruppen och matchar de angivna kriterierna.

Hämta klasser

Hämtar listan över dokumentklasser som är tillgängliga i ett bibliotek som matchar de angivna kriterierna.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Biblioteks-ID
libraryId True string

Anger biblioteks-ID för målklassen.

Klass-ID
alias string

Anger ID för en klass eller klasser att söka efter. Kan vara en kommaavgränsad lista. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds.

Standardsäkerhet
default_security string

Anger standardnivån för säkerhetsåtkomst.

Description
description string

Anger den text som ska matchas i beskrivningsfältet. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) stöds. Partiella matchningar stöds inte.

Eko
echo boolean

Anger om dokument i den här klassen kan upprepa dokument.

HIPAA
hipaa boolean

Anger om dokument i den här klassen använder HIPAA-kompatibel kryptering.

Indexerbara
indexable boolean

Anger om dokument i den här klassen indexeras av systemets fulltextindexerare.

Query
query string

Anger den text som ska matchas med ID- eller beskrivningsfälten. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds.

Underklass krävs
subclass_required boolean

Anger om klassen har en obligatorisk underklass.

Returnerar

Namn Stig Typ Beskrivning
Toppmatchningsklass-ID
data.topMatchingId string

Anger ID för den högsta matchande klassen. Till exempel "PETITION".

Beskrivning av toppmatchningsklass
data.topMatchingDescription string

Anger beskrivningen av den högsta matchande klassen.

results
data.results array of object

Anger listan över klasser som är tillgängliga i ett bibliotek som matchar de angivna kriterierna.

Description
data.results.description string

Anger ytterligare information om klassen.

Är HIPAA
data.results.hipaa boolean

Anger om dokumentet är krypterat.

ID-nummer
data.results.id string

Anger klassens ID. Till exempel "PETITION".

Är indexerbar
data.results.indexable boolean

Anger om dokumentet indexeras av systemet.

Standardsäkerhet
data.results.default_security string

Anger standardnivån för säkerhetsåtkomst. Möjliga värden är "public", "view", "private".

Retain
data.results.retain integer

Anger antalet dagar innan inaktiva dokument i den här klassen markeras som utgångna.

Obligatoriska fält
data.results.required_fields array of string

Anger de obligatoriska anpassade egenskaper som ska anges när du skapar eller uppdaterar ett dokument för den här klassen.

Är skuggad
data.results.shadow boolean

Anger om ett dokument i den här klassen skuggas (behålls) på en användares lokala dator när det har checkats in.

Krävs underklass
data.results.subclass_required boolean

Anger om en underklass krävs för den här klassen.

Hämta underklasser

Hämtar alla biblioteksunderklasser som matchar de angivna kriterierna.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Biblioteks-ID
libraryId True string

Anger biblioteks-ID för målunderklassen.

Klass-ID
classId True string

Anger ID för klassen som är överordnad för den här underklassen. Till exempel "PETITION".

Underklass-ID
alias string

Anger ID för underklasser som ska sökas efter. Kan vara en kommaavgränsad lista. Jokertecknet (*) stöds. Partiella matchningar stöds när jokertecknet används.

Standardsäkerhet
default_security string

Anger standardnivån för säkerhetsåtkomst.

Description
description string

Anger den text som ska matchas i beskrivningsfältet. Jokertecknet (*) stöds. Partiella matchningar stöds när jokertecknet används.

Eko
echo boolean

Anger om underklasserna kan upprepas till en användares lokala hårddisk. Detta för att underlätta arbetet offline.

HIPAA
hipaa boolean

Anger om HIPAA-kompatibla underklasser ska returneras.

Query
query string

Anger den text som ska matchas med fälten Underklass-ID eller beskrivning. Jokertecknet (*) stöds. Partiella matchningar stöds.

Returnerar

Namn Stig Typ Beskrivning
Toppmatchande underklass-ID
data.topMatchingId string

Anger ID för den översta matchande underklassen.

Beskrivning av toppmatchande underklass
data.topMatchingDescription string

Anger beskrivning av den översta matchande underklassen.

results
data.results array of object
Standardsäkerhet
data.results.default_security string

Anger standardnivå för säkerhetsåtkomst. Möjliga värden är "public", "view", "private".

Description
data.results.description string

Anger ytterligare information om underklassen. Maximal längd är 255 tecken.

Är HIPAA
data.results.hipaa boolean

Anger om dokumentet är krypterat.

ID-nummer
data.results.id string

Anger ID:t för en underklass som används för att skapa eller ändra dokumentprofilinformationen. Till exempel "FÖRMYNDARSKAP".

Överordnat ID
data.results.parent.id string

Anger det överordnade klass-ID:t för underklassen.

Obligatoriska fält
data.results.required_fields array of string

Anger de obligatoriska anpassade egenskaper som ska anges när du skapar eller uppdaterar ett dokument i den här underklassen.

Retain
data.results.retain integer

Anger antalet dagar innan inaktiva dokument i den här underklassen markeras som utgångna.

Är skuggad
data.results.shadow boolean

Anger om ett dokument i den här underklassen skuggas (behålls) på en användares lokala dator när det har checkats in.

Kopiera behörigheter

Kopierar åtkomstbehörigheterna, och eventuellt standardsäkerheten, från ett iManage Work-objekt till ett annat. "Kopieringstyp" ger dig alternativ för hur du hanterar kombinationen av käll- och målbehörigheter. "Skriv över" uppdaterar målobjektets användare, grupper och behörighetsnivåer för att exakt matcha källobjektets. "Sammanfogning" behåller alla användare och grupper på målobjektet och kombinerar dem med källan, men i händelse av en konflikt på behörighetsnivå på en individ eller grupp: "Sammanslagning (pessimistisk)" tar den lägre behörigheten, medan "Merge (Optimistic)" tar den högre behörigheten för den konfliktande användaren eller gruppen.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Typ av källobjekt
sourceObjectType True string

Anger källobjektets typ.

Källobjekt-ID
sourceObjectId True string

Anger ID för objektet som behörigheterna kopieras från. Ett exempel på ett dokument-ID är "ACTIVE_US!453.1". Ett exempel på en mapp eller ett arbetsyte-ID är "ACTIVE_US!123".

Målobjekttyp
targetObjectType True string

Anger typ av målobjekt.

Målobjekt-ID
targetObjectId True string

Anger ID för det objekt som behörigheterna kopieras till. Ett exempel på ett dokument-ID är "ACTIVE_US!453.1". Ett exempel på en mapp eller ett arbetsyte-ID är "ACTIVE_US!123".

Kopieringstyp
copyType True string

Anger att källobjektbehörigheterna ska sammanfogas med målobjektbehörigheter eller skriva över målobjektbehörigheter med källbehörigheter. Mer information finns i åtgärdsbeskrivningen.

Kopiera standardsäkerhet
copyDefaultSecurity True boolean

Anger att standardsäkerheten för källobjektet ska kopieras till målobjektet. Om standardsäkerheten för källobjektet är "ärver" kopieras den ärvda standardsäkerheten från källan till målobjektet.

Returnerar

Kopiera dokument

Kopierar ett dokument till den angivna mappen.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Dokument-ID
documentId True string

Anger dokumentets ID. Till exempel "ACTIVE_US!453.1".

Målmapps-ID
folderId True string

Anger målmappens ID som dokumentet ska kopieras till. Till exempel "ACTIVE_US!987".

Returnerar

Namn Stig Typ Beskrivning
Dokumentåtkomst
data.access string

Anger behörighetsuppsättningen på åtkomstnivå för ett dokument eller en container. Åtkomstnivån anges av författaren eller en användare med fullständig åtkomst till objektet. Möjliga värden är "no_access", "read", "read_write", "full_access".

Alias
data.alias string

Anger aliaset för det här dokumentet.

Author
data.author string

Anger ID för användaren som skapade dokumentet. Till exempel "JSMITH".

Beskrivning av författare
data.author_description string

Anger ytterligare information om dokumentets författare.

Kubikcentimeter
data.cc string

Anger mottagare som e-postmeddelandet kopieras till. Gäller endast för e-postmeddelanden.

Dokumentklass
data.class string

Anger dokumentets klass.

Beskrivning av dokumentklass
data.class_description string

Anger ytterligare information om dokumentklassen.

Innehållstyp
data.content_type string

Anger dokumentinnehållstypen.

Datum för skapande av dokument
data.create_date string

Anger datum och tid (i ISO 8601-format) som dokumentet importerades till iManage Work-systemet. Det här datumet kan skilja sig från "file_create_date".

Databas
data.database string

Anger biblioteket där dokumentet lagras.

Standardsäkerhet för dokument
data.default_security string

Anger standardnivån för säkerhetsåtkomst. Möjliga värden är "ärver", "privat", "view", "public".

Dokumentnummer
data.document_number integer

Anger dokumentnumret för ett dokument.

Dokument-URL
data.document_url string

Anger den delningsbara länken för dokumentet.

Dokumentredigeringsdatum
data.edit_date string

Anger datum och tid (i ISO 8601-format) för den senaste ändringen av dokumentet.

Datum för profilredigering
data.edit_profile_date string

Anger datum och tid (i ISO 8601-format) för den senaste ändringen av dokumentprofilen.

Dokumenttillägg
data.extension string

Anger filnamnstillägget, även kallat programtillägget, för dokumentet.

Datum då filen skapades
data.file_create_date string

Anger datum och tid (i ISO 8601-format) som filen skapades. Filen kan ha skapats utanför iManage Work-systemet. Det här datumet kan skilja sig från "create_date".

Filredigeringsdatum
data.file_edit_date string

Anger datum och tid (i ISO 8601-format) för den senaste ändringen av filen. Filen kan ha ändrats innan den laddades upp till iManage Work-systemet.

Från
data.from string

Anger avsändaren av e-postmeddelandet. Gäller endast för e-postmeddelanden.

Fullständigt filnamn
data.full_file_name string

Anger dokumentets fullständiga filnamn. Innehåller filnamnstillägget.

Har bifogad fil
data.has_attachment boolean

Anger om e-post har bifogade filer. Gäller endast för e-postmeddelanden.

Grundläggande dokumentegenskaper
data.basic_properties string

Anger ett inbäddningsbart element som innehåller grundläggande dokumentegenskaper.

Dokument-ID
data.id string

Anger dokumentets ID. Till exempel "ACTIVE_US!453.1".

Är indexerbar
data.indexable boolean

Anger om dokumentet indexeras av systemet.

Är utcheckad
data.is_checked_out boolean

Anger om dokumentet är utcheckat.

Deklareras
data.is_declared boolean

Anger om dokumentet deklareras som en post. Ett dokument som deklareras som en post kan inte redigeras eller tas bort, förutom av en systemadministratör för iManage Work.

Är extern
data.is_external boolean

Anger om dokumentet delas med externa användare.

Är externt som vanligt
data.is_external_as_normal boolean

Anger om dokumentet är externt som vanligt.

Är HIPAA
data.is_hipaa boolean

Anger om dokumentet är krypterat.

Används
data.is_in_use boolean

Anger om dokumentet används.

Dokumentlänk
data.iwl string

Anger iManage Work Link (iWL) för dokumentet. iWL används för att öppna dokumentet i läget Skyddad vy av användaren som har "read_write" eller "full_access".

Senaste användare
data.last_user string

Anger ID för den användare som senast redigerade dokumentet. Till exempel "JSMITH".

Beskrivning av senaste användare
data.last_user_description string

Anger ytterligare information om den senaste användaren som senast redigerade dokumentet.

Dokumentnamn
data.name string

Anger dokumentets filnamn.

Operator
data.operator string

Anger ID för den användare som har dokumentet utcheckat eller för närvarande redigerar sin profil. Till exempel "JSMITH".

Beskrivning av operator
data.operator_description string

Anger ytterligare information om operatorn.

Mottaget datum
data.received_date string

Anger datum och tid (i ISO 8601-format) som e-postmeddelandet togs emot. Gäller endast för e-postmeddelanden.

Behålla dagar
data.retain_days integer

Anger antalet dagar innan dokumentet är berättigat till arkivering. Gäller endast för inaktiva dokument.

Skickat datum
data.sent_date string

Anger datum och tid (i ISO 8601-format) som e-postmeddelandet skickades. Gäller endast för e-postmeddelanden.

Dokumentstorlek
data.size integer

Anger dokumentets storlek i byte.

Underklass
data.subclass string

Anger underklassen för dokumentet.

Beskrivning av underklass
data.subclass_description string

Anger ytterligare information om dokumentets underklass.

Till
data.to string

Anger mottagaren av e-postmeddelandet. Gäller endast för e-postmeddelanden.

Typ
data.type string

Anger dokumenttypen. Till exempel WORD för Microsoft Word. Om du vill ha en aktuell lista över typer kontaktar du systemadministratören för iManage Work.

Typbeskrivning
data.type_description string

Anger ytterligare information om dokumentets typ.

Dokumentversion
data.version integer

Anger versionsnumret för dokumentet.

Arbetsplats-ID
data.workspace_id string

Anger ID för dokumentets arbetsyta. Till exempel "ACTIVE_US!427".

Namn på arbetsyta
data.workspace_name string

Anger namnet på dokumentets arbetsyta.

Wstype
data.wstype string

Anger objektets iManage Work-typ. Möjliga värden är "dokument", "mapp", "arbetsyta", "e-post", "document_shortcut", "folder_shortcut", "workspace_shortcut", "användare".

Custom13
data.custom13 string

Anger värdet för custom13.

Custom14
data.custom14 string

Anger värdet för custom14.

Anpassad 15
data.custom15 string

Anger värdet för custom15.

Anpassad 16
data.custom16 string

Anger värdet för custom16.

Custom21
data.custom21 string

Anger värdet för egenskapen custom21 i ISO 8601 datetime-format.

Anpassad 22
data.custom22 string

Anger värdet för egenskapen custom22 i ISO 8601 datetime-format.

Ladda ned dokument

Laddar ned en version av ett visst dokument baserat på dokument-ID:t. Om den senaste är sann laddas den senaste versionen av det här dokumentet ned. Nedladdningen är en dataström och sparas inte lokalt.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Dokument-ID
documentId True string

Anger dokumentets ID. Till exempel "ACTIVE_USE!453.1".

Hämta den senaste versionen
latest boolean

Anger att den senaste versionen av dokumentet ska laddas ned.

Returnerar

Anger innehållet i filen.

Filinnehåll
binary

Ladda upp dokument

Laddar upp en fil som ett nytt dokument till den angivna mappen.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Biblioteks-ID
libraryId True string

Anger ID för målbiblioteket.

Mapp-ID
folderId True string

Anger mapp-ID för målmappen. Till exempel "ACTIVE_US!987".

Ärv mappprofil
inherit_profile_from_folder True boolean

Anger om profildata ärvs från den överordnade mappen.

Behåll låst
keep_locked boolean

Anger om ett dokumentlås sparas efter uppladdningen.

Comment
comment string

Anger ytterligare information om uppdateringen.

Author
author string

Anger iManage Work ID för den användare som skapade dokumentet.

Operator
operator string

Anger ID:t för den användare som har dokumentet utcheckat eller som för närvarande redigerar dokumentets profil. Till exempel "JSMITH".

Class
class string

Anger klassen för att identifiera och särskilja dokumentet. Dokumentklassen kategoriseras efter genre, avdelning, region och så vidare.

Underklass
subclass string

Anger underklassen för att identifiera och särskilja dokumentet. Dokumentunderklass kategoriseras efter genre, avdelning, region och så vidare.

Standardsäkerhet
default_security string

Anger standardnivån för säkerhetsåtkomst. Möjliga värden är "ärver", "privat", "view", "public".

Är HIPAA
is_hipaa boolean

Anger om dokumentet ska krypteras.

Behålla dagar
retain_days integer

Anger hur många dagar ett dokument måste vara inaktivt innan det markeras för arkivering.

Filinnehåll
file True file

Anger innehållet i filen.

Datum då filen skapades
file_create_date date-time

Anger datum och tid (i ISO 8601-format) som filen skapades. Filen kunde ha skapats utanför iManage Work-systemet. Det här datumet kan skilja sig från "create_date". Create_date är det datum då filen skapades eller importerades av iManage Work-systemet.

Filredigeringsdatum
file_edit_date date-time

Anger datum och tid (i ISO 8601-format) för den senaste ändringen av filen. Filen kunde ha ändrats innan den laddades upp till iManage Work-systemet.

Anpassad1
custom1 string

Anger värdet för custom1.

Anpassad 2
custom2 string

Anger värdet för custom2. Om du vill ange ett värde för custom2 måste du också ange ett värde för custom1 i samma begäran, vilket beror på relationen mellan överordnad och underordnad.

Anpassad 3
custom3 string

Anger värdet för custom3.

Anpassad 4
custom4 string

Anger värdet för custom4.

Anpassad 5
custom5 string

Anger värdet för custom5.

Anpassad 6
custom6 string

Anger värdet för custom6.

Anpassad 7
custom7 string

Anger värdet för custom7.

Anpassad8
custom8 string

Anger värdet för custom8.

Anpassad9
custom9 string

Anger värdet för custom9.

Custom10
custom10 string

Anger värdet för custom10.

Custom11
custom11 string

Anger värdet för custom11.

Custom12
custom12 string

Anger värdet för custom12.

Custom13
custom13 string

Anger värdet för custom13.

Custom14
custom14 string

Anger värdet för custom14.

Anpassad 15
custom15 string

Anger värdet för custom15.

Anpassad 16
custom16 string

Anger värdet för custom16.

Anpassad 17
custom17 double

Anger värdet för custom17.

Anpassad 18
custom18 double

Anger värdet för custom18.

Anpassad 19
custom19 double

Anger värdet för custom19.

Custom20
custom20 double

Anger värdet för custom20.

Custom21
custom21 string

Anger värdet för custom21 i ISO 8601 datetime-format.

Anpassad 22
custom22 string

Anger värdet för custom22 i ISO 8601 datetime-format.

Anpassad 23
custom23 string

Anger värdet för custom23 i ISO 8601 datetime-format.

Anpassad 24
custom24 string

Anger värdet för custom24 i ISO 8601 datetime-format.

Anpassad 25
custom25 boolean

Anger värdet för custom25.

Anpassad 26
custom26 boolean

Anger värdet för custom26.

Anpassad 27
custom27 boolean

Anger värdet för custom27.

Anpassad 28
custom28 boolean

Anger värdet för custom28.

Anpassad 29
custom29 string

Anger värdet för custom29.

Custom30
custom30 string

Anger värdet för custom30. Om du vill ange ett värde för custom30 måste du också ange ett värde för custom29 i samma begäran, vilket beror på relationen mellan överordnad och underordnad.

Lägg till dokumentreferens

Lägger till dokumentreferens eller dokumentgenväg i en annan mapp.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Dokument-ID
documentId True string

Anger dokumentets ID. Till exempel "ACTIVE_US!453.1".

Mapp-ID
folderId True string

Anger ID för mappen. Till exempel "ACTIVE_US!773".

Returnerar

Namn Stig Typ Beskrivning
Dokumentreferens-ID
data.id string

Anger dokumentreferens och document_shortcut.

Wstype
data.wstype string

Anger objektets iManage Work-typ. Möjliga värden är "dokument", "document_shortcut", "e-post".

Lägg till post för dokumenthistorik

Lägger till en post som en händelse i dokumentets historik.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Dokument-ID
documentId True string

Anger dokumentets ID. Till exempel "ACTIVE_US!453.1".

Activity
activity_code True integer

Anger vilken typ av aktivitet som utförs i dokumentet.

Comments
comments string

Anger eventuell ytterligare information om aktiviteten.

Varaktighet
duration integer

Anger antalet sekunder som användaren har arbetat med dokumentet.

Returnerar

Namn Stig Typ Beskrivning
data
data object

Redigera namn/värde-par

Skapar, uppdaterar eller tar bort namn/värde-paregenskaper för ett dokument, en mapp eller en arbetsyta. Om du vill ta bort ett namn/värde-par anger du värdet för nyckeln till en tom sträng omsluten med enkla eller dubbla citattecken.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Objekttyp
objectType True string

Anger typ av objekt. Möjliga värden är "document", "folder", "workspace".

Objekt-ID
objectId True string

Anger ID för dokumentet, mappen eller arbetsytan. Ett exempel på ett dokument-ID är "ACTIVE_US!453.1". Ett exempel på en mapp eller ett arbetsyte-ID är "ACTIVE_US!123".

Namn/värde-par
nameValuePairs object

Anger det kostnadsfria formulärets namn och värdepar för det här dokumentet.

Skaffa förvaltare

Hämtar en lista över förvaltare med vissa behörigheter för ett dokument, en mapp eller en arbetsyta. En förvaltare kan vara en användare eller grupp.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Objekttyp
objectType True string

Anger typ av objekt.

Objekt-ID
objectId True string

Anger ID för dokumentet, mappen eller arbetsytan. Ett exempel på ett dokument-ID är "ACTIVE_US!453.1". Ett exempel på en mapp eller ett arbetsyte-ID är "ACTIVE_US!123".

Returnerar

Namn Stig Typ Beskrivning
data
data array of object

Anger listan över förvaltare med vissa behörigheter för ett dokument, en mapp eller en arbetsyta. En förvaltare kan vara en användare eller grupp.

Fullständigt namn
data.full_name string

Anger det fullständiga namnet på förvaltaren.

ID-nummer
data.id string

Anger ID:t för förvaltaren. Det kan vara ett grupp-ID eller användar-ID. Till exempel "JSMITH" eller "MARKETING".

SSID
data.ssid string

Anger det unika systemgenererade ID:t för förvaltaren.

Typ
data.type string

Anger vilken typ av entitet som returneras. Möjliga värden är "användare" eller "grupp".

Skapa arbetsyta

Skapar en ny arbetsyta baserat på den valda mallen. En arbetsytemall är en fördefinierad arbetsyta vars struktur kopieras till den nya arbetsytan. Begränsningar för arbetsytemallen tillämpas automatiskt när den nya arbetsytan skapas.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Biblioteks-ID
libraryId True string

Anger biblioteks-ID för målarbetsytan.

Template
templateId True string

Anger den arbetsytemall som ska användas för att skapa arbetsytan och dess underordnade.

Namn
name True string

Anger namnet på arbetsytan.

Skapa underordnade
createChildren True string

Anger att du vill skapa alla mappar (valfritt och obligatoriskt) eller endast de mappar som krävs.

Arbetsytans ägare
owner string

Anger arbetsytans ägare. Du måste vara systemadministratör för iManage Work för att kunna ange ägaren till en arbetsyta.

Standardsäkerhet
default_security string

Anger standardåtkomstnivån. Om den inte anges används standardåtkomstnivån för den valda mallen.

Description
description string

Anger ytterligare information om arbetsytan.

Anpassad1
custom1 string

Anger värdet för custom1 som ska associeras med den nyligen skapade arbetsytan. Det här värdet åsidosätter custom1-värdet för den valda mallarbetsytan, om det finns. Om de underordnade mapparna har en custom1-värdeuppsättning skrivs inte det anpassade1-värdet för dessa underordnade mappar över.

Anpassad 2
custom2 string

Anger värdet för custom2 som ska associeras med den nyligen skapade arbetsytan. Om du vill ange ett värde för custom2 måste du också ange ett värde för custom1 i samma begäran, vilket beror på relationen mellan överordnad och underordnad. Det här värdet åsidosätter det anpassade2-värdet för den valda mallarbetsytan, om det finns. Om de underordnade mapparna har en custom2-värdeuppsättning skrivs inte det anpassade2-värdet för dessa underordnade mappar över.

Anpassad 3
custom3 string

Anger värdet för custom3.

Anpassad 4
custom4 string

Anger värdet för custom4.

Anpassad 5
custom5 string

Anger värdet för custom5.

Anpassad 6
custom6 string

Anger värdet för custom6.

Anpassad 7
custom7 string

Anger värdet för custom7.

Anpassad8
custom8 string

Anger värdet för custom8.

Anpassad9
custom9 string

Anger värdet för custom9.

Custom10
custom10 string

Anger värdet för custom10.

Custom11
custom11 string

Anger värdet för custom11.

Custom12
custom12 string

Anger värdet för custom12.

Custom13
custom13 string

Anger värdet för custom13.

Custom14
custom14 string

Anger värdet för custom14.

Anpassad 15
custom15 string

Anger värdet för custom15.

Anpassad 16
custom16 string

Anger värdet för custom16.

Anpassad 17
custom17 double

Anger värdet för custom17.

Anpassad 18
custom18 double

Anger värdet för custom18.

Anpassad 19
custom19 double

Anger värdet för custom19.

Custom20
custom20 double

Anger värdet för custom20.

Custom21
custom21 string

Anger värdet för custom21 i ISO 8601 datetime-format.

Anpassad 22
custom22 string

Anger värdet för custom22 i ISO 8601 datetime-format.

Anpassad 23
custom23 string

Anger värdet för custom23 i ISO 8601 datetime-format.

Anpassad 24
custom24 string

Anger värdet för custom24 i ISO 8601 datetime-format.

Anpassad 25
custom25 boolean

Anger värdet för custom25.

Anpassad 26
custom26 boolean

Anger värdet för custom26.

Anpassad 27
custom27 boolean

Anger värdet för custom27.

Anpassad 28
custom28 boolean

Anger värdet för custom28.

Anpassad 29
custom29 string

Anger värdet för custom29.

Custom30
custom30 string

Anger värdet för custom30. Om du vill ange ett värde för custom30 måste du också ange ett värde för custom29 i samma begäran, vilket beror på relationen mellan överordnad och underordnad.

Är externt som vanligt
is_external_as_normal boolean

Anger att arbetsytan kan behandlas som en offentlig arbetsyta. Om värdet är "true" och "default_security" inte är "privat" anger "is_external" till "true".

Project Custom1
project_custom1 string

Anger ytterligare information om arbetsytan. Det här fältet skiljer sig från det anpassade metadatafältet som är associerat med innehållsobjekt, till exempel dokument, arbetsytor eller mappar. Det här är beskrivande text som inte behöver formateras och som inte verifieras.

Project Custom2
project_custom2 string

Anger ytterligare information om arbetsytan. Det här fältet skiljer sig från det anpassade metadatafältet som är associerat med innehållsobjekt, till exempel dokument, arbetsytor eller mappar. Det här är beskrivande text som inte behöver formateras och som inte verifieras.

Project Custom3
project_custom3 string

Anger ytterligare information om arbetsytan. Det här fältet skiljer sig från det anpassade metadatafältet som är associerat med innehållsobjekt, till exempel dokument, arbetsytor eller mappar. Det här är beskrivande text som inte behöver formateras och som inte verifieras.

Underklass för arbetsyta
subclass string

Anger underklassen för arbetsytan baserat på underklassen för det dokument som den innehåller.

Skapa dokumentrelation

Skapar en relation mellan angivna dokument i ett bibliotek.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Primärt dokument-ID
primaryDocumentId True string

Anger ID för det primära dokument som ska relateras. Till exempel "ACTIVE_US!453.1".

Relaterat dokument-ID
relatedDocumentId True string

Anger ID för dokumentet som ska relateras. Till exempel "ACTIVE_US!453.1".

Returnerar

response
object

Sök användare

Söker efter iManage Work-användare som matchar de angivna sökvillkoren.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
E-post-ID
email string

Anger det e-post-ID som ska sökas efter. Till exempel "JSMITH@XYZ.COM".

Returnerar

Namn Stig Typ Beskrivning
Tillåt inloggning
data.topMatchingUser.allow_logon boolean

Anger om användaren får logga in.

Anpassad1
data.topMatchingUser.custom1 string

Anger ytterligare information om användaren.

Anpassad 2
data.topMatchingUser.custom2 string

Anger ytterligare information om användaren.

Anpassad 3
data.topMatchingUser.custom3 string

Anger ytterligare information om användaren.

Katalog-ID
data.topMatchingUser.directory_id string

Anger ID:t från en extern katalog (till exempel ADFS), som används för synkronisering av användarprofiler.

Unikt namn
data.topMatchingUser.distinguished_name string

Anger namnet på objektet som representerar den fullständigt kvalificerade sökvägen för namn som spårar posten tillbaka till roten i LDAP-trädet.

Redigera datum
data.topMatchingUser.edit_date string

Anger datum och tid (i ISO 8601-format) för den senaste ändringen av användarprofilen.

E-postmeddelande
data.topMatchingUser.email string

Anger användarens e-post-ID.

Automatisk identifierings-URL för Exchange
data.topMatchingUser.exch_autodiscover string

Anger exchange-serverinformationen för användaren.

Extension
data.topMatchingUser.extension string

Anger användarens telefonnummertillägg.

Misslyckade inloggningsförsök
data.topMatchingUser.failed_logins integer

Anger det aktuella antalet misslyckade inloggningsförsök för användaren.

Faxmaskin
data.topMatchingUser.fax string

Anger användarens faxnummer.

Framtvinga lösenordsändring
data.topMatchingUser.force_password_change boolean

Anger att användaren måste ändra sitt lösenord vid nästa inloggning. Gäller endast för virtuella användare, vilket anges med värdet "user_nos" "2".

Fullständigt namn
data.topMatchingUser.full_name string

Anger användarens fullständiga namn.

General
data.topMatchingUser.general string

Anger allmän information om användaren.

ID-nummer
data.topMatchingUser.id string

Anger användarens ID. Till exempel "JSMITH".

Är extern
data.topMatchingUser.is_external boolean

Anger en extern användare. En extern användare har begränsad åtkomst och används ofta för tillfälliga teammedlemmar, konsulter eller externa användare i organisationen.

Senaste synkroniseringstid
data.topMatchingUser.last_sync_ts string

Anger den senaste synkroniseringstiden (i ISO 8601 datetime-format) för användarens profil med en extern katalog, till exempel LDAP eller Microsoft Active Directory (ADFS).

Plats
data.topMatchingUser.location string

Anger användarens geografiska plats.

Lösenordet upphör aldrig att gälla
data.topMatchingUser.password_never_expire boolean

Anger om användarens lösenord aldrig upphör att gälla.

Telefonnummer
data.topMatchingUser.phone string

Anger användarens telefonnummer.

Föredraget bibliotek
data.topMatchingUser.preferred_library string

Anger önskat bibliotek. Ett föredraget bibliotek är användarens standardbibliotek. Varje användare måste ha ett föredraget bibliotek.

Ändrad tid för lösenord
data.topMatchingUser.pwd_changed_ts string

Anger tiden (i ISO 8601 datetime-format) när användarens lösenord senast ändrades. Detta gäller endast för virtuella användare (vars användar-NOS är 2).

SSID
data.topMatchingUser.ssid string

Anger det unika systemgenererade ID:t för användaren.

Domän
data.topMatchingUser.user_domain string

Anger det fullständigt kvalificerade domännamnet för användarens katalogtjänst.

Utökat ID
data.topMatchingUser.user_id_ex string

Anger det ursprungliga värdet för användar-ID:t som tas emot från en extern katalog, till exempel Microsoft Active Directory (ADFS).

NOS
data.topMatchingUser.user_nos integer

Anger vilken typ av operativsystem som användaren synkroniseras från. Möjliga värden är 2 (virtuell användare) och 6 (Enterprise-användare). Kontakta systemadministratören för iManage Work om du vill ha mer information.

Nummer
data.topMatchingUser.user_num integer

Anger användarens numeriska system-ID.

results
data.results array of UserProfileInArray

Sök efter arbetsytor

Sök efter arbetsytor.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Biblioteks-ID
libraryId True string

Anger biblioteks-ID för målarbetsytan.

Titel
name string

Anger strängen som ska sökas efter i arbetsytans namnegenskap. Den här sökningen är inte skiftlägeskänslig.

Ägare
owner string

Anger strängen som ska matchas med den ägare som är associerad med arbetsytan. Den här sökningen är inte skiftlägeskänslig.

Keyword
anywhere string

Anger den text som ska sökas efter var som helst i arbetsyteprofilen. Den här sökningen är inte skiftlägeskänslig.

Description
description string

Anger den text som ska sökas efter i arbetsytans beskrivningsegenskap. Den här sökningen är inte skiftlägeskänslig.

Underklass
subclass string

Anger ett värde som ska matchas med underklassvärdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig.

Anpassad1
custom1 string

Anger ett värde som ska matchas med custom1-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad 2
custom2 string

Anger ett värde som ska matchas med custom2-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad 3
custom3 string

Anger ett värde som ska matchas med custom3-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad 4
custom4 string

Anger ett värde som ska matchas med custom4-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad 5
custom5 string

Anger ett värde som ska matchas med custom5-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad 6
custom6 string

Anger ett värde som ska matchas med custom6-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad 7
custom7 string

Anger ett värde som ska matchas med det anpassade7-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad8
custom8 string

Anger ett värde som ska matchas med custom8-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad9
custom9 string

Anger ett värde som ska matchas med det anpassade9-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Custom10
custom10 string

Anger ett värde som ska matchas med custom10-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Custom11
custom11 string

Anger ett värde som ska matchas med custom11-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Custom12
custom12 string

Anger ett värde som ska matchas med custom12-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Custom13
custom13 string

Anger ett värde som ska matchas med custom13-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds.

Custom14
custom14 string

Anger ett värde som ska matchas med custom14-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds.

Anpassad 15
custom15 string

Anger ett värde som ska matchas med custom15-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds.

Anpassad 16
custom16 string

Anger ett värde som ska matchas med custom16-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds.

Anpassad 17
custom17 string

Anger ett värde som ska matchas med custom17-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad 18
custom18 string

Anger ett värde som ska matchas med custom18-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Anpassad 19
custom19 string

Anger ett värde som ska matchas med custom19-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Custom20
custom20 string

Anger ett värde som ska matchas med custom20-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Custom21 (lägre gräns)
custom21_from string

Anger den lägre gränsen (i ISO 8601 datetime-format) att söka efter i egenskapen custom21 som är associerad med arbetsytan. Den här sökningen är inte skiftlägeskänslig. För arbetsytor anpassas användningen av den här egenskapen för din iManage Work-installation.

Custom21 (övre gräns)
custom21_to string

Anger den övre gränsen (i ISO 8601 datetime-format) att söka efter i egenskapen custom21 som är associerad med arbetsytan. Den här sökningen är inte skiftlägeskänslig. För arbetsytor anpassas användningen av den här egenskapen för din iManage Work-installation.

Custom22 (lägre gräns)
custom22_from string

Anger den lägre gränsen (i ISO 8601 datetime-format) att söka efter i egenskapen custom22 som är associerad med arbetsytan. Den här sökningen är inte skiftlägeskänslig. För arbetsytor anpassas användningen av den här egenskapen för din iManage Work-installation.

Custom22 (övre gräns)
custom22_to string

Anger den övre gränsen (i ISO 8601 datetime-format) att söka efter i egenskapen custom22 som är associerad med arbetsytan. Den här sökningen är inte skiftlägeskänslig. För arbetsytor anpassas användningen av den här egenskapen för din iManage Work-installation.

Custom23 (lägre gräns)
custom23_from string

Anger den lägre gränsen (i ISO 8601 datetime-format) att söka efter i egenskapen custom23 som är associerad med arbetsytan. Den här sökningen är inte skiftlägeskänslig. För arbetsytor anpassas användningen av den här egenskapen för din iManage Work-installation.

Custom23 (övre gräns)
custom23_to string

Anger den övre gränsen (i ISO 8601 datetime-format) att söka efter i egenskapen custom23 som är associerad med arbetsytan. Den här sökningen är inte skiftlägeskänslig. För arbetsytor anpassas användningen av den här egenskapen för din iManage Work-installation.

Custom24 (lägre gräns)
custom24_from string

Anger den lägre gränsen (i ISO 8601 datetime-format) att söka efter i egenskapen custom24 som är associerad med arbetsytan. Den här sökningen är inte skiftlägeskänslig. För arbetsytor anpassas användningen av den här egenskapen för din iManage Work-installation.

Custom24 (övre gräns)
custom24_to string

Anger den övre gränsen (i ISO 8601 datetime-format) att söka efter i egenskapen custom24 som är associerad med arbetsytan. Den här sökningen är inte skiftlägeskänslig. För arbetsytor anpassas användningen av den här egenskapen för din iManage Work-installation.

Anpassad 25
custom25 boolean

Anger ett värde som ska matchas med custom25-värdet som är associerat med arbetsytan.

Anpassad 26
custom26 boolean

Anger ett värde som ska matchas med custom26-värdet som är associerat med arbetsytan.

Anpassad 27
custom27 boolean

Anger ett värde som ska matchas med custom27-värdet som är associerat med arbetsytan.

Anpassad 28
custom28 boolean

Anger ett värde som ska matchas med custom28-värdet som är associerat med arbetsytan.

Anpassad 29
custom29 string

Anger ett värde som ska matchas med custom29-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte.

Custom30
custom30 string

Anger ett värde som ska matchas med custom30-värdet som är associerat med arbetsytan. Den här sökningen är inte skiftlägeskänslig. Jokertecknet (*) och partiella matchningar stöds inte. Om du vill ange ett värde för custom30 måste du också ange ett värde för custom29 i samma begäran, vilket beror på relationen mellan överordnad och underordnad.

Sök efter mappar

Sök efter mappar.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Biblioteks-ID
libraryId True string

Anger biblioteks-ID för målmappen.

Container-ID
container_id string

Anger ID för arbetsytan eller mappen som mappar ska returneras från. Till exempel "ACTIVE_US!987". Om den här parametern anges returnerar den endast mappar från den angivna arbetsytan eller mappen.

Mappbeskrivning
description string

Anger ett värde som ska hittas i beskrivningsegenskapen för mappen. Den här sökningen är inte skiftlägeskänslig. Partiella matchningar stöds.

E-postadress för mapp
email string

Anger den e-postadress som ska matchas med mappens e-postadress. Till exempel "email1234@ajubalaw.com".

Mappnamn
name string

Anger ett värde som ska hittas i namnegenskapen för mappen. Den här sökningen är inte skiftlägeskänslig. Partiella matchningar stöds.

Mappägare
owner string

Anger strängen som ska matchas med den ägare som är associerad med mappen. Den här sökningen är inte skiftlägeskänslig. Partiella matchningar stöds.

Namn på arbetsyta
workspace_name string

Anger namnet på den överordnade arbetsyta som mappen tillhör. Den här sökningen är inte skiftlägeskänslig. Partiella matchningar stöds.

Sök igenom utökade metadatataxonominodvärden för sökkärnor

Söker efter grundläggande utökade metadatataxonominodvärden som matchar de angivna sökvillkoren.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Biblioteks-ID
libraryId True string

Anger ID för biblioteket som sökningen ska utföras på.

Taxonomiegenskap
taxonomyProperty True string

Anger den taxonomiegenskap som du vill söka efter nodvärden för.

ID-nummer
id string

Anger visningsidentifieraren för taxonominodvärdet. Den här sökningen är inte skiftlägeskänslig. Partiella matchningar stöds inte.

Query
query string

Anger en fråga för matchande taxonominodvärden med hjälp av en jokerteckensökning (*) som ger partiella matchningar för visningsidentifieraren eller beskrivningen.

Nodtillstånd
enabled_state string

Anger att endast taxonominodvärden som är aktiverade eller inaktiverade eller båda ska returneras.

Inkludera sökväg
include_path boolean

Anger att den fullständiga sökvägen ska returneras till det matchande nodvärdet. En sökväg är en ordnad lista som börjar med noden på den översta nivån i taxonomi och sedan alla noder till den matchande nodens överordnade nod.

SSID för överordnad nod
children_of_ssid string

Anger det unika systemgenererade ID:t för den överordnade taxonominoden som sökningen ska begränsas till.

Endast omedelbara barn
immediate_children_only boolean

Anger att begränsa sökresultaten till att dirigera underordnade till den taxonominod som anges av "Ancestor Node SSID". Sökningen kan begränsas till rotnivån för taxonomi genom att ange en tom sträng för "Ancestor Node SSID" omsluten med enkla eller dubbla citattecken.

Returnerar

Namn Stig Typ Beskrivning
SSID
data.topMatchingResult.created_by.ssid string

Anger det unika systemgenererade ID:t för den användare som skapade det högsta matchande nodvärdet.

Skapa datum
data.topMatchingResult.create_date string

Anger datum och tid (i ISO 8601-format) som det översta matchande nodvärdet skapades.

Description
data.topMatchingResult.description string

Anger beskrivningen av det högsta matchande nodvärdet.

SSID
data.topMatchingResult.edited_by.ssid string

Anger det unika systemgenererade ID:t för den användare som senast redigerade det översta matchande nodvärdet.

Redigera datum
data.topMatchingResult.edit_date string

Anger datum och tid (i ISO 8601-format) som det översta matchande nodvärdet senast redigerades.

Är aktiverad
data.topMatchingResult.enabled boolean

Anger om det högsta matchande nodvärdet är aktiverat.

ID-nummer
data.topMatchingResult.id string

Anger visningsidentifieraren för det högsta matchande nodvärdet.

SSID
data.topMatchingResult.parent.ssid string

Anger det unika systemgenererade ID:t för den omedelbara överordnade noden för det högsta matchande nodvärdet.

SSID
data.topMatchingResult.ssid string

Anger det unika systemgenererade ID:t för det högsta matchande nodvärdet.

Väg
data.topMatchingResult.path array of object

Anger den fullständiga sökvägen till det högsta matchande nodvärdet. En sökväg är en ordnad lista som börjar med noden på den översta nivån i taxonomi och sedan alla noder till den matchande nodens överordnade nod.

Varje ID
data.topMatchingResult.path.id string

Anger visningsidentifieraren för ett nodvärde i sökvägen till den översta matchande noden.

Varje SSID
data.topMatchingResult.path.ssid string

Anger det unika systemgenererade ID:t för ett nodvärde i sökvägen till den översta matchande noden.

Core Extended Metadata Taxonomy Search Results
data.results array of TaxonomyNodeValue

Anger en eller flera grundläggande utökade metadatataxonominodvärden som matchar sökningen.

Alla SSID:erna för taxonominoder
data.all_taxonomy_ssids string

Anger en lista över alla SSID:er för taxonominoder, sammanfogade som en sträng och avgränsade med semikolon.

Ta bort dokument

Tar bort det angivna dokumentet.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Dokument-ID
documentId True string

Anger dokumentets ID. Till exempel "ACTIVE_US!453.1".

Ta bort alla versioner
deleteAllVersions True boolean

Anger att alla versioner av dokumentet ska tas bort.

Ta bort dokumentreferens

Tar bort dokumentreferensen från den angivna mappen.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Dokument-ID
documentId True string

Anger dokumentets ID. Till exempel "ACTIVE_US!453.1".

Mapp-ID
folderId True string

Anger ID för mappen. Till exempel "ACTIVE_US!773".

Returnerar

response
object

Ta bort dokumentrelation

Tar bort en relation mellan angivna dokument i ett bibliotek.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Primärt dokument-ID
primaryDocumentId True string

Anger ID för det primära dokumentet. Till exempel "ACTIVE_US!453.1".

Relaterat dokument-ID
relatedDocumentId True string

Anger ID för det relaterade dokumentet. Till exempel "ACTIVE_US!453.1".

Returnerar

response
object

Uppdatera aktuell eller skapa ny dokumentversion

Uppdaterar den angivna versionen av ett dokument eller skapar en ny version. Den här åtgärden kan uppdatera profilen och innehållet i ett dokument. Om alternativet Uppdatera aktuell version har angetts ersätts dokumentet med ett nytt och profilen för det tidigare dokumentet bibehålls. Om "Skapa ny version" har angetts skapas en ny version av dokumentet som ärver mappens profil. När åtgärden har körts returneras dokumentprofilen.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Uppdatera eller skapa ny version
updateOrCreate True string

Anger att den aktuella versionen av dokumentet ska uppdateras eller att en ny version ska skapas.

Befintligt dokument-ID
documentId True string

Anger ID för det befintliga dokumentet. Till exempel "ACTIVE_US!556.1".

Behåll låst
keep_locked boolean

Anger om ett dokumentlås sparas efter uppladdningen.

Comment
comment string

Anger ytterligare information om uppdateringen.

Dokumentnamn
name string

Anger namnet på dokumentet.

Author
author string

Anger iManage Work ID för den användare som skapade dokumentet.

Operator
operator string

Anger ID:t för den användare som har dokumentet utcheckat eller som för närvarande redigerar dokumentets profil. Till exempel "JSMITH".

Class
class string

Anger klassen för att identifiera och särskilja dokumentet. Dokumentklassen kategoriseras efter genre, avdelning, region och så vidare.

Underklass
subclass string

Anger underklassen för att identifiera och särskilja dokumentet. Dokumentunderklass kategoriseras efter genre, avdelning, region och så vidare.

Standardsäkerhet
default_security string

Anger standardnivån för säkerhetsåtkomst. Möjliga värden är "ärver", "privat", "view", "public".

Är HIPAA
is_hipaa boolean

Anger om dokumentet ska krypteras.

Behålla dagar
retain_days integer

Anger hur många dagar ett dokument måste vara inaktivt innan det markeras för arkivering.

Filinnehåll
file True file

Anger innehållet i filen.

Datum då filen skapades
file_create_date date-time

Anger datum och tid (i ISO 8601-format) som filen skapades. Filen kunde ha skapats utanför iManage Work-systemet. Det här datumet kan skilja sig från "create_date". Create_date är det datum då filen skapades eller importerades av iManage Work-systemet.

Filredigeringsdatum
file_edit_date date-time

Anger datum och tid (i ISO 8601-format) för den senaste ändringen av filen. Filen kunde ha ändrats innan den laddades upp till iManage Work-systemet.

Anpassad1
custom1 string

Anger värdet för custom1.

Anpassad 2
custom2 string

Anger värdet för custom2. Om du vill ange ett värde för custom2 måste du också ange ett värde för custom1 i samma begäran, vilket beror på relationen mellan överordnad och underordnad.

Anpassad 3
custom3 string

Anger värdet för custom3.

Anpassad 4
custom4 string

Anger värdet för custom4.

Anpassad 5
custom5 string

Anger värdet för custom5.

Anpassad 6
custom6 string

Anger värdet för custom6.

Anpassad 7
custom7 string

Anger värdet för custom7.

Anpassad8
custom8 string

Anger värdet för custom8.

Anpassad9
custom9 string

Anger värdet för custom9.

Custom10
custom10 string

Anger värdet för custom10.

Custom11
custom11 string

Anger värdet för custom11.

Custom12
custom12 string

Anger värdet för custom12.

Custom13
custom13 string

Anger värdet för custom13.

Custom14
custom14 string

Anger värdet för custom14.

Anpassad 15
custom15 string

Anger värdet för custom15.

Anpassad 16
custom16 string

Anger värdet för custom16.

Anpassad 17
custom17 double

Anger värdet för custom17.

Anpassad 18
custom18 double

Anger värdet för custom18.

Anpassad 19
custom19 double

Anger värdet för custom19.

Custom20
custom20 double

Anger värdet för custom20.

Custom21
custom21 string

Anger värdet för custom21 i ISO 8601 datetime-format.

Anpassad 22
custom22 string

Anger värdet för custom22 i ISO 8601 datetime-format.

Anpassad 23
custom23 string

Anger värdet för custom23 i ISO 8601 datetime-format.

Anpassad 24
custom24 string

Anger värdet för custom24 i ISO 8601 datetime-format.

Anpassad 25
custom25 boolean

Anger värdet för custom25.

Anpassad 26
custom26 boolean

Anger värdet för custom26.

Anpassad 27
custom27 boolean

Anger värdet för custom27.

Anpassad 28
custom28 boolean

Anger värdet för custom28.

Anpassad 29
custom29 string

Anger värdet för custom29.

Custom30
custom30 string

Anger värdet för custom30. Om du vill ange ett värde för custom30 måste du också ange ett värde för custom29 i samma begäran, vilket beror på relationen mellan överordnad och underordnad.

Uppdatera arbetsflödestillstånd

Uppdaterar tillståndet för en arbetsflödeskörning. Den här åtgärden kan bara användas i ett arbetsflöde som har skapats för att börja med en utlösare som tillhandahålls av iManage.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Biblioteks-ID
libraryId True string

Anger ID för biblioteket som arbetsflödet har definierats för.

Stat/län
state True string

Anger det aktuella tillståndet för arbetsflödeskörningen.

Läge
status string

Anger aktuell status för arbetsflödeskörningen. Maximal längd är 128 tecken.

Statusmeddelande
statusMessage string

Anger det anpassade meddelandet för den aktuella statusen för arbetsflödeskörningen. Maximal längd är 256 tecken.

Returnerar

response
object

Uppdatera arbetsyta

Uppdaterar information om den angivna arbetsytan. Om du vill ta bort det befintliga värdet för ett strängfält anger du värdet för fältet till en tom sträng omsluten med enkla eller dubbla citattecken.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Arbetsplats-ID
id True string

Anger ID för arbetsytan som ska uppdateras. Till exempel "ACTIVE_US!427".

Namn
name string

Anger namnet på arbetsytan.

Arbetsytans ägare
owner string

Anger arbetsytans ägare.

Anpassad1
custom1 string

Anger värdet för custom1.

Anpassad 2
custom2 string

Anger värdet för custom2. Om du vill ange ett värde för custom2 måste du också ange ett värde för custom1 i samma begäran, vilket beror på relationen mellan överordnad och underordnad.

Anpassad 3
custom3 string

Anger värdet för custom3.

Anpassad 4
custom4 string

Anger värdet för custom4.

Anpassad 5
custom5 string

Anger värdet för custom5.

Anpassad 6
custom6 string

Anger värdet för custom6.

Anpassad 7
custom7 string

Anger värdet för custom7.

Anpassad8
custom8 string

Anger värdet för custom8.

Anpassad9
custom9 string

Anger värdet för custom9.

Custom10
custom10 string

Anger värdet för custom10.

Custom11
custom11 string

Anger värdet för custom11.

Custom12
custom12 string

Anger värdet för custom12.

Custom13
custom13 string

Anger värdet för custom13.

Custom14
custom14 string

Anger värdet för custom14.

Anpassad 15
custom15 string

Anger värdet för custom15.

Anpassad 16
custom16 string

Anger värdet för custom16.

Anpassad 17
custom17 double

Anger värdet för custom17.

Anpassad 18
custom18 double

Anger värdet för custom18.

Anpassad 19
custom19 double

Anger värdet för custom19.

Custom20
custom20 double

Anger värdet för custom20.

Custom21
custom21 string

Anger värdet för custom21 i ISO 8601 datetime-format.

Anpassad 22
custom22 string

Anger värdet för custom22 i ISO 8601 datetime-format.

Anpassad 23
custom23 string

Anger värdet för custom23 i ISO 8601 datetime-format.

Anpassad 24
custom24 string

Anger värdet för custom24 i ISO 8601 datetime-format.

Anpassad 25
custom25 boolean

Anger värdet för custom25.

Anpassad 26
custom26 boolean

Anger värdet för custom26.

Anpassad 27
custom27 boolean

Anger värdet för custom27.

Anpassad 28
custom28 boolean

Anger värdet för custom28.

Anpassad 29
custom29 string

Anger värdet för custom29.

Custom30
custom30 string

Anger värdet för custom30. Om du vill ange ett värde för custom30 måste du också ange ett värde för custom29 i samma begäran, vilket beror på relationen mellan överordnad och underordnad.

Standardsäkerhet
default_security string

Anger standardnivån för säkerhetsåtkomst.

Description
description string

Anger ytterligare information om arbetsytan.

Är externt som vanligt
is_external_as_normal boolean

Anger om arbetsytan kan behandlas som en offentlig arbetsyta. Om värdet är "true" och "default_security" inte är "privat" anges "is_external" till "true".

Project Custom1
project_custom1 string

Anger ytterligare information om arbetsytan. Det här fältet skiljer sig från det anpassade metadatafältet som är associerat med innehållsobjekt, till exempel dokument, arbetsytor eller mappar. Det här är beskrivande text som inte behöver formateras och som inte verifieras.

Project Custom2
project_custom2 string

Anger ytterligare information om arbetsytan. Det här fältet skiljer sig från det anpassade metadatafältet som är associerat med innehållsobjekt, till exempel dokument, arbetsytor eller mappar. Det här är beskrivande text som inte behöver formateras och som inte verifieras.

Project Custom3
project_custom3 string

Anger ytterligare information om arbetsytan. Det här fältet skiljer sig från det anpassade metadatafältet som är associerat med innehållsobjekt, till exempel dokument, arbetsytor eller mappar. Det här är beskrivande text som inte behöver formateras och som inte verifieras.

Underklass för arbetsyta
subclass string

Anger underklassen för arbetsytan baserat på underklassen för det dokument som den innehåller.

Uppdatera behörigheter

Uppdaterar behörigheter för ett objekt.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Objekttyp
objectType True string

Anger typ av objekt.

Objekt-ID
objectId True string

Anger ID för dokumentet, mappen eller arbetsytan. Ett exempel på ett dokument-ID är "ACTIVE_US!453.1". Ett exempel på en mapp eller ett arbetsyte-ID är "ACTIVE_US!123".

Åtkomstnivå
access_level True string

Anger åtkomstnivå.

Users
users string

Anger att en eller flera användare ska ange åtkomstnivån, avgränsad med ett semikolon.

Groups
groups string

Anger en eller flera grupper för att ange åtkomstnivån, avgränsad med ett semikolon.

Returnerar

Uppdatera dokumentprofil

Uppdaterar dokumentprofilen. Ett dokument får inte användas när profilen uppdateras och det går inte att uppdatera profilen för ett utcheckat dokument. Returnerar en uppdaterad dokumentprofil efter åtgärden.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Alias
alias string

Anger aliaset för det här dokumentet.

Author
author string

Anger ID för användaren som skapade dokumentet. Till exempel "JSMITH".

Comment
comment string

Anger ytterligare information om dokumentet.

Standardsäkerhet för dokument
default_security string

Anger standardnivån för säkerhetsåtkomst.

Dokument-ID
documentId True string

Anger dokumentets ID. Till exempel "ACTIVE_US!453.1".

Deklareras
is_declared boolean

Anger om dokumentet ska deklareras som en post. Ett dokument som deklareras som en post kan inte redigeras eller tas bort, förutom av en systemadministratör för iManage Work.

Är HIPAA
is_hipaa boolean

Anger om dokumentet ska krypteras.

Granskningskommentar
audit_comment string

Anger ytterligare information om uppdateringen av dokumentprofilen.

Dokumentklass
class string

Anger dokumentklassen.

Dokumentnamn
name string

Anger dokumentets filnamn.

Operator
operator string

Anger att ID:t för användaren har utcheckat dokumentet eller redigerar dokumentets profil. Till exempel "JSMITH".

Behålla dagar
retain_days integer

Anger antalet dagar innan det inaktiva dokumentet är berättigat till arkivering.

Underklass
subclass string

Anger dokumentets underklass.

Anpassad1
custom1 string

Anger värdet för custom1.

Anpassad 2
custom2 string

Anger värdet för custom2. Om du vill ange ett värde för custom2 måste du också ange ett värde för custom1 i samma begäran, vilket beror på relationen mellan överordnad och underordnad.

Anpassad 3
custom3 string

Anger värdet för custom3.

Anpassad 4
custom4 string

Anger värdet för custom4.

Anpassad 5
custom5 string

Anger värdet för custom5.

Anpassad 6
custom6 string

Anger värdet för custom6.

Anpassad 7
custom7 string

Anger värdet för custom7.

Anpassad8
custom8 string

Anger värdet för custom8.

Anpassad9
custom9 string

Anger värdet för custom9.

Custom10
custom10 string

Anger värdet för custom10.

Custom11
custom11 string

Anger värdet för custom11.

Custom12
custom12 string

Anger värdet för custom12.

Custom13
custom13 string

Anger värdet för custom13.

Custom14
custom14 string

Anger värdet för custom14.

Anpassad 15
custom15 string

Anger värdet för custom15.

Anpassad 16
custom16 string

Anger värdet för custom16.

Anpassad 17
custom17 double

Anger värdet för custom17.

Anpassad 18
custom18 double

Anger värdet för custom18.

Anpassad 19
custom19 double

Anger värdet för custom19.

Custom20
custom20 double

Anger värdet för custom20.

Custom21
custom21 string

Anger värdet för egenskapen custom21 i ISO 8601 datetime-format.

Anpassad 22
custom22 string

Anger värdet för egenskapen custom22 i ISO 8601 datetime-format.

Anpassad 23
custom23 string

Anger värdet för egenskapen custom23 i ISO 8601 datetime-format.

Anpassad 24
custom24 string

Anger värdet för egenskapen custom24 i ISO 8601 datetime-format.

Anpassad 25
custom25 boolean

Anger värdet för custom25.

Anpassad 26
custom26 boolean

Anger värdet för custom26.

Anpassad 27
custom27 boolean

Anger värdet för custom27.

Anpassad 28
custom28 boolean

Anger värdet för custom28.

Anpassad 29
custom29 string

Anger värdet för custom29.

Custom30
custom30 string

Anger värdet för custom30. Om du vill ange ett värde för custom30 måste du också ange ett värde för custom29 i samma begäran, vilket beror på relationen mellan överordnad och underordnad.

Uppdatera standardsäkerhet

Uppdaterar standardsäkerheten för ett dokument, en mapp eller en arbetsyta.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Objekttyp
objectType True string

Anger typ av objekt.

Objekt-ID
objectId True string

Anger ID för dokumentet, mappen eller arbetsytan. Ett exempel på ett dokument-ID är "ACTIVE_US!453.1". Ett exempel på en mapp eller ett arbetsyte-ID är "ACTIVE_US!123".

Standardsäkerhet
default_security True string

Anger standardsäkerheten för objektet.

Returnerar

Namn Stig Typ Beskrivning
Standardsäkerhet
data.default_security string

Anger standardsäkerheten för objektet. Möjliga värden är "ärver", "offentlig", "vy" eller "privat".

Åtkomstbehörigheter
data.acl AccessPermissions

Anger en samling åtkomstbehörigheter för en eller flera användare och/eller grupper.

Utlösare

För en vald arbetsyta

Med den här utlösaren kan du starta ett arbetsflöde för en vald arbetsyta i ett iManage Work-bibliotek. Ange ett visningsnamn som ska visas för användare i iManage Work-program. Om "Vänta på slutförande" är inställt på "Ja" måste du använda åtgärden Uppdatera arbetsflödestillstånd i arbetsflödet, annars överskrider programmen tidsgränsen utan att ange slutförandetillståndet för användaren.

För ett markerat dokument

Med den här utlösaren kan du starta ett arbetsflöde för ett valt dokument i ett iManage Work-bibliotek. Ange ett visningsnamn som ska visas för användare i iManage Work-program. Om "Vänta på slutförande" är inställt på "Ja" måste du använda åtgärden Uppdatera arbetsflödestillstånd i arbetsflödet, annars överskrider programmen tidsgränsen utan att ange slutförandetillståndet för användaren.

För flera markerade dokument

Med den här utlösaren kan du starta ett arbetsflöde för ett eller flera markerade dokument i iManage Work. Ange ett visningsnamn som ska visas för användare i iManage Work-program. Om "Vänta på slutförande" är inställt på "Ja" måste du använda åtgärden Uppdatera arbetsflödestillstånd i arbetsflödet, annars överskrider programmen tidsgränsen utan att ange slutförandetillståndet för användaren.

För flera valda arbetsytor

Med den här utlösaren kan du starta ett arbetsflöde för en eller flera valda arbetsytor i iManage Work. Ange ett visningsnamn som ska visas för användare i iManage Work-program. Om "Vänta på slutförande" är inställt på "Ja" måste du använda åtgärden Uppdatera arbetsflödestillstånd i arbetsflödet, annars överskrider programmen tidsgränsen utan att ange slutförandetillståndet för användaren.

För en vald arbetsyta

Med den här utlösaren kan du starta ett arbetsflöde för en vald arbetsyta i ett iManage Work-bibliotek. Ange ett visningsnamn som ska visas för användare i iManage Work-program. Om "Vänta på slutförande" är inställt på "Ja" måste du använda åtgärden Uppdatera arbetsflödestillstånd i arbetsflödet, annars överskrider programmen tidsgränsen utan att ange slutförandetillståndet för användaren.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Arbetsflödets visningsnamn
workflowName True string

Anger visningsnamnet för arbetsflödet som ska vara synligt för iManage Work-användare.

Description
description True string

Anger beskrivningen av arbetsflödet.

Biblioteks-ID
libraryId True string

Anger ID för biblioteket där arbetsflödet är tillgängligt.

Formulär-ID
formId True string

Anger ID för formuläret som visas för användaren för att samla in indata som används av arbetsflödet.

Tillgänglig för användare
users string

Anger ett eller flera användar-ID:n, avgränsade med semikolon, som arbetsflödet är tillgängligt för.

Tillgänglig för grupper
groups string

Anger ett eller flera grupp-ID:n, avgränsade med semikolon, som arbetsflödet är tillgängligt för.

Vänta tills det är klart
waitForCompletion boolean

Anger om program väntar tills arbetsflödet har slutfört körningen. Om inställningen är "Ja" måste du använda åtgärden Uppdatera arbetsflödestillstånd.

Returnerar

Utdata från denna operation är dynamiska.

För ett markerat dokument

Med den här utlösaren kan du starta ett arbetsflöde för ett valt dokument i ett iManage Work-bibliotek. Ange ett visningsnamn som ska visas för användare i iManage Work-program. Om "Vänta på slutförande" är inställt på "Ja" måste du använda åtgärden Uppdatera arbetsflödestillstånd i arbetsflödet, annars överskrider programmen tidsgränsen utan att ange slutförandetillståndet för användaren.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Arbetsflödets visningsnamn
workflowName True string

Anger visningsnamnet för arbetsflödet som ska vara synligt för iManage Work-användare.

Description
description True string

Anger beskrivningen av arbetsflödet.

Biblioteks-ID
libraryId True string

Anger ID för biblioteket där arbetsflödet är tillgängligt.

Formulär-ID
formId True string

Anger ID för formuläret som visas för användaren för att samla in indata som används av arbetsflödet.

Returnera mapp-ID
inferFolderId True boolean

Anger om dokumentets mapp-ID krävs av arbetsflödet.

Tillgänglig för användare
users string

Anger ett eller flera användar-ID:n, avgränsade med semikolon, som arbetsflödet är tillgängligt för.

Tillgänglig för grupper
groups string

Anger ett eller flera grupp-ID:n, avgränsade med semikolon, som arbetsflödet är tillgängligt för.

Tillgänglig i arbetsytor
workspaces string

Anger ett eller flera arbetsyte-ID:n, avgränsade med semikolon, där arbetsflödet är tillgängligt.

Dokumentklasser
classes string

Anger ett eller flera dokumentklass-ID:n, avgränsade med semikolon, för vilka arbetsflödet är tillgängligt.

Vänta tills det är klart
waitForCompletion boolean

Anger om program väntar tills arbetsflödet har slutfört körningen. Om inställningen är "Ja" måste du använda åtgärden Uppdatera arbetsflödestillstånd.

Returnerar

Utdata från denna operation är dynamiska.

För flera markerade dokument

Med den här utlösaren kan du starta ett arbetsflöde för ett eller flera markerade dokument i iManage Work. Ange ett visningsnamn som ska visas för användare i iManage Work-program. Om "Vänta på slutförande" är inställt på "Ja" måste du använda åtgärden Uppdatera arbetsflödestillstånd i arbetsflödet, annars överskrider programmen tidsgränsen utan att ange slutförandetillståndet för användaren.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Arbetsflödets visningsnamn
workflowName True string

Anger visningsnamnet för arbetsflödet som ska vara synligt för iManage Work-användare.

Description
description True string

Anger beskrivningen av arbetsflödet.

Biblioteks-ID
libraryId True string

Anger ID för biblioteket där arbetsflödet är tillgängligt.

Formulär-ID
formId True string

Anger ID för formuläret som visas för användaren för att samla in indata som används av arbetsflödet.

Returnera mapp-ID
inferFolderId True boolean

Anger om dokumentets mapp-ID krävs av arbetsflödet.

Tillgänglig för användare
users string

Anger ett eller flera användar-ID:n, avgränsade med semikolon, som arbetsflödet är tillgängligt för.

Tillgänglig för grupper
groups string

Anger ett eller flera grupp-ID:n, avgränsade med semikolon, som arbetsflödet är tillgängligt för.

Visa formulär för varje dokument
showFormPerObject boolean

Anger om formuläret visas individuellt för varje markerat objekt eller bara en gång för alla markerade objekt.

Vänta tills det är klart
waitForCompletion boolean

Anger om program väntar tills arbetsflödet har slutfört körningen. Om inställningen är "Ja" måste du använda åtgärden Uppdatera arbetsflödestillstånd.

Returnerar

Utdata från denna operation är dynamiska.

För flera valda arbetsytor

Med den här utlösaren kan du starta ett arbetsflöde för en eller flera valda arbetsytor i iManage Work. Ange ett visningsnamn som ska visas för användare i iManage Work-program. Om "Vänta på slutförande" är inställt på "Ja" måste du använda åtgärden Uppdatera arbetsflödestillstånd i arbetsflödet, annars överskrider programmen tidsgränsen utan att ange slutförandetillståndet för användaren.

Parametrar

Namn Nyckel Krävs Typ Beskrivning
Arbetsflödets visningsnamn
workflowName True string

Anger visningsnamnet för arbetsflödet som ska vara synligt för iManage Work-användare.

Description
description True string

Anger beskrivningen av arbetsflödet.

Biblioteks-ID
libraryId True string

Anger ID för biblioteket där arbetsflödet är tillgängligt.

Formulär-ID
formId True string

Anger ID för formuläret som visas för användaren för att samla in indata som används av arbetsflödet.

Tillgänglig för användare
users string

Anger ett eller flera användar-ID:n, avgränsade med semikolon, som arbetsflödet är tillgängligt för.

Tillgänglig för grupper
groups string

Anger ett eller flera grupp-ID:n, avgränsade med semikolon, som arbetsflödet är tillgängligt för.

Vänta tills det är klart
waitForCompletion boolean

Anger om program väntar tills arbetsflödet har slutfört körningen. Om inställningen är "Ja" måste du använda åtgärden Uppdatera arbetsflödestillstånd.

Returnerar

Utdata från denna operation är dynamiska.

Definitioner

MinimalDocumentProfileInArray

Anger profilen för varje version av dokumentet.

Namn Stig Typ Beskrivning
Author
author string

Anger ID för användaren som skapade dokumentet. Till exempel "JSMITH".

Beskrivning av författare
author_description string

Anger ytterligare information om dokumentets författare.

Grundläggande dokumentegenskaper
basic_properties string

Anger ett inbäddningsbart element som innehåller grundläggande dokumentegenskaper.

Dokumentklass
class string

Anger dokumentets klass.

Comment
comment string

Anger ytterligare information om dokumentet.

Innehållstyp
content_type string

Anger dokumentinnehållstypen.

Datum för skapande av dokument
create_date string

Anger datum och tid (i ISO 8601-format) som dokumentet importerades till iManage Work-systemet. Det här datumet kan skilja sig från "file_create_date".

Anpassad1
custom1 string

Anger värdet för custom1.

Beskrivning av Custom1
custom1_description string

Anger ytterligare information om egenskapen custom1.

Anpassad 2
custom2 string

Anger värdet för custom2.

Anpassad 2-beskrivning
custom2_description string

Anger ytterligare information om egenskapen custom2.

Anpassad 3
custom3 string

Anger värdet för custom3.

Anpassad 3-beskrivning
custom3_description string

Anger ytterligare information om egenskapen custom3.

Anpassad 4
custom4 string

Anger värdet för custom4.

Anpassad 4-beskrivning
custom4_description string

Anger ytterligare information om egenskapen custom4.

Anpassad 5
custom5 string

Anger värdet för custom5.

Anpassad 5-beskrivning
custom5_description string

Anger ytterligare information om egenskapen custom5.

Anpassad 6
custom6 string

Anger värdet för custom6.

Anpassad 6-beskrivning
custom6_description string

Anger ytterligare information om egenskapen custom6.

Anpassad 7
custom7 string

Anger värdet för custom7.

Anpassad 7-beskrivning
custom7_description string

Anger ytterligare information om egenskapen custom7.

Anpassad8
custom8 string

Anger värdet för custom8.

Beskrivning av Custom8
custom8_description string

Anger ytterligare information om egenskapen custom8.

Anpassad9
custom9 string

Anger värdet för custom9.

Anpassad 9-beskrivning
custom9_description string

Anger ytterligare information om egenskapen custom9.

Custom10
custom10 string

Anger värdet för custom10.

Beskrivning av Custom10
custom10_description string

Anger ytterligare information om egenskapen custom10.

Custom11
custom11 string

Anger värdet för custom11.

Beskrivning av Custom11
custom11_description string

Anger ytterligare information om egenskapen custom11.

Custom12
custom12 string

Anger värdet för custom12.

Beskrivning av Custom12
custom12_description string

Anger ytterligare information om egenskapen custom12.

Custom13
custom13 string

Anger värdet för custom13.

Custom14
custom14 string

Anger värdet för custom14.

Anpassad 15
custom15 string

Anger värdet för custom15.

Anpassad 16
custom16 string

Anger värdet för custom16.

Anpassad 17
custom17 double

Anger värdet för custom17.

Anpassad 18
custom18 double

Anger värdet för custom18.

Anpassad 19
custom19 double

Anger värdet för custom19.

Custom20
custom20 double

Anger värdet för custom20.

Custom21
custom21 string

Anger värdet för egenskapen custom21 i ISO 8601 datetime-format.

Anpassad 22
custom22 string

Anger värdet för egenskapen custom22 i ISO 8601 datetime-format.

Anpassad 23
custom23 string

Anger värdet för egenskapen custom23 i ISO 8601 datetime-format.

Anpassad 24
custom24 string

Anger värdet för egenskapen custom24 i ISO 8601 datetime-format.

Anpassad 25
custom25 boolean

Anger värdet för custom25.

Anpassad 26
custom26 boolean

Anger värdet för custom26.

Anpassad 27
custom27 boolean

Anger värdet för custom27.

Anpassad 28
custom28 boolean

Anger värdet för custom28.

Anpassad 29
custom29 string

Anger värdet för custom29.

Beskrivning av Custom29
custom29_description string

Anger ytterligare information om egenskapen custom29.

Custom30
custom30 string

Anger värdet för custom30.

Beskrivning av Custom30
custom30_description string

Anger ytterligare information om egenskapen custom30.

Databas
database string

Anger biblioteket där dokumentet lagras.

Standardsäkerhet för dokument
default_security string

Anger standardnivån för säkerhetsåtkomst. Möjliga värden är "ärver", "privat", "view", "public".

Dokumentnummer
document_number integer

Anger dokumentnumret för ett dokument.

Dokument-URL
document_url string

Anger den delningsbara länken för dokumentet.

Dokumentredigeringsdatum
edit_date string

Anger datum och tid (i ISO 8601-format) för den senaste ändringen av dokumentet.

Datum för profilredigering
edit_profile_date string

Anger datum och tid (i ISO 8601-format) för den senaste ändringen av dokumentprofilen.

Dokumenttillägg
extension string

Anger filnamnstillägget, även kallat programtillägget, för dokumentet.

Fullständigt filnamn
full_file_name string

Anger dokumentets fullständiga filnamn. Innehåller filnamnstillägget.

Dokument-ID
id string

Anger dokumentets ID. Till exempel "ACTIVE_US!453.1".

Är indexerbar
indexable boolean

Anger om dokumentet indexeras av systemet.

Är utcheckad
is_checked_out boolean

Anger om dokumentet är utcheckat.

Deklareras
is_declared boolean

Anger om dokumentet deklareras som en post. Ett dokument som deklareras som en post kan inte redigeras eller tas bort, förutom av en systemadministratör för iManage Work.

Är extern
is_external boolean

Anger om dokumentet delas med externa användare.

Är HIPAA
is_hipaa boolean

Anger om dokumentet är krypterat.

Används
is_in_use boolean

Anger om dokumentet används.

Dokumentlänk
iwl string

Anger iManage Work Link (iWL) för dokumentet. iWL används för att öppna dokumentet i läget Skyddad vy av användaren som har "read_write" eller "full_access".

Senaste användare
last_user string

Anger ID för den användare som senast redigerade dokumentet. Till exempel "JSMITH".

Beskrivning av senaste användare
last_user_description string

Anger ytterligare information om den senaste användaren som senast redigerade dokumentet.

Dokumentnamn
name string

Anger dokumentets filnamn.

Operator
operator string

Anger ID för den användare som har dokumentet utcheckat eller för närvarande redigerar sin profil. Till exempel "JSMITH".

Beskrivning av operator
operator_description string

Anger ytterligare information om operatorn.

Är relaterat
is_related boolean

Anger om dokumentet är relaterat till ett annat dokument.

Dokumentstorlek
size integer

Anger dokumentets storlek i byte.

Typ
type string

Anger dokumenttypen. Till exempel WORD för Microsoft Word. Om du vill ha en aktuell lista över typer kontaktar du systemadministratören för iManage Work.

Dokumentversion
version integer

Anger versionsnumret för dokumentet.

Wstype
wstype string

Anger objektets iManage Work-typ. Möjliga värden är "dokument", "mapp", "arbetsyta", "e-post", "document_shortcut", "folder_shortcut", "workspace_shortcut", "användare".

Användarprofil

Anger information om en användare.

Namn Stig Typ Beskrivning
Tillåt inloggning
allow_logon boolean

Anger om användaren får logga in.

Anpassad1
custom1 string

Anger ytterligare information om användaren.

Anpassad 2
custom2 string

Anger ytterligare information om användaren.

Anpassad 3
custom3 string

Anger ytterligare information om användaren.

Katalog-ID
directory_id string

Anger ID:t från en extern katalog (till exempel ADFS), som används för synkronisering av användarprofiler.

Unikt namn
distinguished_name string

Anger namnet på objektet som representerar den fullständigt kvalificerade sökvägen för namn som spårar posten tillbaka till roten i LDAP-trädet.

Redigera datum
edit_date string

Anger datum och tid (i ISO 8601-format) för den senaste ändringen av användarprofilen.

E-postmeddelande
email string

Anger användarens e-post-ID.

Automatisk identifierings-URL för Exchange
exch_autodiscover string

Anger exchange-serverinformationen för användaren.

Extension
extension string

Anger användarens telefonnummertillägg.

Misslyckade inloggningsförsök
failed_logins integer

Anger det aktuella antalet misslyckade inloggningsförsök för användaren.

Faxmaskin
fax string

Anger användarens faxnummer.

Framtvinga lösenordsändring
force_password_change boolean

Anger att användaren måste ändra sitt lösenord vid nästa inloggning. Gäller endast för virtuella användare, vilket anges med värdet "user_nos" "2".

Fullständigt namn
full_name string

Anger användarens fullständiga namn.

General
general string

Anger allmän information om användaren.

Användar-ID
id string

Anger användarens ID. Till exempel "JSMITH".

Är extern användare
is_external boolean

Anger en extern användare. En extern användare har begränsad åtkomst och används ofta för tillfälliga teammedlemmar, konsulter eller externa användare i organisationen.

Senaste synkroniseringstid
last_sync_ts string

Anger den senaste synkroniseringstiden (i ISO 8601 datetime-format) för användarens profil med en extern katalog, till exempel LDAP eller Microsoft Active Directory (ADFS).

Plats
location string

Anger användarens geografiska plats.

Lösenordet upphör aldrig att gälla
password_never_expire boolean

Anger om användarens lösenord aldrig upphör att gälla.

Telefonnummer
phone string

Anger användarens telefonnummer.

Föredraget bibliotek
preferred_library string

Anger önskat bibliotek. Ett föredraget bibliotek är användarens standardbibliotek. Varje användare måste ha ett föredraget bibliotek.

Ändrad tid för lösenord
pwd_changed_ts string

Anger tiden (i ISO 8601 datetime-format) när användarens lösenord senast ändrades. Detta gäller endast för virtuella användare (vars användar-NOS är 2).

SSID
ssid string

Anger det unika systemgenererade ID:t för användaren.

Användardomän
user_domain string

Anger det fullständigt kvalificerade domännamnet för användarens katalogtjänst.

Utökat användar-ID
user_id_ex string

Anger det ursprungliga värdet för användar-ID:t som tas emot från en extern katalog, till exempel Microsoft Active Directory (ADFS).

Användar-NOS
user_nos integer

Anger vilken typ av operativsystem som användaren synkroniseras från. Möjliga värden är 2 (virtuell användare) och 6 (Enterprise-användare). Kontakta systemadministratören för iManage Work om du vill ha mer information.

Användarnummer
user_num integer

Anger användarens numeriska system-ID.

UserProfileInArray

Namn Stig Typ Beskrivning
Tillåt inloggning
allow_logon boolean

Anger om användaren får logga in.

Anpassad1
custom1 string

Anger ytterligare information om användaren.

Anpassad 2
custom2 string

Anger ytterligare information om användaren.

Anpassad 3
custom3 string

Anger ytterligare information om användaren.

Katalog-ID
directory_id string

Anger ID:t från en extern katalog (till exempel ADFS), som används för synkronisering av användarprofiler.

Unikt namn
distinguished_name string

Anger namnet på objektet som representerar den fullständigt kvalificerade sökvägen för namn som spårar posten tillbaka till roten i LDAP-trädet.

Redigera datum
edit_date string

Anger datum och tid (i ISO 8601-format) för den senaste ändringen av användarprofilen.

E-postmeddelande
email string

Anger användarens e-post-ID.

Automatisk identifierings-URL för Exchange
exch_autodiscover string

Anger exchange-serverinformationen för användaren.

Extension
extension string

Anger användarens telefonnummertillägg.

Misslyckade inloggningsförsök
failed_logins integer

Anger det aktuella antalet misslyckade inloggningsförsök för användaren.

Faxmaskin
fax string

Anger användarens faxnummer.

Framtvinga lösenordsändring
force_password_change boolean

Anger att användaren måste ändra sitt lösenord vid nästa inloggning. Gäller endast för virtuella användare, vilket anges med värdet "user_nos" "2".

Fullständigt namn
full_name string

Anger användarens fullständiga namn.

General
general string

Anger allmän information om användaren.

ID-nummer
id string

Anger användarens ID. Till exempel "JSMITH".

Är extern användare
is_external boolean

Anger en extern användare. En extern användare har begränsad åtkomst och används ofta för tillfälliga teammedlemmar, konsulter eller externa användare i organisationen.

Senaste synkroniseringstid
last_sync_ts string

Anger den senaste synkroniseringstiden (i ISO 8601 datetime-format) för användarens profil med en extern katalog, till exempel LDAP eller Microsoft Active Directory (ADFS).

Plats
location string

Anger användarens geografiska plats.

Lösenordet upphör aldrig att gälla
password_never_expire boolean

Anger om användarens lösenord aldrig upphör att gälla.

Telefonnummer
phone string

Anger användarens telefonnummer.

Föredraget bibliotek
preferred_library string

Anger önskat bibliotek. Ett föredraget bibliotek är användarens standardbibliotek. Varje användare måste ha ett föredraget bibliotek.

Ändrad tid för lösenord
pwd_changed_ts string

Anger tiden (i ISO 8601 datetime-format) när användarens lösenord senast ändrades. Detta gäller endast för virtuella användare (vars användar-NOS är 2).

SSID
ssid string

Anger det unika systemgenererade ID:t för användaren.

Domän
user_domain string

Anger det fullständigt kvalificerade domännamnet för användarens katalogtjänst.

Utökat användar-ID
user_id_ex string

Anger det ursprungliga värdet för användar-ID:t som tas emot från en extern katalog, till exempel Microsoft Active Directory (ADFS).

NOS
user_nos integer

Anger vilken typ av operativsystem som användaren synkroniseras från. Möjliga värden är 2 (virtuell användare) och 6 (Enterprise-användare). Kontakta systemadministratören för iManage Work om du vill ha mer information.

Nummer
user_num integer

Anger användarens numeriska system-ID.

TaxonomyNodeValue

Anger varje taxonominodvärde.

Namn Stig Typ Beskrivning
SSID
created_by.ssid string

Anger det unika systemgenererade ID:t för användaren som skapade nodvärdet.

Skapa datum
create_date date-time

Anger datum och tid (i ISO 8601-format) som nodvärdet skapades.

Description
description string

Anger beskrivningen av nodvärdet.

SSID
edited_by.ssid string

Anger det unika systemgenererade ID:t för användaren som senast redigerade nodvärdet.

Redigera datum
edit_date date-time

Anger datum och tid (i ISO 8601-format) som nodvärdet senast redigerades.

Är aktiverad
enabled boolean

Anger om nodvärdet är aktiverat.

ID-nummer
id string

Anger visningsidentifieraren för nodvärdet.

SSID
parent.ssid string

Anger det unika systemgenererade ID:t för den omedelbara överordnade noden.

SSID
ssid string

Anger det unika systemgenererade ID:t för nodvärdet.

Väg
path array of object

Anger den fullständiga sökvägen till nodvärdet. En sökväg är en ordnad lista som börjar med noden på den översta nivån i taxonomi och sedan alla noder till den matchande nodens överordnade nod.

Varje ID
path.id string

Anger visningsidentifieraren för ett nodvärde i sökvägen.

Varje SSID
path.ssid string

Anger det unika systemgenererade ID:t för ett nodvärde i sökvägen.

UpdatePermissionsResponse

Namn Stig Typ Beskrivning
Standardsäkerhet
data.default_security string

Anger standardsäkerheten för objektet. Möjliga värden är "ärver", "offentlig", "vy" eller "privat".

Åtkomstbehörigheter
data.acl AccessPermissions

Anger en samling åtkomstbehörigheter för en eller flera användare och/eller grupper.

Alla användar-ID:t
data.all_user_ids string

Anger en lista över alla användar-ID:n, sammanfogade som en sträng och avgränsade med semikolon.

Alla grupp-ID:t
data.all_group_ids string

Anger en lista över alla grupp-ID:n, sammanfogade som en sträng och avgränsade med semikolon.

AccessPermissions

Anger en samling åtkomstbehörigheter för en eller flera användare och/eller grupper.

Namn Stig Typ Beskrivning
Namn på förvaltare
name string

Anger namnet på förvaltaren.

Förvaltar-ID
id string

Anger ID:t för förvaltaren. Det kan vara ett användar-ID eller ett grupp-ID.

Sid för förvaltare
sid string

Anger säkerhetsidentifieraren för användaren eller gruppen.

Typ av förvaltare
type string

Anger vilken typ av förvaltare som returneras. Möjliga värden är "användare" eller "grupp".

Åtkomstnivå
access_level string

Anger den åtkomstbehörighet som användaren eller gruppen har på objektet. Möjliga värden är "no_access", "read", "read_write" eller "full_access".

Visningsnamn på åtkomstnivå
access_level_display_name string

Anger det visningsnamn på mänsklig läsbar åtkomstnivå som tilldelats användaren eller gruppen för det här objektet. Möjliga värden är "Ingen åtkomst", "Skrivskyddad", "Läs/skriv" eller "Fullständig åtkomst".

Åtkomst
access integer

Anger det numeriska värdet för åtkomstbehörigheten som användaren eller gruppen har på objektet. Möjliga värden är 0 (no_access), 1 (läs), 2 (read_write) eller 3 (full_access).

Är extern
is_external boolean

Anger om användaren är en extern användare eller om gruppen är begränsad till externa användare.

Tillåt inloggning
allow_logon boolean

Anger om användaren får logga in. Gäller inte för grupper.

Är aktiverad
enabled boolean

Anger om gruppen är aktiverad. Gäller inte för användare.

Har begränsad medlem
has_restricted_member boolean

Anger om gruppen har minst en användare med åtkomst till det här objektet som nekas av iManage Security Policy Manager.

objekt

Detta är typen 'objekt'.

binär

Det här är den grundläggande datatypen "binär".