Rubrique précédente: Clause INRubrique suivante: Renvois d'objets XML


Méthodes de services Web

Cette section détaille l’utilisation des méthodes de services Web. Pour chacune des méthodes, les paramètres, la description ainsi que les renvois sont décrits.

Important : Pour de plus amples renseignements sur les services Web, reportez-vous au Manuel de mise en oeuvre.

Ce chapitre traite des sujets suivants :

Récapitulatif des méthodes de services Web

Renvois d'objets XML

Méthodes de gestion des contacts

Méthodes de gestion des groupes

Méthodes d’activité

Méthodes de gestion des actifs

Méthodes de liste/requête

Méthodes LREL

Gestion des connaissances

Méthodes diverses

Méthodes workFlow

Méthodes d’attachement

Méthodes REST HTTP

Récapitulatif des méthodes de services Web

La table suivante récapitule les méthodes de services Web du produit :

Nom de méthode (paramètres d'entrée)

Type de retour [élément racine XML]

Paramètres de sortie (type : StringHolder) [élément racine XML]

description

addAssetLog

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

vide

 

Ajoute une nouvelle entrée de journal à un actif.

addBookmark

(int sid, String contactId, int docId)

Chaîne

[UDSObject]

 

Ajoute un signet à un document de connaissances.

addComment

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

Chaîne

[UDSObject]

 

Ajoute un commentaire à un document de connaissances.

addMemberToGroup

(int sid, String contactHandle, String groupHandle)

vide

 

Ajoute un contact au groupe.

attachChangeToRequest

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

Chaîne

 

Joint une demande de changement nouvelle ou existante à l'appel.

attachURLLink

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

int

 

Joint un lien URL à un document de connaissances.

attmntFolderLinkCount

(int sid, int folderId)

int

 

Renvoie le nombre de liens de pièce jointe d'un dossier.

callServerMethod

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

Chaîne

[ServerReturn]

 

Appelle une méthode arbitraire côté serveur.

changeStatus

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

Chaîne

[UDSObject

(descripteur uniquement)]

 

Effectue une activité de mise à jour d'état sur un ticket.

clearNotification

(int sid, String lrObject, String clearBy)

int

 

Efface un message de notification.

closeTicket

(int sid, String description, String ticketHandle)

Chaîne

[UDSObject

(descripteur uniquement)]

 

Définit l'état du ticket sur Clôturé.

createActivityLog

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

Chaîne

[UDSObject

(descripteur uniquement)]

 

Crée une entrée de journal d'activité pour un ticket.

createAsset

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

vide

createAssetResult

[UDSObject]

newAssetHandle

newExtensionHandle

newExtensionName

Crée un élément de configuration (actif).

createAssetParentChildRelationship

(int sid, String parentHandle, String childHandle)

Chaîne

 

Crée une relation parent-enfant pour un actif.

createAttachment

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

Chaîne

 

Charge un fichier sur le serveur d'arrière-plan et le joint à un ticket.

createAttmnt

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

Chaîne

 

Charge un fichier sur le serveur d'arrière-plan et le joint à un document de connaissances.

createChangeOrder

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

Chaîne

[UDSObject]

newChangeHandle

newChangeNumber

Crée un ticket de demande de changement.

createDocument

(int sid, ArrayOfString kdAttributes)

Chaîne

[UDSObjectList]

 

Crée un document de connaissances.

createFolder

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

Chaîne

[UDSObject]

 

Crée un dossier dans un référentiel de pièces jointes.

createIssue

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

 

Chaîne

[UDSObject]

NewIssueHandle

NewIssueNumber

Crée un ticket de demande client.

createLrelRelationships

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

vide

 

Ajoute une ou plusieurs relations plusieurs-à-plusieurs.

createObject

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

vide

createObjectResult

[UDSObject]

newHandle

Crée un objet CA SDM.

createQuickTicket

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

Chaîne

[UDSObject]

newTicketHandle

newTicketNumber

Crée un ticket à partir du type de document préféré de l'utilisateur final.

createRequest

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

Chaîne

[UDSObject]

NewRequestHandle

NewRequestNumber

 

Crée un ticket de demande.

createTicket

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

Chaîne

[UDSObject (vide)]

newTicketHandle

newTicketNumber

returnUserData

returnApplicationData

Crée un ticket à partir des règles définies dans la politique de technologie orientée service et du type de problème.

createWorkFlowTask

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

vide

createWorkFlowTaskResult

[UDSObject]

newHandle

Crée une tâche de flux de travaux.

deleteBookmark

(int sid, String contactId, int docId)

int

 

Supprime un signet d'un document de connaissances.

deleteComment

(int sid, int commentId)

int

 

Supprime un commentaire d'un document de connaissances.

deleteDocument

(int sid, int docId)

int

 

Indique qu'un document de connaissances doit être supprimé.

deleteWorkFlowTask

(int sid, String workFlowHandle, String objectHandle)

vide

 

Supprime une tâche de flux de travaux du ticket associé.

detachChangeFromRequest

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

Chaîne

 

Détache la demande de changement d'une demande.

doQuery

(int sid, String objectType, String whereClause)

ListResult

[listHandle, listLength]

 

Effectue une sélection de type SQL sur le type d'objet spécifié.

doSelect

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

Chaîne

[UDSObjectList]

 

Effectue une sélection de type SQL sur le type d'objet spécifié.

doSelectKD

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

Chaîne

[UDSObjectList]

 

Effectue une sélection de type SQL sur l'objet de document de connaissances.

escalader

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

Chaîne

[UDSObject

(descripteur uniquement)]

 

Effectue une activité d'escalade sur un ticket.

faq

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

Chaîne

[UDSObjectList]

 

Effectue une recherche faq dans les documents de connaissances.

findContacts

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

Chaîne

[UDSObjectList]

 

Récupère une liste de contacts.

freeListHandles

(int sid, ArrayOfInt handles)

vide

 

Libère les ressources côté serveur pour les listes et invalide les descripteurs de liste.

getAccessTypeForContact

(int sid, String contactHandle)

Chaîne

 

Renvoie un descripteur pour le type d'accès d'un contact.

getArtifact

(int sid, String contact, String password)

Chaîne

 

Renvoie un artefact pour l'ajouter à des URL.

getAssetExtensionInformation

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

 

vide

getAssetExtInfoResult

[UDSObject]

extensionHandle

extensionName

Renvoie les informations sur l'extension d'un composant.

getAttmntInfo

(int sid, int attmntId)

Chaîne

[UDSObjectList]

 

Renvoie les attributs d'une pièce jointe.

getAttmntList

(int sid, int folderId, int repId)

Chaîne

[UDSObjectList]

 

Renvoie une liste des pièces jointes sous un dossier de pièces jointes donné.

getAttmntListPerKD

(int sid, int docId)

Chaîne

[UDSObjectList]

 

Renvoie une liste de pièces jointes pour un document de connaissances.

getBookmarks

(int sid, String contactId)

Chaîne

[UDSObjectList]

 

Récupère les signets pour un contact.

getBopsid

(int sid, String contact)

Chaîne

 

Renvoie un jeton pour l'ajouter à des URL.

getCategory

(int sid, int catId, boolean getCategoryPaths)

Chaîne

[UDSObjectList]

 

Récupère les informations relatives à une catégorie de connaissances.

getComments

(int sid, String docIds)

Chaîne

[UDSObjectList]

 

Récupère tous les commentaires de la liste de documents de connaissances.

getConfigurationMode

(int sid)

Chaîne

 

Renvoie une confirmation si CA SDM s'exécute en mode ITIL.

getContact

(int sid, String contactId)

Chaîne

[UDSObject]

 

Récupère les informations d'un contact.

getDecisionTrees

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

Chaîne

[UDSObjectList]

 

Récupère tous les documents de connaissances de l'arborescence décisionnelle.

getDependentAttrControls

(int sid, String handle, ArrayOfString attrVals)

Chaîne

[UDSObjectList]

 

Renvoie une liste d'attributs verrouillés et requis pour l'objet Status.

getDocument

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

Chaîne

[UDSObject]

 

Récupère les informations pour un document de connaissances.

getDocumentsByIDs

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

Chaîne

[UDSObjectList]

 

Récupère les informations pour un ou plusieurs documents de connaissances.

getDocumentTypes

(int sid)

Chaîne

[UDSObjectList]

 

Renvoie une liste de tous les types de document de connaissances.

getFolderInfo

(int sid, int folderId)

Chaîne

[UDSObject]

 

 

Récupère les informations d'un dossier de pièce jointe.

getFolderList

(int sid, int parentFolderId, int repId)

Chaîne

[UDSObjectList]

 

Renvoie une liste des dossiers se trouvant sous un dossier parent.

getGroupMemberListValues

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

Chaîne

[UDSObjectList]

 

Interroge le groupe du système et la relation de membre.

getHandleForUserid

(int sid, String userID)

Chaîne

 

Renvoie le descripteur persistant d'un contact.

getKDListPerAttmnt

(int sid, int attmntId)

Chaîne

[UDSObjectList]

 

Renvoie une liste des documents de connaissances relatifs à une pièce jointe.

getListValues

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

Chaîne

[UDSObjectList]

 

Renvoie les valeurs d'attributs pour plusieurs objets dans une liste.

getLrelLength

(int sid, String contextObject, String lrelName)

int

 

Renvoie le nombre d'objets de l'une des parties d'une relation plusieurs à plusieurs :

getLrelValues

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

Chaîne

[UDSObjectList]

 

Renvoie les valeurs d'attributs pour plusieurs objets dans une relation plusieurs à plusieurs.

getNotificationsForContact

(int sid, String contactHandle, int queryStatus)

ListResult

[listHandle, listLength]

 

Renvoie un descripteur de liste des notifications (objets lr) pour un contact.

getObjectTypeInformation

(int sid, String factory)

Chaîne

[UDSObject (spécial)]

 

Renvoie une liste de tous les noms d'attribut pour un objet.

getObjectValues

(int sid, String objectHandle, ArrayOfString attributes)

Chaîne

[UDSObject]

 

Renvoie les valeurs d'attribut pour un descripteur d'objet.

getPendingChangeTaskListForContact

(int sid, String contactHandle)

ListResult

[listHandle, listLength]

 

Renvoie toutes les tâches de flux de travaux de demande de changement en attente affectées à un contact.

getPendingIssueTaskListForContact

(int sid, String contactHandle)

ListResult

[listHandle, listLength]

 

Renvoie toutes les tâches de flux de travaux de demande client en attente affectées à un contact.

getPermissionGroups

(int sid, int groupId)

Chaîne

[UDSObjectList]

 

Récupère les informations relatives à un groupe d'autorisations.

getPolicyInfo

(int sid)

Chaîne

[SAPolicy]

 

Renvoie les informations concernant la politique d'accès pour la session actuelle.

getPriorities

(int sid)

Chaîne

[UDSObjectList]

 

Récupère toutes les priorités des connaissances.

getPropertyInfoForCategory

(int sid, String categoryHandle, ArrayOfString attributes)

Chaîne

[UDSObjectList]

 

Récupère les informations de propriété d'une catégorie.

getQuestionsAsked

(int sid, int resultSize, boolean descending)

Chaîne

[UDSObjectList]

 

Récupère l'historique des textes de recherche du document de connaissances.

getRelatedList

(int sid, String objectHandle, String listName)

ListResult

[listHandle, listLength]

 

Renvoie un descripteur de liste pour la liste (QREL ou BREL) d'un objet.

getRelatedListValues

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

vide

getRelatedListValuesResult

[UDSObjectList]

numRowsFound

(IntHolder)

Renvoie les valeurs des listes d'un objet.

getRepositoryInfo

(int sid, int repositoryId)

Chaîne

[UDSObject]

 

Renvoie les informations relatives à un référentiel.

getStatuses

(int sid)

Chaîne

[UDSObjectList]

 

Récupère tous les états de connaissances.

getTaskListValues

(int sid, String objectHandle, ArrayOfString attributes)

Chaîne

[UDSObjectList]

 

Renvoie les valeurs pour les tâches associées à une demande client ou à une demande de changement.

getTemplateList

(int sid)

Chaîne

[UDSObjectList]

 

Récupère tous les modèles de document.

getValidTaskTransitions

(int sid, String taskHandle, ArrayOfString attributes)

Chaîne

[UDSObjectList]

 

Renvoie toutes les transitions d'état possibles pour une tâche.

Renvoie toutes les transitions d'état possibles pour une tâche.

Chaîne

[UDSObjectList]

 

Renvoie toutes les transitions d'état possibles pour un ticket.

getWorkflowTemplateList

(int sid)

Chaîne

[UDSObjectList]

 

Récupère tous les modèles de flux de travaux de connaissances.

getWorkFlowTemplates

(int sid, String objectHandle, ArrayOfString attributes)

Chaîne

[UDSObjectList]

 

Renvoie tous les modèles de flux de travaux associés à la catégorie d'une demande de changement ou d'une demande client.

impersonate

(int sid, String userid)

int

 

Annule l'ancienne session et renvoie un nouvel ID de session pour l'utilisateur.

isAttmntLinkedKD

(int sid, int attmntId)

int

 

Renvoie le nombre de liens de pièces jointes à l'ensemble des documents de connaissances.

logComment

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

vide

 

Effectue une activité de journalisation de commentaire dans un ticket.

connexion

(String username, String password)

int

 

Authentifie un utilisateur et renvoie un ID de session unique.

loginService

(String username, String password, String policy)

int

 

Authentifie un utilisateur et renvoie un ID de session unique.

loginServiceManaged

(String policy, String encrypted_policy)

Chaîne

 

Authentifie l'utilisateur pour les configurations PKI et renvoie un ID de session.

loginWithArtifact

(String userid, String artifact)

int

 

Authentifie un utilisateur à l'aide d'un artefact et renvoie un ID de session unique.

logout

(int sid)

vide

 

Annule et libère un ID de session.

modifyDocument

(int sid, int docId, ArrayOfString kdAttributes)

Chaîne

[UDSObject]

 

Met à jour un document de connaissances.

notifyContacts

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

Chaîne

[UDSObject (descripteur uniquement)]

 

Envoie une notification à un ou plusieurs contacts.

rateDocument

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

Chaîne

[UDSObjectList]

 

Evalue un document de connaissances.

removeAttachment

(int sid, String attHandle)

int

 

Supprime une pièce jointe d'un ticket.

removeLrelRelationships

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

vide

 

Supprime une ou plusieurs relations plusieurs-à-plusieurs.

removeMemberFromGroup

(int sid, String contactHandle, String groupHandle)

vide

 

Supprime un contact du groupe.

recherche

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

Chaîne

[UDSObjectList (imbriqué)]

 

Recherche des solutions de document de connaissances.

serverStatus

(int sid)

int

 

Renvoie l'état du serveur CA SDM : en cous d'exécution ou en panne.

transfert

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

Chaîne

[UDSObject

(descripteur uniquement)]

 

Effectue une activité de transfert sur un ticket.

updateObject

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

Chaîne

[UDSObject]

 

Met à jour un ou plusieurs attributs d'un objet.

updateRating

(int sid, int buId, int rate)

Chaîne

[UDSObject]

 

Met à jour une évaluation existante d'un document de connaissances.

loginWithArtifact

(String userid, String artifact)

int

 

Authentifie un utilisateur à l'aide d'un artefact et renvoie un ID de session unique.

getArtifact

(int sid, String contact, String password)

Chaîne

 

Renvoie un artefact pour l'ajouter à des URL.