Argomento precedente: Clausola IN

Argomento successivo: Restituzione degli oggetti in formato XML

Metodi dei servizi Web

Questa sezione illustra in modo dettagliato l'utilizzo dei metodi dei servizi Web. Per ogni metodo vengono spiegati i parametri, la descrizione e i valori restituiti.

Importante Per ulteriori informazioni sui servizi Web, consultare la Guida all'implementazione.

Riepilogo dei metodi dei servizi Web

La tabella seguente fornisce un riepilogo dei metodi dei servizi Web nel prodotto:

Nome metodo (parametri di input)

Tipo di ripristino [elemento principale XML]

Parametri di output (Tipo: StringHolder) [elemento principale XML]

Descrizione

addAssetLog

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

void

 

Aggiunge una nuova voce del registro a un asset.

addBookmark

(int sid, String contactId, int docId)

Stringa

[UDSObject]

 

Aggiunge un segnalibro a un documento della conoscenza.

addComment

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

Stringa

[UDSObject]

 

Aggiunge un commento a un documento della conoscenza.

addMemberToGroup

(int sid, String contactHandle, String groupHandle)

void

 

Aggiunge un contatto a un gruppo.

attachChangeToRequest

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

Stringa

 

Associa un ordine di cambiamento nuovo o esistente a una richiesta.

attachURLLink

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

int

 

Associa un collegamento URL a un documento della conoscenza.

attmntFolderLinkCount

(int sid, int folderId)

int

 

Restituisce il numero di collegamenti agli allegati di una cartella.

callServerMethod

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

Stringa

[ServerReturn]

 

Richiama qualsiasi metodo arbitrario del server.

changeStatus

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

Stringa

[UDSObject

(Handle only)]

 

Esegue un'attività di aggiornamento dello stato su un ticket.

clearNotification

(int sid, String lrObject, String clearBy)

int

 

Cancella un messaggio di notifica.

closeTicket

(int sid, String description, String ticketHandle)

Stringa

[UDSObject

(Handle only)]

 

Imposta lo stato del ticket come chiuso.

createActivityLog

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

Stringa

[UDSObject

(Handle only)]

 

Crea una voce del registro delle attività per un ticket.

createAsset

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

void

createAssetResult

[UDSObject]

newAssetHandle

newExtensionHandle

newExtensionName

Crea un elemento della configurazione (asset).

createAssetParentChildRelationship

(int sid, String parentHandle, String childHandle)

Stringa

 

Crea una relazione padre-figlio per l'asset.

createAttachment

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

Stringa

 

Carica un file sul server di back-end e lo associa a un ticket.

createAttmnt

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

Stringa

 

Carica un file sul server di back-end e lo associa a un documento della conoscenza.

createChangeOrder

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

Stringa

[UDSObject]

newChangeHandle

newChangeNumber

Crea un ticket Ordine di cambiamento.

createDocument

(int sid, ArrayOfString kdAttributes)

Stringa

[UDSObjectList]

 

Crea un documento della conoscenza.

createFolder

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

Stringa

[UDSObject]

 

Crea una cartella in un repository allegati.

createIssue

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

 

Stringa

[UDSObject]

newIssueHandle

newIssueNumber

Creare un ticket Questione.

createLrelRelationships

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

void

 

Aggiunge una o più relazioni molti a molti.

createObject

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

void

createObjectResult

[UDSObject]

newHandle

Crea qualsiasi oggetto CA SDM.

createQuickTicket

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

Stringa

[UDSObject]

newTicketHandle

newTicketNumber

Crea un ticket in base al tipo di documento preferito dell'utente finale indicato.

createRequest

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

Stringa

[UDSObject]

newRequestHandle

newRequestNumber

 

Crea un ticket Richiesta.

createTicket

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

Stringa

[UDSObject (empty)]

newTicketHandle

newTicketNumber

returnUserData

returnApplicationData

Crea un ticket in base alle regole definite nella policy per il riconoscimento dei servizi e nel tipo di problema indicato.

createWorkFlowTask

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

void

createWorkFlowTaskResult

[UDSObject]

newHandle

Crea un'attività di flusso di lavoro.

deleteBookmark

(int sid, String contactId, int docId)

int

 

Elimina un segnalibro da un documento della conoscenza.

deleteComment

(int sid, int commentId)

int

 

Elimina un commento per un documento della conoscenza.

deleteDocument

(int sid, int docId)

int

 

Contrassegna un documento della conoscenza per l'eliminazione.

deleteWorkFlowTask

(int sid, String workFlowHandle, String objectHandle)

void

 

Rimuove un'attività del flusso di lavoro dal ticket associato.

detachChangeFromRequest

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

Stringa

 

Dissocia un ordine di cambiamento da una richiesta.

doQuery

(int sid, String objectType, String whereClause)

ListResult

[listHandle, listLength]

 

Esegue un'operazione di selezione di tipo SQL sul tipo di oggetto specificato.

doSelect

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

Stringa

[UDSObjectList]

 

Esegue un'operazione di selezione di tipo SQL sul tipo di oggetto specificato.

doSelectKD()

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

Stringa

[UDSObjectList]

 

Esegue un'operazione di selezione di tipo SQL sull'oggetto del documento della conoscenza.

escalate

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

Stringa

[UDSObject

(Handle only)]

 

Esegue un'attività di escalation stato su un ticket.

faq

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

Stringa

[UDSObjectList]

 

Esegue una ricerca di domande frequenti sui documenti della conoscenza.

findContacts

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

Stringa

[UDSObjectList]

 

Recupera un elenco dei contatti.

freeListHandles

(int sid, ArrayOfInt handles)

void

 

Rilascia le risorse del server per gli elenchi e invalida gli handle di elenco.

getAccessTypeForContact

(int sid, String contactHandle)

Stringa

 

Restituisce un handle per l'oggetto Tipo di accesso di un contatto.

getArtifact

(int sid, String contact, String password)

Stringa

 

Restituisce un artifact per l'aggiunta agli URL.

getAssetExtensionInformation

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

 

void

getAssetExtInfoResult

[UDSObject]

extensionHandle

extensionName

Restituisce le informazioni sull'estensione per un asset.

getAttmntInfo

(int sid, int attmntId)

Stringa

[UDSObjectList]

 

Restituisce gli attributi per un allegato.

getAttmntList

(int sid, int folderId, int repId)

Stringa

[UDSObjectList]

 

Restituisce un elenco di allegati in una cartella di allegati specifica.

getAttmntListPerKD

(int sid, int docId)

Stringa

[UDSObjectList]

 

Restituisce un elenco di allegati per un documento della conoscenza indicato.

getBookmarks

(int sid, String contactId)

Stringa

[UDSObjectList]

 

Recupera i segnalibri di un contatto indicato.

getBopsid

(int sid, String contact)

Stringa

 

Restituisce un token da aggiungere agli URL.

getCategory

(int sid, int catId, boolean getCategoryPaths)

Stringa

[UDSObjectList]

 

Recupera informazioni per una categoria della conoscenza.

getComments

(int sid, String docIds)

Stringa

[UDSObjectList]

 

Recupera tutti i commenti dall'elenco dei documenti della conoscenza.

getConfigurationMode

(int sid)

Stringa

 

Restituisce la conferma se CA SDM è in esecuzione in modalità ITIL.

getContact

(int sid, String contactId)

Stringa

[UDSObject]

 

Recupera le informazioni per un contatto indicato.

getDecisionTrees

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

Stringa

[UDSObjectList]

 

Recupera tutti i documenti della conoscenza della struttura decisionale.

getDependentAttrControls

(int sid, String handle, ArrayOfString attrVals)

Stringa

[UDSObjectList]

 

Restituisce un elenco di attributi bloccati e richiesti per l'oggetto Stato.

getDocument

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

Stringa

[UDSObject]

 

Recupera le informazioni per un documento della conoscenza.

getDocumentsByIDs

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

Stringa

[UDSObjectList]

 

Recupera le informazioni per uno o più documenti della conoscenza.

getDocumentTypes

(int sid)

Stringa

[UDSObjectList]

 

Restituisce un elenco di tutti i tipi di documenti della conoscenza.

getFolderInfo

(int sid, int folderId)

Stringa

[UDSObject]

 

 

Recupera le informazioni per una cartella allegati indicata.

getFolderList

(int sid, int parentFolderId, int repId)

Stringa

[UDSObjectList]

 

Restituisce un elenco di cartelle in una cartella padre indicata.

getGroupMemberListValues

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

Stringa

[UDSObjectList]

 

Effettua query al gruppo del sistema e alle relazione dei membri.

getHandleForUserid

(int sid, String userID)

Stringa

 

Restituisce l'handle persistente per un contatto.

getKDListPerAttmnt

(int sid, int attmntId)

Stringa

[UDSObjectList]

 

Restituisce un elenco di documenti della conoscenza con riferimento a un allegato indicato.

getListValues

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

Stringa

[UDSObjectList]

 

Restituisce i valori di attributo per un intervallo di oggetti in un elenco.

getLrelLength

(int sid, String contextObject, String lrelName)

int

 

Restituisce il numero di oggetti su un lato di una relazione di tipo molti a molti.

getLrelValues

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

Stringa

[UDSObjectList]

 

Restituisce i valori di attributo per un intervallo di oggetti in una relazione di tipo molti a molti.

getNotificationsForContact

(int sid, String contactHandle, int queryStatus)

ListResult

[listHandle, listLength]

 

Restituisce un handle di elenco di notifiche (oggetti lr) per un contatto indicato.

getObjectTypeInformation

(int sid, String factory)

Stringa

[UDSObject (special)]

 

Restituisce un elenco di tutti i nomi degli attributi per un oggetto indicato.

getObjectValues

(int sid, String objectHandle, ArrayOfString attributes)

Stringa

[UDSObject]

 

Restituisce i valori degli attributi per un handle di oggetto indicato.

getPendingChangeTaskListForContact

(int sid, String contactHandle)

ListResult

[listHandle, listLength]

 

Restituisce tutte le attività del flusso di lavoro dell'ordine di cambiamento in sospeso, assegnate a un contatto indicato.

getPendingIssueTaskListForContact

(int sid, String contactHandle)

ListResult

[listHandle, listLength]

 

Restituisce tutte le attività del flusso di lavoro dei problemi in sospeso, assegnate a un contatto.

getPermissionGroups

(int sid, int groupId)

Stringa

[UDSObjectList]

 

Recupera informazioni per un gruppo di autorizzazioni.

getPolicyInfo

(int sid)

Stringa

[SAPolicy]

 

Restituisce informazioni sulla policy di accesso per la sessione corrente.

getPriorities

(int sid)

Stringa

[UDSObjectList]

 

Recupera tutte le priorità della conoscenza.

getPropertyInfoForCategory

(int sid, String categoryHandle, ArrayOfString attributes)

Stringa

[UDSObjectList]

 

Recupera le informazioni proprietarie per una categoria indicata.

getQuestionsAsked

(int sid, int resultSize, boolean descending)

Stringa

[UDSObjectList]

 

Recupera il testo di ricerca della cronologia dei documenti della conoscenza.

getRelatedList

(int sid, String objectHandle, String listName)

ListResult

[listHandle, listLength]

 

Restituisce un handle di elenco per un elenco (QREL o BREL) di un oggetto.

getRelatedListValues

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

void

getRelatedListValuesResult

[UDSObjectList]

numRowsFound

(IntHolder)

Restituisce i valori per gli elenchi di un oggetto.

getRepositoryInfo

(int sid, int repositoryId)

Stringa

[UDSObject]

 

Restituisce le informazioni di un repository.

getStatuses

(int sid)

Stringa

[UDSObjectList]

 

Recupera tutti gli stati della conoscenza.

getTaskListValues

(int sid, String objectHandle, ArrayOfString attributes)

Stringa

[UDSObjectList]

 

Restituisce i valori per le attività associate con un problema indicato o con un ordine di cambiamento.

getTemplateList

(int sid)

Stringa

[UDSObjectList]

 

Recupera tutti i modelli di documenti.

getValidTaskTransitions

(int sid, String taskHandle, ArrayOfString attributes)

Stringa

[UDSObjectList]

 

Restituisce tutte le possibili transizioni di stato per un'attività particolare.

Restituisce tutte le possibili transizioni di stato per un'attività particolare.

Stringa

[UDSObjectList]

 

Restituisce tutte le possibili transizioni di stato per un ticket particolare.

getWorkflowTemplateList

(int sid)

Stringa

[UDSObjectList]

 

Recupera tutti i modelli del flusso di lavoro della conoscenza.

getWorkFlowTemplates

(int sid, String objectHandle, ArrayOfString attributes)

Stringa

[UDSObjectList]

 

Restituisce tutti i modelli di flusso di lavoro associati con la categoria di un ordine di cambiamento o problema.

impersonate

(int sid, String userid)

int

 

Invalida la sessione precedente e restituisce un nuovo ID sessione per il nuovo utente.

isAttmntLinkedKD

(int sid, int attmntId)

int

 

Restituisce il numero di collegamenti agli allegati a tutti i documenti della conoscenza.

logComment

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

void

 

Esegue un'attività di registrazione di un commento su un ticket.

login

(String username, String password)

int

 

Autentica un utente e restituisce un ID sessione univoco.

loginService

(String username, String password, String policy)

int

 

Autentica un utente e restituisce un ID sessione univoco.

loginServiceManaged

(String policy, String encrypted_policy)

Stringa

 

Esegue l'autenticazione utente per le configurazioni dell'indicatore PKI e restituisce un ID sessione.

loginWithArtifact

(String userid, String artifact)

int

 

Autentica un utente con artifact e restituisce un ID sessione univoco.

logout

(int sid)

void

 

Invalida e libera un ID sessione.

modifyDocument

(int sid, int docId, ArrayOfString kdAttributes)

Stringa

[UDSObject]

 

Aggiorna un documento della conoscenza.

notifyContacts

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

Stringa

[UDSObject (Handle only)]

 

Invia una notifica a uno o più contatti.

rateDocument

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

Stringa

[UDSObjectList]

 

Classifica un documento della conoscenza specifico.

removeAttachment

(int sid, String attHandle)

int

 

Rimuove un allegato da un ticket.

removeLrelRelationships

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

void

 

Rimuove una o più relazioni molti a molti.

removeMemberFromGroup

(int sid, String contactHandle, String groupHandle)

void

 

Rimuove un contatto da un gruppo.

search

(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)

Stringa

[UDSObjectList (nested)]

 

Ricerca soluzioni nei documenti della conoscenza.

serverStatus

(int sid)

int

 

Restituisce lo stato (attivo o non attivo) del server CA SDM.

transfer

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

Stringa

[UDSObject

(Handle only)]

 

Esegue un'attività di trasferimento su un ticket.

updateObject

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

Stringa

[UDSObject]

 

Aggiorna uno o più attributi per un oggetto indicato.

updateRating

(int sid, int buId, int rate)

Stringa

[UDSObject]

 

Aggiorna una valutazione esistente di un documento della conoscenza.

loginWithArtifact

(String userid, String artifact)

int

 

Autentica un utente con artifact e restituisce un ID sessione univoco.

getArtifact

(int sid, String contact, String password)

Stringa

 

Restituisce un artifact per l'aggiunta agli URL.