Vorheriges Thema: IN-KlauselNächstes Thema: XML-Objektrückgaben


Web-Service-Methoden

Dieser Abschnitt enthält Details zur Verwendung der Webservices-Methoden. Für jede Methode werden die Parameter, die Beschreibung sowie die Rückgaben erläutert.

Wichtig! Weitere Informationen zu Webservices finden Sie im Implementierungshandbuch.

Dieses Kapitel enthält folgende Themen:

Zusammenfassung der Webservices-Methoden

XML-Objektrückgaben

Kontaktverwaltungsmethoden

Gruppenverwaltungsmethoden

Geschäftsmethoden

Anlagenverwaltungsmethoden

Listen-/Abfragemethoden

LREL-Methoden

Knowledge Management

Sonstige Methoden

Workflow-Methoden

Anhängemethoden

REST-HTTP-Methoden

Zusammenfassung der Webservices-Methoden

Folgende Tabelle gibt eine Zusammenfassung der Webservices-Methoden im Produkt an:

Methodenname (Eingabeparameter)

Rückgabetyp [XML-Stammelement]

Ausgabeparameter (Typ: StringHolder) [XML-Stammelement]

Beschreibung

addAssetLog

(int sid, String assetHandle, String contactHandle, String logText)

void

 

Fügt einen neuen Protokolleintrag einer Anlage hinzu.

addBookmark

(int sid, String contactId, int docId)

Zeichenfolge

[UDSObject]

 

Fügt ein Lesezeichen in ein Knowledge-Dokument hinzu.

addComment

(int sid, String comment, int docId, String email, String username, String contactId)

Zeichenfolge

[UDSObject]

 

Fügt einen Kommentar zu einem Knowledge-Dokument hinzu.

addMemberToGroup

(int sid, String contactHandle, String groupHandle)

void

 

Fügt einer Gruppe einen Kontakt hinzu.

attachChangeToRequest

(int sid, String creator, String requestHandle, String changeHandle, ArrayOfString changeAttrVals, String description)

Zeichenfolge

 

Hängt einen neuen oder vorhandenen Change an einen Request an.

attachURLLink

(int sid, int docId, String url, String attmntName, String description)

int

 

Hängt eine URL-Verknüpfung an ein Knowledge-Dokument an.

attmntFolderLinkCount

(int sid, int folderId)

int

 

Gibt die Anzahl der Anhangsverknüpfungen für einen Ordner zurück.

callServerMethod

(int sid, String methodName, String factoryName, String formatList, ArrayOfString parameters)

Zeichenfolge

[ServerReturn]

 

Ruft eine beliebige serverseitige Methode auf.

changeStatus

(int sid, String creator, String objectHandle, String description, String newStatusHandle)

Zeichenfolge

[UDSObject

(Handle only)]

 

Führt eine Aktualisierung der Statusaktivität eines Tickets aus.

clearNotification

(int sid, String lrObject, String clearBy)

int

 

Löscht den Inhalt einer Benachrichtigungsmeldung.

closeTicket

(int sid, String description, String ticketHandle)

Zeichenfolge

[UDSObject

(Handle only)]

 

Legt den Status des Tickets auf "Geschlossen" fest.

createActivityLog

(int sid, String creator, String objectHandle, String description, String logType, int timeSpent, boolean internal)

Zeichenfolge

[UDSObject

(Handle only)]

 

Erstellt einen Aktivitätsprotokolleintrag für ein Ticket.

createAsset

(int sid, ArrayOfString attrVals, ArrayOfString attributes, StringHolder createAssetResult, StringHolder newAssetHandle, StringHolder newExtensionHandle, StringHolder newExtensionName)

void

createAssetResult

[UDSObject]

newAssetHandle

newExtensionHandle

newExtensionName

Erstellt ein Configuration Item (Asset).

createAssetParentChildRelationship

(int sid, String parentHandle, String childHandle)

Zeichenfolge

 

Erstellt eine Beziehung für ein über-/untergeordnetes Asset.

createAttachment

(int sid, String repositoryHandle, String objectHandle, String description, String fileName)

Zeichenfolge

 

Lädt eine Datei auf den Backend-Server hoch, und hängt sie einem Ticket an.

createAttmnt

(int sid, String repositoryHandle, int folderId, int objectHandle, String description, String fileName)

Zeichenfolge

 

Lädt eine Datei auf den Backend-Server hoch, und hängt sie einem Knowledge-Dokument an.

createChangeOrder

(int sid, String creatorHandle, ArrayOfString attrVals, ArrayOfString propertyValues, String template, ArrayOfString attributes, StringHolder newChangeHandle, StringHolder newChangeNumber)

Zeichenfolge

[UDSObject]

newChangeHandle

newChangeNumber

Erstellt ein Change-Ticket.

createDocument

(int sid, ArrayOfString kdAttributes)

Zeichenfolge

[UDSObjectList]

 

Erstellt ein Knowledge-Dokument.

createFolder

(int sid, int parentFolderId, int repId, int folderType, String description, String folderName)

Zeichenfolge

[UDSObject]

 

Erstellt einen Ordner in einem Anhangs-Repository.

createIssue

(int sid, String creatorHandle, ArrayOfString attrVals, ArrayOfString propertyValues, String template, ArrayOfString attributes, StringHolder newIssueHandle, StringHolder newIssueNumber)

 

Zeichenfolge

[UDSObject]

newIssueHandle

newIssueNumber

Erstellt ein Issue-Ticket.

createLrelRelationships

(int sid, String contextObject, String lrelName, ArrayOfString addObjectHandles)

void

 

Fügt eine oder mehrere m:m-Beziehungen hinzu.

createObject

(int sid, String objectType, ArrayOfString attrVals, ArrayOfString attributes, StringHolder createObjectResult, StringHolder newHandle)

void

createObjectResult

[UDSObject]

newHandle

Erstellt ein CA SDM-Objekt.

createQuickTicket

(int sid, String customerHandle, String description, StringHolder newTicketHandle, StringHolder newTicketNumber)

Zeichenfolge

[UDSObject]

newTicketHandle

newTicketNumber

Erstellt ein Ticket auf Grundlage des bevorzugten Dokumenttyps des Endanwenders.

createRequest

(int sid, String creatorHandle, ArrayOfString attrVals, ArrayOfString propertyValues, String template, ArrayOfString attributes, StringHolder newRequestHandle, StringHolder newRequestNumber)

Zeichenfolge

[UDSObject]

newRequestHandle

newRequestNumber

 

Erstellt ein Request-Ticket.

createTicket

(int sid, String description, String problem_type, String userid, String asset, String duplication_id, StringHolder newTicketHandle, StringHolder newTicketNumber, StringHolder returnUserData, StringHolder returnApplicationData)

Zeichenfolge

[UDSObject (empty)]

newTicketHandle

newTicketNumber

returnUserData

returnApplicationData

Erstellt ein Ticket auf Grundlage der Regeln, die in der Service-Aware-Richtlinie und im angegebenen Problemtyp definiert sind.

createWorkFlowTask

(int sid, ArrayOfString attrVals, String objectHandle, String creatorHandle, String selectedWorkFlow, String taskType, ArrayOfString attributes, StringHolder createWorkFlowTaskResult, StringHolder newHandle)

void

createWorkFlowTaskResult

[UDSObject]

newHandle

Erstellt eine Workflow-Aufgabe.

deleteBookmark

(int sid, String contactId, int docId)

int

 

Löscht ein Lesezeichen aus einem Knowledge-Dokument.

deleteComment

(int sid, int commentId)

int

 

Löscht einen Kommentar für ein Knowledge-Dokument.

deleteDocument

(int sid, int docId)

int

 

Kennzeichnet ein Knowledge-Dokument für die Löschung.

deleteWorkFlowTask

(int sid, String workFlowHandle, String objectHandle)

void

 

Entfernt eine Workflow-Aufgabe aus dem zugeordneten Ticket.

detachChangeFromRequest

(int sid, String creator, String requestHandle, String description)

Zeichenfolge

 

Trennt einen Change von einem Request.

doQuery

(int sid, String objectType, String whereClause)

ListResult

[listHandle, listLength]

 

Führt eine SQL-ähnliche Auswahl auf dem angegebenen Objekttyp durch.

doSelect

(int sid, String objectType, String whereClause, int maxRows, ArrayOfString attributes)

Zeichenfolge

[UDSObjectList]

 

Führt eine SQL-ähnliche Auswahl auf dem angegebenen Objekttyp durch.

doSelectKD

(int sid, String whereClause, String sortBy, boolean desc, int maxRows, ArrayOfString attributes, int skip)

Zeichenfolge

[UDSObjectList]

 

Führt eine SQL-ähnliche Auswahl auf dem Knowledge-Dokumentobjekt durch.

Eskalieren

(int sid, String creator, String objectHandle, String description, boolean setAssignee, String newAssigneeHandle, boolean setGroup, String newGroupHandle, boolean setOrganization, String newOrganizationHandle, boolean setPriority, String newPriorityHandle)

Zeichenfolge

[UDSObject

(Handle only)]

 

Führt die Aktivität "Eskalieren" auf einem Ticket aus.

faq

(int sid, String categoryIds, int resultSize, String propertyList, String sortBy, boolean descending, String whereClause, int maxDocIDs)

Zeichenfolge

[UDSObjectList]

 

Führt eine FAQ-Suche auf Knowledge-Dokumenten aus.

findContacts

(int sid, String userName, String lastName, String firstName, String email, String accessType, int inactiveFlag)

Zeichenfolge

[UDSObjectList]

 

Ruft eine Liste der Kontakte auf.

freeListHandles

(int sid, ArrayOfInt handles)

void

 

Gibt die serverseitigen Ressourcen für eine Liste frei und macht die Listenkennungen ungültig.

getAccessTypeForContact

(int sid, String contactHandle)

Zeichenfolge

 

Gibt eine Kennung für den Zugriffstyp des Kontakts zurück.

getArtifact

(int sid, String contact, String password)

Zeichenfolge

 

Gibt ein Artefakt für das Anhängen an URLs zurück.

getAssetExtensionInformation

(int sid, String assetHandle, ArrayOfString attributes, StringHolder getAssetExtInfoResult, StringHolder extensionHandle, StringHolder extensionName)

 

void

getAssetExtInfoResult

[UDSObject]

extensionHandle

extensionName

Gibt Erweiterungsinformationen für eine Anlage zurück.

getAttmntInfo

(int sid, int attmntId)

Zeichenfolge

[UDSObjectList]

 

Gibt die Attribute für einen Anhang zurück.

getAttmntList

(int sid, int folderId, int repId)

Zeichenfolge

[UDSObjectList]

 

Gibt eine Liste der Anhänge unter einem gegebenen Anhangordner zurück

getAttmntListPerKD

(int sid, int docId)

Zeichenfolge

[UDSObjectList]

 

Gibt eine Liste der Anhänge für ein bestimmtes Knowledge-Dokument zurück.

getBookmarks

(int sid, String contactId)

Zeichenfolge

[UDSObjectList]

 

Gibt Lesezeichen für einen bestimmten Kontakt zurück.

getBopsid

(int sid, String contact)

Zeichenfolge

 

Gibt ein Token für das Anhängen an URLs zurück.

getCategory

(int sid, int catId, boolean getCategoryPaths)

Zeichenfolge

[UDSObjectList]

 

Ruft Informationen für eine Knowledge-Kategorie ab.

getComments

(int sid, String docIds)

Zeichenfolge

[UDSObjectList]

 

Ruft alle Kommentare aus der Liste von Knowledge-Dokumenten ab.

getConfigurationMode

(int sid)

Zeichenfolge

 

Gibt Bestätigung zurück, wenn CA SDM im ITIL-Modus ausgeführt wird.

getContact

(int sid, String contactId)

Zeichenfolge

[UDSObject]

 

Ruft Informationen für einen bestimmten Kontakt ab.

getDecisionTrees

(int sid, String propertyList, String sortBy, boolean descending)

Zeichenfolge

[UDSObjectList]

 

Ruft alle Knowledge-Dokumente "Entscheidungsstruktur" ab.

getDependentAttrControls

(int sid, String handle, ArrayOfString attrVals)

Zeichenfolge

[UDSObjectList]

 

Gibt eine Liste von gesperrten und erforderlichen Attributen für das Statusobjekt zurück.

getDocument

(int sid, int docId, String propertyList, boolean relatedDoc, boolean getAttmnt, boolean getHistory, boolean getComment, boolean getNotiList)

Zeichenfolge

[UDSObject]

 

Ruft Informationen für ein Knowledge-Dokument ab.

getDocumentsByIDs

(int sid, String docIds, String propertyList, String sortBy, boolean descending)

Zeichenfolge

[UDSObjectList]

 

Ruft Informationen für ein oder mehrere Knowledge-Dokumente ab.

getDocumentTypes

(int sid)

Zeichenfolge

[UDSObjectList]

 

Gibt eine Liste aller Knowledge-Dokumenttypen zurück.

getFolderInfo

(int sid, int folderId)

Zeichenfolge

[UDSObject]

 

 

Ruft Informationen für einen bestimmten Anhangsordner ab.

getFolderList

(int sid, int parentFolderId, int repId)

Zeichenfolge

[UDSObjectList]

 

Gibt eine Liste der Ordner unter einem bestimmten übergeordneten Ordner zurück

getGroupMemberListValues

(int sid, String whereClause, int numToFetch, ArrayOfString attributes)

Zeichenfolge

[UDSObjectList]

 

Fragt die Gruppe der System- und Mitgliederbeziehung ab.

getHandleForUserid

(int sid, String userID)

Zeichenfolge

 

Gibt die permanente Kennung für einen Kontakt zurück.

getKDListPerAttmnt

(int sid, int attmntId)

Zeichenfolge

[UDSObjectList]

 

Gibt eine Liste der Knowledge-Dokumente mit Verweis auf einen Anhang zurück.

getListValues

(int sid, int listHandle, int startIndex, int endIndex, ArrayOfString attributeNames)

Zeichenfolge

[UDSObjectList]

 

Gibt Attributwerte für einen Bereich von Objekten in einer Liste zurück.

getLrelLength

(int sid, String contextObject, String lrelName)

int

 

Gibt die Anzahl der Objekte auf einer Seite einer m:m-Beziehung zurück.

getLrelValues

(int sid, String contextObject, String lrelName, int startIndex, int endIndex, ArrayOfString attributes)

Zeichenfolge

[UDSObjectList]

 

Gibt Attributwerte für einen Bereich von Objekten in einer m:m-Beziehung zurück.

getNotificationsForContact

(int sid, String contactHandle, int queryStatus)

ListResult

[listHandle, listLength]

 

Gibt eine Listenkennung der Benachrichtigungen ("lr"-Objekte) für einen bestimmten Kontakt zurück.

getObjectTypeInformation

(int sid, String factory)

Zeichenfolge

[UDSObject (special)]

 

Gibt eine Liste aller Attributnamen für ein bestimmtes Objekt zurück.

getObjectValues

(int sid, String objectHandle, ArrayOfString attributes)

Zeichenfolge

[UDSObject]

 

Gibt die Attributwerte für eine bestimmte Objektkennung zurück.

getPendingChangeTaskListForContact

(int sid, String contactHandle)

ListResult

[listHandle, listLength]

 

Gibt alle ausstehenden Change-Workflow-Aufgaben zurück, die einem bestimmten Kontakt zugewiesen sind.

getPendingIssueTaskListForContact

(int sid, String contactHandle)

ListResult

[listHandle, listLength]

 

Gibt alle ausstehenden Issue-Workflow-Aufgaben zurück, die einem Kontakt zugewiesen sind.

getPermissionGroups

(int sid, int groupId)

Zeichenfolge

[UDSObjectList]

 

Ruft Informationen für eine Berechtigungsgruppe ab.

getPolicyInfo

(int sid)

Zeichenfolge

[SAPolicy]

 

Gibt Informationen über die Zugriffsrichtlinie für die aktuelle Sitzung zurück.

getPriorities

(int sid)

Zeichenfolge

[UDSObjectList]

 

Ruft alle Knowledge-Prioritäten ab.

getPropertyInfoForCategory

(int sid, String categoryHandle, ArrayOfString attributes)

Zeichenfolge

[UDSObjectList]

 

Ruft Eigenschaftsinformationen für eine bestimmte Kategorie ab.

getQuestionsAsked

(int sid, int resultSize, boolean descending)

Zeichenfolge

[UDSObjectList]

 

Ruft den Verlauf der Suchtexte des Knowledge-Dokuments ab.

getRelatedList

(int sid, String objectHandle, String listName)

ListResult

[listHandle, listLength]

 

Gibt eine Listenkennung für eine Liste (QREL oder BREL) eines Objekts zurück.

getRelatedListValues

(int sid, String objectHandle, String listName, int numToFetch, ArrayOfString attributes, StringHolder getRelatedListValuesResult, IntHolder numRowsFound)

void

getRelatedListValuesResult

[UDSObjectList]

numRowsFound

(IntHolder)

Gibt Werte für Listen eines Objekts zurück.

getRepositoryInfo

(int sid, int repositoryId)

Zeichenfolge

[UDSObject]

 

Gibt Informationen eines Repositorys zurück.

getStatuses

(int sid)

Zeichenfolge

[UDSObjectList]

 

Ruft alle Knowledge-Status ab.

getTaskListValues

(int sid, String objectHandle, ArrayOfString attributes)

Zeichenfolge

[UDSObjectList]

 

Gibt Werte für Aufgaben zurück, die einem bestimmten Issue oder Change zugeordnet sind.

getTemplateList

(int sid)

Zeichenfolge

[UDSObjectList]

 

Ruft alle Dokumentvorlagen ab.

getValidTaskTransitions

(int sid, String taskHandle, ArrayOfString attributes)

Zeichenfolge

[UDSObjectList]

 

Gibt alle möglichen Statusübergänge für eine bestimmte Aufgabe zurück.

Gibt alle möglichen Statusübergänge für eine bestimmte Aufgabe zurück.

Zeichenfolge

[UDSObjectList]

 

Gibt alle möglichen Statusübergänge für ein bestimmtes Ticket zurück.

getWorkflowTemplateList

(int sid)

Zeichenfolge

[UDSObjectList]

 

Ruft alle Knowledge-Workflow-Vorlagen ab.

getWorkFlowTemplates

(int sid, String objectHandle, ArrayOfString attributes)

Zeichenfolge

[UDSObjectList]

 

Gibt alle Workflow-Vorlagen zurück, die einer Kategorie eines Change oder Issues zugeordnet sind.

impersonate

(int sid, String userid)

int

 

Macht die alte Sitzung ungültig, und gibt eine neue Sitzungs-ID für den neuen Anwender zurück.

isAttmntLinkedKD

(int sid, int attmntId)

int

 

Gibt die Anzahl der Anhangsverknüpfungen aller Knowledge-Dokumente zurück.

logComment

(int sid, String ticketHandle, String comment, int internalFlag)

void

 

Führt eine Protokollkommentaraktivität eines Ticket aus.

login

(String username, String password)

int

 

Authentifiziert einen Anwender und gibt eine eindeutige Sitzungs-ID zurück.

loginService

(String username, String password, String policy)

int

 

Authentifiziert einen Anwender und gibt eine eindeutige Sitzungs-ID zurück.

loginServiceManaged

(String policy, String encrypted_policy)

Zeichenfolge

 

Führt eine Anwenderauthentifizierung für PKI-Konfigurationen aus, und gibt eine Sitzungs-ID zurück.

loginWithArtifact

(String userid, String artifact)

int

 

Authentifiziert einen Anwender mit einem Artefakt, und gibt eine eindeutige Sitzungs-ID zurück.

logout

(int sid)

void

 

Macht eine Sitzungs-ID ungültig und gibt sie wieder frei.

modifyDocument

(int sid, int docId, ArrayOfString kdAttributes)

Zeichenfolge

[UDSObject]

 

Aktualisiert ein Knowledge-Dokument.

notifyContacts

(int sid, String creator, String contextObject, String messageTitle, String messageBody, int notifyLevel, ArrayOfString notifyees, boolean internal)

Zeichenfolge

[UDSObject (Handle only)]

 

Schickt eine Benachrichtigung an einen oder mehrere Kontakte.

rateDocument

(int sid, int docId, int rating, int multiplier, String ticketPerId, boolean onTicketAccept, boolean solveUserProblem, boolean isDefault)

Zeichenfolge

[UDSObjectList]

 

Stuft ein bestimmtes Knowledge-Dokument ein.

removeAttachment

(int sid, String attHandle)

int

 

Entfernt einen Anhang aus einem Ticket.

removeLrelRelationships

(int sid, String contextObject, String lrelName, ArrayOfString removeObjectHandles)

void

 

Entfernt eine oder mehrere m:m-Beziehungen.

removeMemberFromGroup

(int sid, String contactHandle, String groupHandle)

void

 

Entfernt einen Kontakt aus einer Gruppe.

Suche

(int sid, String problem, int resultSize, String properties, String sortBy, boolean descending, boolean relatedCategories, int searchType, int matchType, int searchField, String categoryPath, String whereClause, int maxDocIDs)

Zeichenfolge

[UDSObjectList (nested)]

 

Sucht nach Knowledge-Dokument-Lösungen.

serverStatus

(int sid)

int

 

Gibt den Status (in beide Richtungen) des CA SDM-Servers zurück.

transfer

(int sid, String creator, String objectHandle, String description, boolean setAssignee, String newAssigneeHandle, boolean setGroup, String newGroupHandle, boolean setOrganization, String newOrganizationHandle)

Zeichenfolge

[UDSObject

(Handle only)]

 

Führt eine Transferaktivität eines Ticket aus.

updateObject

(int sid, String objectHandle, ArrayOfString attrVals, ArrayOfString attributes)

Zeichenfolge

[UDSObject]

 

Aktualisiert ein oder mehrere Attribute für das angegebene Objekt.

updateRating

(int sid, int buId, int rate)

Zeichenfolge

[UDSObject]

 

Aktualisiert eine vorhandene Bewertung eines Knowledge-Dokuments.

loginWithArtifact

(String userid, String artifact)

int

 

Authentifiziert einen Anwender mit einem Artefakt, und gibt eine eindeutige Sitzungs-ID zurück.

getArtifact

(int sid, String contact, String password)

Zeichenfolge

 

Gibt ein Artefakt für das Anhängen an URLs zurück.