Parameterglossar

Die folgenden Konventionen werden in diesem Glossar verwendet:

  • Interne ID: Die Datenbank-ID für ein bestimmtes Objekt.
  • Name: Normalerweise ist dies der Anzeigename für ein Objekt.
  • Öffentliche ID: Normalerweise ist dies die ID, die Benutzern gezeigt wird, z. B. die Incident-ID oder der vollständige Name eines Benutzers.
  • Datensatz-ID: Die Datenbank-ID für einen bestimmten Datensatz.
  • Suchelement: Gespeicherte Suchvorgänge, auch gespeicherte Abfrage genannt.
  • Suchergebnisse: Ein bei einer Suche zurückgegebener Satz an Datensätzen.

Die Operationsnutzung für jeden Parameter wird angemerkt, es sei denn, ein Parameter wird über mehrere Operationstypen hinweg verwendet (z. B. busobid).

  • .expires

    Bei Token-Operationsantworten: Datum und Uhrzeit, zu dem ein Token abläuft.

  • .issued

    Bei Token-Operationsantworten: Datum und Uhrzeit der Erstellung eines Tokens.

  • access_token

    Bei Token-Operationsantworten: das erteilte Zugriffstoken.

  • accountLocked

    Bei Sicherheitsoperationen zeigt diese Markierung an, dass das Konto eines Benutzers gesperrt ist.

  • actions

    Bei Antworten von Operationen mit mobilen Formularen ist dies eine Liste von Aktionsobjekten, die für ein Formular verfügbar sind.

  • add

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, ob bei der Sicherheitsgruppe bei spezifischen Rechten die Option „Hinzufügen“ aktiviert ist.

  • addUserToTeamRequests

    Bei Sicherheits-Operations-Requests ist dies eine Liste, um Benutzer Teams hinzuzufügen.

  • allfields

    Bei Requests von Business Objekt-Operationen ist dies eine Markierung, bei der alle verknüpften Business Objekt-Felder eingeschlossen werden.

  • allow

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, ob bei der Sicherheitsgruppe bei spezifischen Rechten die Option „Erlauben“ aktiviert ist.

  • allowQuickSearch

    Bei Antworten von Schnellsuch-Operationen zeigt diese Markierung an, ob die Schnellsuche möglich ist.

  • allowSpecificSearch

    Bei Antworten von Schnellsuch-Operationen zeigt diese Markierung an, ob die spezifische Suche möglich ist.

  • allowValuesOnly

    Bei Suchoperationsantworten wird mit dieser Markierung gezeigt, dass nur bestimmte Werte eingegeben werden können (true) oder ein beliebiger Wert angegeben werden kann (false).

  • altitude

    Bei Antworten von Operationen mit mobilen Formularen ist dies die Höhe für einen spezifischen Business Objekt-Datensatz (falls Standorterkennung aktiviert ist).

  • apiVersion

    Bei Antworten für Service-Informationen ist dies die verwendete Version der Cherwell REST API.

  • ascending

    Bei Antworten von Schnellsuch-Operationen zeigt diese Markierung an, dass die Suchergebnisse in aufsteigender Reihenfolge sortiert sind.

  • as:client_id

    Bei Token-Operationsantworten ist dies die API Client-ID, die verwendet wird, um ein Token anzufordern.

  • association

    Die interne ID für die Business Objekt-Verknüpfung.

  • attachBusObId

    Bei Business Objekt-Anhang-Requests ist dies die interne ID für den Typ des Business Objekts, das an ein anderes Business Objekt angehängt werden soll.

  • attachBusObName

    Bei Business Objekt-Anhang-Requests ist dies der Anzeigename für den Typ des Business Objekts, das an ein anderes Business Objekt angehängt werden soll.

  • attachBusObPublicId

    Bei Business Objekt-Anhang-Requests ist dies die öffentliche ID für den Typ des Business Objekts, das an ein anderes Business Objekt angehängt werden soll.

  • attachBusObRecId

    Bei Business Objekt-Anhang-Requests ist dies die interne ID für das Business Objekt, das an ein anderes Business Objekt angehängt werden soll.

  • attachedBusObId

    Bei Business Objekt-Anhang-Antworten ist dies die interne ID für den Typ des Business Objekts, das an ein anderes Business Objekt angehängt ist.

  • attachedBusObRecId

    Bei Business Objekt-Anhang-Antworten ist dies die interne ID für das Business Objekt, das an ein anderes Business Objekt angehängt ist.

  • attachmentFileId

    Bei Business Objekt-Anhangoperationen ist dies die interne ID für eine angehängte Datei.

  • attachmentFileName

    Bei Business Objekt-Anhangoperationen sind dies der Pfad und Dateiname für eine angehängte Datei.

  • attachmentFileType

    Bei Business Objekt-Anhangoperationen ist dies der Typ der angehängten Datei.

  • attachmentId

    Bei Business Objekt-Anhangoperationen ist dies die interne ID für einen Datensatz, der Information über eine angehängte Datei enthält.

  • attachments

    Bei Business Objekt-Anhangoperationen ist dies eine Liste von Objekten, die mit Business Objekt-Anhängen verbunden sind.

  • attachmentTypes
    Bei Business Objekt-Anhangoperationen ist dies der Typ der angehängten Datei:
    • 0 = In die Datenbank importiert.
    • 1 = Mit einer externen Datei verknüpft.
    • 2 = URL-Anhang.
  • attribute

    Eine Liste von Attributen, die für spezifische Felder definiert sind.

  • auth_mode

    Bei Token-Operationen-Requests ist dies der Authentifizierungsmodus, der zum Anfordern eines Zugriffstokens verwendet werden soll. Optionen sind Intern (für CSM-Authentifizierung), Windows, LDAP und SAML.

  • autoFill

    Bei Feldschema-Antworten ist dies eine Markierung, die anzeigt, ob die Option „Automatisch ausfüllen“ aktiviert ist.

  • body

    Bei Anhang-Hochlade-Operationen für ein Business Objekt ist der Textkörper des Requests das Byte-Array des hochgeladenen Dateiteils.

  • browserClientCustomViewId

    Bei Sicherheits-Operationsantworten ist dies die interne ID für die Browser Client-Ansicht, die einer Rolle zugewiesen ist.

  • businessObjectExcludeList

    Bei Sicherheits-Operationsantworten sind dies die internen IDs von Business Objekten, die für eine Rolle ausgeschlossen sind.

  • busobid/busObID

    Die interne ID eines Business Objekt-Typs (z.B. Incident oder Aufgabe).

  • busobname/busObName
    Der Anzeigename für einen Business Objekt-Typ. Beispiele sind u. a.:
    • Incident
    • Aufgabe
    • Service-Warenkorb
  • busobrecid

    Die interne ID für einen einzelnen Business Objekt-Datensatz.

  • calculated

    Bei Feld-Schema-Antworten ist dies eine Markierung, die anzeigt, ob ein Ausdruck zum Berechnen des Feldwertes verwendet wird.

  • caption

    Bei Feld-Schema-Antworten ist dies der Titel für eine Spalte des Business Objekt-Rasters.

  • category

    Bei Feld-Schema-Antworten ist dies eine Zeichenfolge, die den Ordner bezeichnet, der zum Organisieren des Feldes verwendet wird.

  • categoryDescription - getsecuritygroupcategories

    Nicht verwendet von REST API.

  • categoryid

    Bei Sicherheitsgruppenoperationen ist dies die interne ID für die Sicherheitsgruppenkategorie.

  • categoryname

    Bei Sicherheitsgruppenoperationen ist dies der Anzeigename für die Sicherheitsgruppenkategorie.

  • changedLimits

    Bei Antworten von Schnellsuch-Operationen sind dies die Limits, die auf Änderungen basieren, welche in einem bestimmten Zeitrahmen gemacht werden.

  • changedOption

    Bei Suchelementoperationen ist dies ein Indikator, dass ein Limit für Änderungen gesetzt werden kann. Verwenden Sie den Optionsschlüssel, um festzulegen, ob Sie diese Option ändern können.

    Optionsschlüssel:
    • 0 = None (Nicht ausgewählt und kann nicht ausgewählt werden.)
    • 1 = Use (Ausgewählt und kann nicht deaktiviert werden.)
    • 2 = Display (Nicht ausgewählt und kann ausgewählt werden.)
    • 3 = UseAndDisplay (Ausgewählt und kann deaktiviert werden.)
  • childFolders

    Bei Antworten von Suchelementoperationen ist dies eine Liste von untergeordneten Ordnern, die gespeicherte Abfragen enthalten.

  • childItems

    Bei Antworten von Suchelementoperationen ist dies eine Liste der gespeicherten Abfragen, die einem Bereich untergeordnet sind.

  • client_id

    Bei Token-Operationen-Requests ist dies die API Client-ID des Clients, der das Token anfordert.

  • client_secret

    Bei Token-Operationen-Requests ist dies der geheime API-Client-Schlüssel für den nativen Client, der das Token anfordert. Dies ist nur für native Clients erforderlich.

  • columns

    Bei Antworten von Schnellsuch-Operationen ist dies eine Liste der Eigenschaften für alle Felder auf dem Business Objekt-Raster. Es werden Spalten zurückgegeben, wenn die Schemamarkierung auf „wahr“ gesetzt ist.

  • comment

    Eine Textzeichenfolge.

  • constraintXml

    Bei Antworten von Suchergebnis-Operationen ist dies eine XML-Version der Eigenschaften einer für eine Aufforderung verwendete Bedingung.

  • created

    Bei Business Objekt-Anhangoperationen sind dies Datum und Uhrzeit, zu denen einem Business Objekt ein Anhang hinzugefügt wurde.

  • createDateTime

    Bei Sicherheits-Operationsantworten sind dies Datum und Uhrzeit, zu denen ein Token abläuft.

  • csmCulture

    Bei Service-Informations-Operationen sind dies die standardmäßigen Regionaleinstellungen für CSM.

  • csmVersion

    Bei Service-Informations-Antworten ist dies die CSM-Version.

  • culture

    Bei Sicherheits-Operationsantworten ist dies der Sprachcode für die der Rolle zugewiesenen Regionaleinstellungen.

  • cultureCode

    Bei Kernoperationen ist dies der interne Code für eine Kultur.

  • currencyCulture

    Bei Feldschema-Antworten ist dies die für Zahlenfelder eingestellte Währung.

  • currencySymbol

    Bei Feldschema-Antworten ist dies das Währungssymbol der für Zahlenfelder eingestellten Währung.

  • customGridDefId

    Bei Suchoperationen ist dies die interne ID, die vom Raster verwendet wird, um Feldlisten-Einstellungen zu überschreiben.

  • customGridId

    Bei Business Objekt-Operationen ist dies die interne ID, die vom Raster verwendet wird, um Feldlisten-Einstellungen zu überschreiben.

  • customSeparator

    Bei Business Objekt-Anhang-Requests ist dies ein benutzerdefiniertes Trennzeichen für Exporte in eine Textdatei.

  • dateTimeFormatting

    Nur bei ExportSearchResults ist dies das Format der Datum/Uhrzeit-Felder. Zum Beispiel mm/dd/yyyy oder dd/mm/yyyy.

  • decimalDigits

    Bei Feldschema-Antworten ist dies die Anzahl der Zeichen für ein Nummernfeld, die nach der Dezimalstelle im Feldwert angezeigt werden.

  • default

    Bei Antworten von Suchergebnis-Operationen ist dies der Standardwert für eine Aufforderung.

  • defaultSortOrderAscending

    Bei Antworten von Suchoperationen zeigt diese Markierung die Standardsortierreihenfolge an. Wahr ist aufsteigend, Falsch ist absteigend.

  • defaultToQuickSearch

    Bei Antworten von Schnellsuch-Operationen zeigt diese Markierung an, dass die Schnellsuche Standard ist (wahr), wenn die Schnellsuche und die spezifische Suche möglich sind.

  • delete

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, ob die Sicherheitsgruppe bei spezifischen Rechten löschen kann.

  • deleteRequests

    Eine Liste von deleteRequest-Objekten, die verarbeitet werden.

  • departmentMemberEdit

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, ob ein Abteilungsmitglied die Business Objekt-Datensätze oder -Felder in den Datensätzen bearbeiten kann.

  • departmentMemberView

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, ob ein Abteilungsmitglied die Business Objekt-Datensätze oder Felder in diesen Datensätzen anzeigen kann.

  • description

    Die Beschreibung eines Objekts.

  • details

    Bei Feldschema-Antworten ist dies eine für ein Feld definierte Folge von Attributen.

  • dirty

    Ist diese Markierung auf „Wahr“ eingestellt, wird ein Feldwert aktualisiert. Steht die Markierung auf „Falsch“, wird der Wert nicht aktualisiert.

  • displaytext/displayName

    Der Anzeigetext für das Element.

    Verwenden Sie zum Beispiel den Anhangsnamen, der dem Anzeigetext für einen Anhangsdatensatz entspricht.

  • docRespositoryItemID

    Bei Antworten von Schnellsuch-Operationen ist dies die interne ID für eine Dokumentenablage.

  • edit

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, ob Bearbeitungsrechte gewährt wurden.

  • emailAlias

    Bei Sicherheitsoperations-Requests ist dies der einem Team zugewiesene E-Mail-Alias.

  • enabled

    Bei Feldschema-Antworten ist dies ein Ausdruck, der überprüft wird.

  • error

    Eine Fehlermeldung. (Veraltet in V2-Operationen.)

  • errorCode

    Eine Textzeichenfolge, die verwendet wird, um einen Fehlermeldungstyp zu bezeichnen.

  • errorMessage

    Eine Fehlermeldung.

  • expires_in

    Bei Antworten von Token-Operationen ist dies die Anzahl von Sekunden bevor ein Token abläuft.

  • exportFormat
    Bei Requests von Suchoperationen ist dies das Format von exportierten Suchen:
    • 0 = CSV
    • 1 = Excel
    • 2 = Tabulatorgetrennt
    • 3 = Word
    • 4 = Benutzerdefiniertes Trennzeichen
    • 5 = Einfaches JSON
  • exportTitle

    Gilt nicht für REST API.

  • fieldDefinitions

    Bei Feldschema-Antworten ist dies eine Liste mit Eigenschaften für jedes Feld.

  • fieldId

    Die interne ID für ein Feld.

  • fieldName

    Der Anzeigename eines Feldes.

  • fieldNames

    Bei Requests von Business Objekt-Vorlagen ist dies eine kommagetrennte Liste von Feldnamen. Standardmäßig werdenalle Felder angefordert.

  • fieldPermissions

    Bei Sicherheits-Operationsantworten ist dies eine Liste von Rechte-Objekten für eine Sicherheitsgruppe.

  • fields

    In den meisten Fällen legen Sie Feldparameter wie fieldId, name und value fest.

    Bei Suchoperationen ist dies eine Liste der Felder, die zurückgegeben werden sollen.

  • fieldsList

    Eine Liste mit bestimmten Feldern, die angefordert werden sollen.

  • fieldValidationErrors

    Eine Liste von Objekten verbunden mit einer Feld-Validierung.

  • filename

    Bei Business Objekt-Anhang-Requests ist dies der Name der Datei, die hochgeladen wird.

  • filters

    Bei Suchoperationen ist dies ein Satz von Filtern, die auf Suchen angewendet werden können. Jeder Filter enthält „fieldId“, Operator und Wert.

  • firstRecIdField

    Bei Business Objekt-Schemaoperationen ist dies das erste angegebene Datensatz-ID-Feld für ein Business Objekt.

  • folder/folderId

    Der Name oder die interne ID des Ordners eines Elements.

  • foredit

    Bei Formularoperationen ist dies eine Markierung, um die bearbeitbare Version eines Formulars zu erhalten.

  • formid

    Die interne ID für ein Formular.

  • fullFieldiD

    Eine Zeichenfolge, die die interne Business Objekt-ID und interne Feld-ID enthält.

  • galleryImage

    Bei Operationen mit mobilen Formularen ist dies das Bild, das auf dem Formular angezeigt wird.

  • grant_type

    Bei Token-Operationen-Requests ist dies der Typ des angeforderten Tokens: Kennwort oder Aktualisierungstoken.

  • gridDefinitions

    Die internen IDs, die mit einem Business Objekt verbunden sind.

  • gridid

    Die interne ID für das benutzerdefinierte Raster, das die Feldliste enthält.

  • group

    Bei Antworten von Business Objekt-Operationen ist dies eine Markierung, mit der angezeigt wird, dass das Business Objekt Gruppenhauptobjekt ist.

  • groupid

    Bei Sicherheitsoperationen ist dies die interne ID für eine Sicherheitsgruppe.

  • groupname

    Bei Sicherheitsoperationen ist dies der Anzeigename für eine Sicherheitsgruppe.

  • groups

    Bei Antworten von Schnellsuch-Operationen ist dies ein Satz von Objekten und eine Ergebnisliste für eine einfache Textsuche.

  • groupSummaries

    Bei Antworten von Business Objekt-Operationen ist dies eine Liste von Objekten für Mitglieder einer Business Objekt-Gruppe.

  • hasAnyOptions

    Bei Antworten von Schnellsuch-Operationen ist dies „Wahr“, wenn die Suchkonfigurationsoption auf Display (2) oder UseAndDisplay (3) eingestellt ist.

    Optionsschlüssel:
    • 0 = None (Nicht ausgewählt und kann nicht ausgewählt werden.)
    • 1 = Use (Ausgewählt und kann nicht deaktiviert werden.)
    • 2 = Display (Nicht ausgewählt und kann ausgewählt werden.)
    • 3 = UseAndDisplay (Ausgewählt und kann deaktiviert werden.)
  • hasDate

    Bei Feldschema-Antworten wird damit angezeigt, ob im Feld für Datum/Uhrzeit Datumsangaben enthalten sind.

  • hasDefaultSortField

    Bei Feldschema-Antworten ist dies eine Markierung, mit der angezeigt wird, ob das Feld eine Standardsortierung hat. Zu verwenden mit defaultSortOrder.

  • hasError

    Mit dieser Markierung wird angezeigt, dass ein Fehler überprüft werden muss.

  • hasPrompts

    Bei Antworten von Suchergebnis-Operationen zeigt diese Markierung an, dass eine gespeicherte Abfrage Aufforderungen enthält.

  • hasTime

    Bei Feldschema-Antworten wird damit angezeigt, ob im Feld für Datum/Uhrzeit Uhrzeiten enthalten sind.

  • height

    Bei Requests von Operationen zum Abrufen eines Galeriebilds ist dies die Höhe eines Symbols.

  • historyNotes

    Hinweise bei Requests von Queue-Operationen, die dem Verlaufsprotokoll des Elements hinzuzufügen sind.

  • historyRecId

    Bei Antworten auf Queue-Operationen ist dies die Datensatz-ID des Business Objekts mit der Historie.

  • historyText

    Bei Antworten auf Queue-Operationen ist dies der Text des Historiendatensatzes des Elements.

  • historyTypeId

    Bei Antworten auf Queue-Operationen ist dies die ID des Business Objekts, das die Historie enthält.

  • id

    Bei Operationen mit mobilen Formularen ist dies interne ID von Aktionen, die für das Formular verfügbar sind.

  • Bild

    Bei Sicherheitsoperations-Requests ist dies das einem Team zugewiesene Bild.

  • includeAll

    Bei Requests von Business Objekt-Operationen ist dies eine Markierung, mit der alle Felder in Business Objekt-Vorlagen eingeschlossen werden.

  • includeAllFields

    Bei Requests von Suchoperationen ist dies eine Markierung, mit der alle Felder in Ad-hoc-Suchergebnissen eingeschlossen werden.

  • IncludeAvailableInSpecific

    Bei Antworten von Schnellsuch-Operationen zeigt diese Markierung an, ob verfügbare Elemente der Schnellsuche enthalten sind.

  • includelinks

    Mit dieser Markierung werden Hyperlinks in Ergebnissen angefordert. Der Standardwert ist „Falsch“.

  • IncludeQuickSearchInSpecific

    Bei Antworten von Schnellsuch-Operationen bezieht diese Markierung alle Elemente der Schnellsuche in spezifischen Suchen ein.

  • includerelationships

    Bei Requests von Business Objekt-Operationen ist dies eine Markierung, die Schemas für alle verknüpften Business Objekte einschließt. Der Standardwert ist „Falsch“.

  • includeRequired

    Bei Requests von Business Objekt-Operationen ist dies eine Markierung, mit der alle erforderlichen Felder in Business Objekt-Vorlagen angefordert werden.

  • includeSchema

    Bei Suchoperationen können Sie mit dieser Markierung das Tabellenschema der gespeicherten Suche einbeziehen. Bei der Einstellung „Falsch“ enthalten die Ergebnisse die Feld-ID und den Feldwert, jedoch keine Feldinformationen. Der Standardwert ist „Falsch“.

  • isBinary

    Bei Feldschema-Antworten ist dies eine Markierung, mit der angezeigt wird, dass das Feld Binärdaten wie zum Beispiel ein Bild enthält.

  • isBusObTarget

    Bei Antworten von Schnellsuch-Operationen zeigt diese Markierung an, dass die Schnellsuche auf einem Business Objekt (wahr) oder einer Dokumentenablage (falsch) basiert.

  • isCurrency

    Bei Feldschema-Antworten ist dies eine Markierung, mit der angezeigt wird, dass in einem Feld Währungswerte gespeichert werden.

  • isDateRange

    Bei Antworten von Suchergebnis-Operationen zeigt diese Markierung an, dass eine Aufforderung einen Datumsbereich enthält.

  • isDateTime

    Bei Feldschema-Antworten ist dies eine Markierung, mit der das Feld für Datum/Uhrzeit gekennzeichnet wird.

  • isFilterAllowed

    Bei Feldschema-Antworten ist dies eine Markierung, mit der angezeigt wird, dass das Filtern möglich ist.

  • isFullTextSearchable

    Bei Feldschema-Antworten ist dies eine Markierung, mit der angezeigt wird, ob die Volltextsuche für das Feld aktiviert ist.

  • isLogical

    Bei Feldschema-Antworten ist dies eine Markierung, mit der ein logisches Feld gekennzeichnet wird.

  • isNumber

    Bei Feldschema-Antworten ist dies eine Markierung, mit der ein Feld für Nummern gekennzeichnet wird.

  • isShortDate

    Bei Feldschema-Antworten ist dies eine Markierung, mit der angezeigt wird, dass das Feld für Datum/Uhrzeit nur Datumsangaben enthält.

  • isYesNoRight

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, ob das Recht einer Sicherheitsgruppe zulässig ist oder nicht.

  • isVisible

    Bei Feldschema-Antworten ist dies eine Markierung, mit der angezeigt wird, ob das Feld sichtbar ist.

  • key

    Bei Antworten von Schnellsuch-Operationen ist dies der Name eines zur Sortierung verwendeten Feldes.

  • label

    Bei Operationen mit mobilen Formularen ist dies der Anzeigename für Felder.

  • lastPasswordResetDate

    Bei Sicherheits-Operationsantworten ist dies das Datum, an dem das Kennwort eines Benutzers zuletzt zurückgesetzt wurde.

  • lastPasswordResetTime

    Bei Sicherheits-Operationsantworten ist dies der Zeitpunkt, zu dem das Kennwort eines Benutzers zuletzt zurückgesetzt wurde.

  • latitude

    Bei Antworten von Operationen mit mobilen Formularen ist dies der Breitengrad für einen spezifischen Business Objekt-Datensatz (falls Standorterkennung aktiviert ist).

  • links

    Bei Requests werden mit dieser Markierung Hyperlinks in Ergebnissen angefordert. Der Standardwert ist „Falsch“.

    Bei Antworten ist dies eine Liste von Links einschließlich Namen und URL.

  • dlapRequired

    Bei Sicherheits-Operations-Requests zeigt diese Markierung an, ob die Active Directory-Gruppenzugehörigkeit erforderlich ist.

  • listDisplayOption
    Bei Antworten von Suchergebnis-Operationen ist dies die Listenanzeigeoption für eine Aufforderung:
    • 0 = Auto
    • 1 = Einfaches Textfeld
    • 2 = Liste der Werte in einem Kombinationsfeld
    • 3 = Liste der Werte in einem Raster
    • 4 = Liste der Werte in einer einfachen Liste
  • listReturnFieldId

    Bei Antworten von Suchergebnisoperationen ist dies die interne ID für das ausgegebene Feld, wenn die Aufforderungsliste ein Raster ist.

  • localizedScopeName

    Bei Antworten von Suchelement-Operationen ist dies ein übersetzter Bereichsname basierend auf den dem Benutzer zugewiesenen Regionaleinstellungen.

  • locationInformation

    Bei Antworten von Operationen mit mobilen Formularen ist dies eine Liste von Standortobjekten für einen spezifischen Business Objekt-Datensatz.

  • loginId

    Benutzername.

  • lookup

    Bei Business Objekt-Operationen ist dies eine Markierung, die auf den Business-Objekt-Typ „Lookup“ verweist.

  • longitude

    Bei Antworten von Operationen mit mobilen Formularen ist dies der Längengrad für einen spezifischen Business Objekt-Datensatz (falls Standorterkennung aktiviert ist).

  • major

    Bei Business Objekt-Operationen ist dies eine Markierung, die auf den Business-Objekt-Typ „Major“ verweist.

  • managerOfOwnerEdit

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, ob ein Abteilungsmitglied die Business Objekt-Datensätze oder Felder in diesen Datensätzen bearbeiten kann.

  • managerOfOwnerView

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, ob ein Abteilungsmitglied die Business Objekt-Datensätze oder Felder in diesen Datensätzen anzeigen kann.

  • maximumSize

    Bei Feldschema-Antworten für Textfelder ist dies die maximal zugelassene Anzahl an Zeichen.

  • mobileClientCustomViewId

    Gilt nicht für REST API.

  • multiline

    Bei mobilen Formularen ist dies eine Markierung, mit der angezeigt wird, ob ein Feld mehrere Zeilen umfassen kann.

    Bei Aufforderungen ist dies eine Markierung, mit der angezeigt wird, ob eine Textaufforderung mehrere Zeilen umfassen kann.

  • name

    Der Anzeigename für ein Objekt.

  • nextPasswordResetDate

    Bei Sicherheitsoperationen ist dies das Datum, zu dem Benutzer das Kennwort ändern müssen.

  • nonFinalStateOption

    Bei Antworten von Schnellsuch-Konfigurationsoperationen zeigt diese Markierung an, ob geschlossene Datensätze ausgenommen sind. Wahr schließt geschlossene Datensätze aus. Verwenden Sie den Optionsschlüssel, um festzulegen, ob Sie diese Option ändern können.

    Optionsschlüssel:
    • 0 = None (Nicht ausgewählt und kann nicht ausgewählt werden.)
    • 1 = Use (Ausgewählt und kann nicht deaktiviert werden.)
    • 2 = Display (Nicht ausgewählt und kann ausgewählt werden.)
    • 3 = UseAndDisplay (Ausgewählt und kann deaktiviert werden.)
  • nonScopeOwnerAdd

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, dass Benutzer die Rechte zum Hinzufügen von Elementen haben, die sie nicht besitzen.

  • nonScopeOwnerDelete

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, dass Benutzer die Rechte zum Löschen von Elementen haben, die sie nicht besitzen.

  • nonScopeOwnerEdit

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, dass Benutzer die Rechte zum Bearbeiten von Elementen haben, die sie nicht besitzen.

  • nonScopeOwnerView

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, dass Benutzer die Rechte zum Anzeigen von Elementen haben, die sie nicht besitzen.

  • offset

    Bei Anhang-Upload-Requests für Business Objekte ist dies der Startindex des hochzuladenden Dateiteils. Beim ersten Teil sollte der Versatz gleich Null sein.

  • operator

    Eine Zeichenfolge, mit der Filter ausgewertet werden können.

  • owner

    Die interne ID für die Business Objekt-Verknüpfung.

  • ownerEdit

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, ob ein Besitzer die Business Objekt-Datensätze oder Felder in diesen Datensätzen bearbeiten kann.

  • ownerView

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, ob ein Besitzer die Business Objekt-Datensätze oder Felder in diesen Datensätzen anzeigen kann.

  • pageNumber

    Die Seitenanzahl für die Ergebnismenge, die zurückgegeben werden soll.

  • pageSize

    Die Anzahl von Zeilen, die pro Seite zurückgegeben werden sollen.

  • parentbusobid

    Die interne ID für den übergeordneten Business Objekt-Typ.

  • parentBusObPublicId

    Die öffentliche ID für das übergeordnete Business Objekt.

  • parentbusobrecid

    Die Datensatz-ID für das übergeordnete Business Objekt.

  • parentFolderId

    Bei Antworten von Suchelementoperationen ist dies der Name oder die interne ID eines Ordners, der gespeicherte Abfragen enthält.

  • password

    Das dem Benutzerkonto zugewiesene Kennwort.

  • passwordNeverExpires

    Bei Sicherheitsoperationen zeigt diese Markierung an, ob das Kennwort eines Benutzers abläuft oder nicht.

  • primaryBusObId

    Bei Sicherheits-Operationsantworten ist dies die interne ID für das der Rolle zugewiesene primäre Business Objekt.

  • promptId

    Bei Suchoperationen ist dies die interne ID oder der Name einer Aufforderung.

  • promptName

    Bei Suchoperationen ist dies der Anzeigename einer Aufforderung.

  • prompts

    Bei Antworten von Suchergebnis-Operationen ist dies eine Liste von Objekten, die mit Aufforderungen verknüpft sind.

  • promptType
    Bei Antworten von Suchergebnis-Operationen ist dies der Typ der Aufforderung:
    • 1 = Text
    • 2 = Nummer
    • 3 = Datum/Uhrzeit
    • 4 = Logischer Wert
    • 5 = Datum
    • 6 = Zeit
  • promptValue

    Bei Antworten von Suchoperationen ist dies der Standardwert für eine Aufforderung.

  • promptValues

    Bei Requests von Suchoperationen ist dies eine Aufforderungs-ID und ein Wert. Dies kann eine Liste mit mehreren Aufforderungen sein, die für jeden Request erforderlich sind.

    Bei Antworten von Schnellsuch-Operationen ist dies eine Liste von Werten, aus denen gewählt werden muss. Werte werden jedoch nicht während der Laufzeit verarbeitet.

  • publicid/publicId

    Bei Business Objekt-Operationen ist dies die öffentliche ID, die verwendet wird, um Business Objekt-Datensätze zu identifizieren.

    Bei Sicherheitsoperationen ist dies die öffentliche ID, die verwendet wird, um Benutzer zu identifizieren.

  • queueStandInKey

    Bei Queue-Operationen ist dies der interne Schlüssel einer Queue abgeleitet von deren Bereich, Bereichsbesitzer und Ordner.

  • quickSearchId

    Bei Antworten von Schnellsuch-Operationen ist dies die interne ID der Konfiguration einer Schnellsuche.

  • quickSearchItems

    Bei Antworten von Schnellsuch-Operationen ist dies ein Satz von Objekten für jede Schnellsuch-Konfiguration.

  • quickSearchWatermark

    Bei Antworten von Schnellsuch-Operationen ist dies der im Steuerelement der Schnellsuche angegebene Text.

  • readOnly

    Bei Feldschema-Antworten ist dies eine Markierung, mit der angezeigt wird, ob das Feld schreibgeschützt (wahr) oder bearbeitbar (falsch) ist.

  • readRequests

    Eine Liste von readRequest-Objekten, mit denen eine Gruppe von Elementen (z. B. Business Objekte oder Benutzer) zurückgegeben werden kann.

  • recIdFields

    Die für ein Business Objekt festgelegten Felder der Datensatz-ID.

  • refresh_token

    Bei Token-Operationen ist dies das Aktualisierungstoken, durch das ein weiteres Zugriffstoken erteilt wird.

  • relatedBusinessObjects

    Bei Business Objekt-Operationen ist dies eine Liste von Objekten für verknüpfte Business Objekte.

  • relationshipid

    Die interne Beziehungs-ID für das verknüpfte Business Objekt.

  • required

    Mit dieser Markierung wird angezeigt, dass ein Element erforderlich (wahr) oder optional (falsch) ist.

  • resolvedQuickSearchWatermark

    Bei Antworten von Schnellsuch-Operationen ist dies der im Steuerelement der Schnellsuche angegebene Text. Benutzerdefinierter Text wird angezeigt, falls vorhanden.

  • rightId

    Bei Sicherheits-Operationsantworten ist dies die interne ID für das Recht einer Sicherheitsgruppe.

  • rightName

    Bei Sicherheits-Operationsantworten ist dies der interne Name für ein Recht.

  • roleId

    Bei Sicherheits-Operationsantworten ist dies die interne ID für eine Rolle.

  • roleName

    Bei Sicherheits-Operationsantworten ist dies der Anzeigename für eine Rolle.

  • roles

    Bei Sicherheits-Operationsantworten ist dies eine Liste von Objekten verbunden mit Rollen.

  • rowColor

    Bei Antworten von Schnellsuch-Operationen ist dies die Zeilenfarbe für einen Datensatz in den Suchergebnissen.

  • rows

    Bei Antworten von Schnellsuch-Operationen ist dies eine Liste von Datensätzen, die basierend auf Suchkriterien ausgegeben wird.

  • saveRequests

    Eine Liste von saveRequest-Objekten, die verarbeitet werden.

  • scanCode

    Der Scan-Code für einen spezifischen Business Objekt-Datensatz.

  • scope

    Der Name oder die interne ID des Bereichs eines Elements. Zum Umfang gehören z.B. Global und Team.

  • scopeowner

    Die interne ID oder der Name des Bereichsbesitzers. Ist Team beispielsweise der Umfang, dann könnte 1st-Level-Support der Umfangsbesitzer sein.

  • searchAnyWordsOption

    Bei Antworten von Schnellsuch-Konfigurationsoperationen zeigt diese Markierung an, ob ein Wort oder alle Wörter in einer Abfrage verwendet werden. Verwenden Sie den Optionsschlüssel, um festzulegen, ob Sie diese Option ändern können.

    Optionsschlüssel:
    • 0 = None (Nicht ausgewählt und kann nicht ausgewählt werden.)
    • 1 = Use (Ausgewählt und kann nicht deaktiviert werden.)
    • 2 = Display (Nicht ausgewählt und kann ausgewählt werden.)
    • 3 = UseAndDisplay (Ausgewählt und kann deaktiviert werden.)
  • searchAttachmentsOption

    Bei Antworten von Schnellsuch-Konfigurationsoperationen zeigt diese Markierung an, ob Anhänge abgefragt werden. Verwenden Sie den Optionsschlüssel, um festzulegen, ob Sie diese Option ändern können.

    Optionsschlüssel:
    • 0 = None (Nicht ausgewählt und kann nicht ausgewählt werden.)
    • 1 = Use (Ausgewählt und kann nicht deaktiviert werden.)
    • 2 = Display (Nicht ausgewählt und kann ausgewählt werden.)
    • 3 = UseAndDisplay (Ausgewählt und kann deaktiviert werden.)
  • searchID

    Bei Suchoperationen ist dies die interne ID einer gespeicherten Abfrage.

  • searchName

    Bei Suchoperationen ist dies der Anzeigename einer gespeicherten Abfrage.

  • searchRelatedOptions

    Bei Antworten von Schnellsuch-Konfigurationsoperationen zeigt diese Markierung an, ob verknüpfte Business Objekte abgefragt werden. Verwenden Sie den Optionsschlüssel, um festzulegen, ob Sie diese Option ändern können.

  • searchResultsFields

    Bei Antworten von Suchergebnis-Operationen ist dies eine Liste von Feldschema-Objekten.

  • searchResultsFieldValues

    Bei Antworten von Schnellsuch-Operationen ist dies eine Liste von Feldwert-Objekten, die für eine spezifische Suche ausgegeben werden. Objekte sind „fieldId“, Name, Wert, und die „dirty“-Markierung.

  • searchTargetId

    Bei Antworten von Schnellsuch-Operationen ist dies die abzufragende Business Objekt-ID oder Dokumentenablage.

  • searchTargetType

    Bei Antworten von Schnellsuch-Operationen ist dies entweder Business Objekt oder Dokumentenablage.

  • searchTerm/searchText

    Bei Suchoperationen ist dies eine Textzeichenfolge zum Filtern der Suchergebnisse.

  • SecurityGroupId

    Bei Sicherheitsoperationen ist dies die interne ID für eine Sicherheitsgruppe.

  • securityGroups

    Bei Sicherheits-Operationsantworten ist dies eine Liste von Objekten verbunden mit Sicherheitsgruppen.

  • sectionFields

    Bei Operationen mit mobilen Formularen ist dies eine Liste von Feldern und Attributen für alle Abschnitte eines Formulars.

  • sections

    Bei Operationen mit mobilen Formularen ist dies eine Liste von Abschnitten, die auf einem Formular verfügbar sind.

  • selectedChangeLimit
    Bei Requests bei Schnellsuch-Operationen ist dies der Änderungszeitrahmen für die Abfrage. Beispiel:
     {
              "displayName": "Yesterday",
              "units": "Days",
              "value": -1
            },

    Mögliche Werte basieren auf der Einheit. Im obenstehenden Beispiel ist -1 für die Einheit „Tage“ gleich heute minus 1 Tag.

  • selectedSortByFieldId

    Bei Requests bei Schnellsuch-Operationen ist dies die fieldID eines Feldes, das zum Sortieren von Ergebnissen verwendet wird.

  • shortDisplayName

    Bei Sicherheits-Operationsantworten ist dies der Anzeigename für ein Benutzer.

  • simpleResultsListItems

    Bei Antworten von Schnellsuch-Operationen ist dies eine Liste von Datensätzen, die für eine Abfrage ausgegeben werden.

  • smartClientCustomViewId

    Bei Sicherheits-Operationsantworten ist dies die interne ID für die Desktop Client-Ansicht, die der Rolle zugewiesen ist.

  • sortable

    Bei Feldschema-Antworten ist dies eine Markierung, mit der angezeigt wird, ob das Feld sortierbar (wahr) oder nicht sortierbar (falsch) ist.

  • sortByFields

    Bei Antworten von Schnellsuch-Konfigurationsoperationen ist dies eine Liste von vordefinierten Optionen, die für eine Suche verfügbar sind.

  • sortByOption

    Bei Antworten von Schnellsuch-Konfigurationsoperationen zeigt diese Option an, ob die Sortierung möglich ist. Verwenden Sie den Optionsschlüssel, um festzulegen, ob Sie diese Option ändern können.

    Optionsschlüssel:
    • 0 = None (Nicht ausgewählt und kann nicht ausgewählt werden.)
    • 1 = Use (Ausgewählt und kann nicht deaktiviert werden.)
    • 2 = Display (Nicht ausgewählt und kann ausgewählt werden.)
    • 3 = UseAndDisplay (Ausgewählt und kann deaktiviert werden.)
  • sortDirection
    Bei Suchoperationen sind die möglichen Werte:
    • 0 = Keine Sortierung
    • 1 = Aufsteigend
    • 2 = Absteigend
  • sorting

    Bei Suchoperationen ist dies ein Satz von Objekten zum Sortieren der Suchergebnisse.

  • sortOrder

    Bei Feldschema-Antworten wird hiermit angegeben, ob die Sortierreihenfolge aufsteigend oder absteigend ist.

  • specificSearchItems

    Bei Antworten von Schnellsuch-Konfigurationsoperationen ist dies eine Liste von Optionen und Einstellungen für bestimmte Business Objekt-Schnellsuchen.

  • standardRightName

    Bei Sicherheits-Operationsantworten ist dies der interne Name für ein Recht, dem die Kategorie des Rechts vorangestellt ist.

  • standInKey

    Bei Kernoperationen ist dies der interne Schlüssel einer Queue abgeleitet von deren Bereich, Bereichsbesitzer und Ordner.

  • stateFieldId

    Bei Antworten von Business Objekt-Operationen ist dies die interne ID für das Status-Feld, das für den Business Objekt-Zyklus festgelegt ist.

  • states

    Bei Antworten von Business Objekt-Operationen sind dies die Anzeigenamen für Status-Werte, die für den Business Objekt-Zyklus definiert werden.

  • stopOnError

    Mit dieser Markierung wird angezeigt, ob bei einem Fehler gestoppt oder fortgefahren wird.

  • storageName

    Bei Feldschema-Antworten ist dies der für ein Feld verwendete Datenbankname.

  • subtitle

    Bei Antworten von Schnellsuch-Operationen ist dies der zuletzt geänderte Untertitel für den Suchergebnis-Datensatz.

  • supportedAssociations

    Bei Antworten von Suchelement-Operationen ist dies eine Liste von Business Objekten, die mit dem abgefragten Business Objekt verknüpft sind.

  • supporting

    Bei Business Objekt-Operationen ist dies eine Markierung, die auf den Business-Objekt-Typ „Supporting“ hinweist.

  • systemDateTime

    Bei Antworten für Service-Informationen ist dies das aktuelle Datum und die Uhrzeit für den CSM-Server im UTC-Format.

  • targetId

    Bei Antworten von Schnellsuch-Operationen ist dies die abzufragende Business Objekt-ID.

  • targetBusObId

    Bei Operationen mit mobilen Formularen ist dies die Business Objekt-ID des Business Objekt-Typs.

  • targetBusObRecId

    Bei Operationen mit mobilen Formularen ist dies die Datensatz-ID des Business Objekts.

  • teamEdit

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, ob ein Teammitglied die Business Objekt-Datensätze oder Felder in diesen Datensätzen bearbeiten kann.

  • teamId

    Bei Sicherheitsoperationen ist dies die interne ID für ein Team.

  • teamManagerOfOwnerEdit

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, ob ein Teammanager Felder in Business Objekt-Datensätzen bearbeiten kann.

  • teamManagerOfOwnerView

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, ob ein Teammanager Felder in Business Objekt-Datensätzen anzeigen kann.

  • teamName

    Bei Sicherheits-Operationsantworten ist dies der Anzeigename für ein Team.

  • teams

    Bei Sicherheits-Operationsantworten ist dies eine Liste von Objekten verbunden mit Teams.

  • teamType
    Bei Sicherheits-Operationen ist dies der Teamtyp:
    • User = User Teams
    • CustomerWorkgroup = Customer Workgroups
  • teamView

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, ob ein Teammitglied die Business Objekt-Datensätze oder Felder in diesen Datensätzen anzeigen kann.

  • text

    Bei Antworten von Suchergebnis-Operationen ist dies der im Aufforderungsfenster angezeigte Text.

  • timeZone

    Bei Service-Informations-Antworten ist dies die Zeitzone für den CSM-Anwendungsserver. Zurückgesendete Daten sind eine Serie der Klasse ".NET TimeZoneInfo".

  • title

    Bei Operationen mit mobilen Formularen ist dies der Anzeigename eines Business Objekts.

    Bei Antworten von Schnellsuch-Operationen sind dies die Suchkriterien für eine einfache Textsuche.

  • token_type

    Bei Token-Operationen ist dies der Tokentyp. Aktuell ist der Typ immer „bearer“.

  • totalRecords

    Bei Gruppen-Löschoperationen ist dies die Gesamtzahl der gelöschten Datensätze.

  • totalRows

    Bei Antworten von Suchergebnis-Operationen ist dies die Anzahl der Datensätze, die von einer Suche ausgegeben werden.

  • totalsize

    Bei Business Objekt-Anhangoperationen ist dies die Größe der Datei in Byte.

  • type (Attachments)
    Der Typ des Datensatz-Anhangs:
    • 0 = None: Gilt nicht für REST API.
    • 1 = File: Verknüpfte Dateien.
    • 2 = FileManagerFile: Importierte Dateien.
    • 3 = BusOb: Angehängte Business Objekte.
    • 4 = History: Informationen zum Anhang, falls verfügbar.
    • 5 = Other: Gilt nicht für REST API.
  • type (Business Objects)
    Der Typ des Business Objekts:
    • Alle
    • Major
    • Supporting
    • Lookup
    • Gruppen
  • type (Fields)/fieldType

    Der Feldtyp (Text, Datum/Uhrzeit usw.).

  • uncFilePath

    Bei Business Objekt-Anhangoperationen ist dies ein Dateipfad zu einem mit einem Business Objekt verknüpften Anhang.

  • url

    Eine URL-Zeichenfolge.

  • usedefaultgrid

    Mit dieser Markierung wird die Verwendung des Standardrasters verbundener Business Objekte für die Liste der zurückgegebenen Felder ausgelöst.

  • userCannotChangePassword

    Bei Sicherheitsoperationen zeigt diese Markierung an, dass die Benutzer ihr Kennwort nicht ändern können.

  • userInfoFields

    Bei Sicherheitsoperationen ist dies eine Liste von Objekten verbunden mit Benutzerinformationsfeldern.

  • userIsTeamManager

    Bei Sicherheitsoperationen zeigt diese Markierung an, dass ein Benutzer Manager eines Teams ist.

  • userMustChangePasswordAtNextLogin

    Bei Sicherheitsoperationen zeigt diese Markierung an, dass die Benutzer beim nächsten Anmeldevorgang ihr Kennwort ändern müssen.

  • username

    Benutzernamen eines CSM-Benutzers.

  • userrecordid/userRecID

    Die interne ID eines CSM-Benutzers.

  • useSortBy

    Bei Antworten von Schnellsuch-Operationen zeigt diese Markierung an, ob sortiert werden soll (wahr) oder nicht (falsch).

  • validated

    Bei Feldschema-Antworten ist dies eine Markierung, mit der angezeigt wird, ob die Validierung für das Feld festgelegt ist. Unter Details finden Sie Informationen zur Validierung.

  • value

    Eine Zeichenfolge, die verwendet wird, um einen Wert zu kennzeichnen oder Ergebnisse zu filtern.

  • view

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, ob Anzeigerechte bestehen.

  • viewRunOpen

    Bei Sicherheits-Operationsantworten zeigt diese Markierung an, ob die Sicherheitsgruppe bei spezifischen Rechten die Optionen „Ausführen“, „Ansicht“ oder „Öffnen“ hat.

  • watermarkText

    Bei Antworten von Schnellsuch-Operationen ist dies der im Steuerelement der Schnellsuche für spezifische Suchen angegebene Text.

  • wholeDigits

    Bei Feldschema-Antworten wird hiermit die Anzahl der ganzen Zahlen angegeben, die für Nummernfelder festgelegt wurden.

  • width

    Bei Requests von „Galeriebild abrufen“-Operationen ist dies die Breite eines Symbols.

  • windowsUserId

    Bei Sicherheitsoperationen ist dies die interne ID für einen CSM-Benutzer.

© 2017 Cherwell Software, LLC. Alle Rechte vorbehalten.