En este apartado se ofrecen detalles sobre el uso de los métodos de Servicios Web. Cada método explica los parámetros, la descripción y los resultados.
Importante: para obtener más información sobre los servicios Web, consulte la Guía de implementación.
Esta sección contiene los siguientes temas:
Resumen del método de servicios Web
Métodos de gestión de contactos
La tabla siguiente proporciona un resumen de los métodos de servicios Web del producto:
|
Nombre de método (Parámetros de entrada) |
Tipo de retorno [Elemento de raíz de XML] |
Parámetros de resultado (Tipo: StringHolder) [Elemento de raíz de XML] |
Description |
|---|---|---|---|
|
addAssetLog (int sid, String assetHandle, String contactHandle, String logText) |
vacío |
|
Agrega una nueva entrada de registro a un activo. |
|
addBookmark (int sid, String contactId, int docId) |
Cadena [UDSObject] |
|
Agrega un marcador a un documento de conocimiento. |
|
addComment (int sid, String comment, int docId, String email, String username, String contactId) |
Cadena [UDSObject] |
|
Agrega un comentario a un documento de conocimiento. |
|
addMemberToGroup (int sid, String contactHandle, String groupHandle) |
vacío |
|
Agrega un contacto a un grupo. |
|
attachChangeToRequest (int sid, String creator, String requestHandle, String changeHandle, ArrayOfString changeAttrVals, String description) |
Cadena |
|
Adjunta una orden de cambios nueva o existente a una solicitud. |
|
attachURLLink (int sid, int docId, String url, String attmntName, String description) |
int |
|
Adjunta un vínculo de URL a un documento de conocimiento. |
|
attmntFolderLinkCount (int sid, int folderId) |
int |
|
Devuelve el número de vínculos de archivo adjunto de una carpeta. |
|
callServerMethod (int sid, String methodName, String factoryName, String formatList, ArrayOfString parameters) |
Cadena [ServerReturn] |
|
Invoca cualquier método de servidor arbitrario. |
|
changeStatus (int sid, String creator, String objectHandle, String description, String newStatusHandle) |
Cadena [UDSObject (Handle only)] |
|
Realiza una actividad de estado de actualización en un ticket. |
|
clearNotification (int sid, String lrObject, String clearBy) |
int |
|
Borra un mensaje de notificación. |
|
closeTicket (int sid, String description, String ticketHandle) |
Cadena [UDSObject (Handle only)] |
|
Establece el estado del ticket como Cerrado. |
|
createActivityLog (int sid, String creator, String objectHandle, String description, String logType, int timeSpent, boolean internal) |
Cadena [UDSObject (Handle only)] |
|
Crea una entrada de registro de actividad para un ticket. |
|
createAsset (int sid, ArrayOfString attrVals, ArrayOfString attributes, StringHolder createAssetResult, StringHolder newAssetHandle, StringHolder newExtensionHandle, StringHolder newExtensionName) |
vacío |
createAssetResult [UDSObject] newAssetHandle newExtensionHandle newExtensionName |
Crea un elemento de configuración (activo). |
|
createAssetParentChildRelationship (int sid, String parentHandle, String childHandle) |
Cadena |
|
Crea una relación padre hijo de activo. |
|
createAttachment (int sid, String repositoryHandle, String objectHandle, String description, String fileName) |
Cadena |
|
Carga un archivo en el servidor back-end y lo adjunta a un ticket. |
|
createAttmnt (int sid, String repositoryHandle, int folderId, int objectHandle, String description, String fileName) |
Cadena |
|
Carga un archivo en el servidor back-end y lo adjunta a un documento de conocimiento. |
|
createChangeOrder (int sid, String creatorHandle, ArrayOfString attrVals, ArrayOfString propertyValues, String template, ArrayOfString attributes, StringHolder newChangeHandle, StringHolder newChangeNumber) |
Cadena [UDSObject] |
newChangeHandle newChangeNumber |
Crea un ticket de orden de cambio. |
|
createDocument (int sid, ArrayOfString kdAttributes) |
Cadena [UDSObjectList] |
|
Crea un documento de conocimiento. |
|
createFolder (int sid, int parentFolderId, int repId, int folderType, String description, String folderName) |
Cadena [UDSObject] |
|
Crea una carpeta en un repositorio de archivos adjuntos. |
|
createIssue (int sid, String creatorHandle, ArrayOfString attrVals, ArrayOfString propertyValues, String template, ArrayOfString attributes, StringHolder newIssueHandle, StringHolder newIssueNumber)
|
Cadena [UDSObject] |
newIssueHandle newIssueNumber |
Crea un ticket de incidencias. |
|
createLrelRelationships (int sid, String contextObject, String lrelName, ArrayOfString addObjectHandles) |
vacío |
|
Agrega una o más relaciones de muchos a muchos. |
|
createObject (int sid, String objectType, ArrayOfString attrVals, ArrayOfString attributes, StringHolder createObjectResult, StringHolder newHandle) |
vacío |
createObjectResult [UDSObject] newHandle |
Crea cualquier objeto de CA SDM. |
|
createQuickTicket (int sid, String customerHandle, String description, StringHolder newTicketHandle, StringHolder newTicketNumber) |
Cadena [UDSObject] |
newTicketHandle newTicketNumber |
Crea un ticket basado en el tipo de documento preferido del usuario final. |
|
createRequest (int sid, String creatorHandle, ArrayOfString attrVals, ArrayOfString propertyValues, String template, ArrayOfString attributes, StringHolder newRequestHandle, StringHolder newRequestNumber) |
Cadena [UDSObject] |
newRequestHandle newRequestNumber
|
Crea un ticket de solicitud. |
|
createTicket (int sid, String description, String problem_type, String userid, String asset, String duplication_id, StringHolder newTicketHandle, StringHolder newTicketNumber, StringHolder returnUserData, StringHolder returnApplicationData) |
Cadena [UDSObject (empty)] |
newTicketHandle newTicketNumber returnUserData returnApplicationData |
Crea un ticket basado en las reglas definidas en la política de Service Aware y el tipo de problema especificado. |
|
createWorkFlowTask (int sid, ArrayOfString attrVals, String objectHandle, String creatorHandle, String selectedWorkFlow, String taskType, ArrayOfString attributes, StringHolder createWorkFlowTaskResult, StringHolder newHandle) |
vacío |
createWorkFlowTaskResult [UDSObject] newHandle |
Crea una tarea de Workflow. |
|
deleteBookmark (int sid, String contactId, int docId) |
int |
|
Suprime el marcador de un documento de conocimiento. |
|
deleteComment (int sid, int commentId) |
int |
|
Suprime un comentario de un documento de conocimiento. |
|
deleteDocument (int sid, int docId) |
int |
|
Marca un documento de conocimiento para su eliminación. |
|
deleteWorkFlowTask (int sid, String workFlowHandle, String objectHandle) |
vacío |
|
Elimina una tarea de workflow de su ticket asociado. |
|
detachChangeFromRequest (int sid, String creator, String requestHandle, String description) |
Cadena |
|
Quita una orden de cambio de una solicitud. |
|
doQuery (int sid, String objectType, String whereClause) |
ListResult [listHandle, listLength] |
|
Realiza una selección de tipo SQL en el tipo de objeto especificado. |
|
doSelect (int sid, String objectType, String whereClause, int maxRows, ArrayOfString attributes) |
Cadena [UDSObjectList] |
|
Realiza una selección de tipo SQL en el tipo de objeto especificado. |
|
doSelectKD (int sid, String whereClause, String sortBy, boolean desc, int maxRows, ArrayOfString attributes, int skip) |
Cadena [UDSObjectList] |
|
Realiza una selección de tipo SQL en el objeto de documento de conocimiento. |
|
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) |
Cadena [UDSObject (Handle only)] |
|
Realiza una actividad de escalado en un ticket. |
|
faq (int sid, String categoryIds, int resultSize, String propertyList, String sortBy, boolean descending, String whereClause, int maxDocIDs) |
Cadena [UDSObjectList] |
|
Realiza una búsqueda de preguntas frecuentes en documentos de conocimiento. |
|
findContacts (int sid, String userName, String lastName, String firstName, String email, String accessType, int inactiveFlag) |
Cadena [UDSObjectList] |
|
Recupera una lista de contactos. |
|
freeListHandles (int sid, ArrayOfInt handles) |
vacío |
|
Libera los recursos del servidor de listas e invalida los identificadores de una lista. |
|
getAccessTypeForContact (int sid, String contactHandle) |
Cadena |
|
Devuelve un identificador para el tipo de acceso de un contacto. |
|
getArtifact (int sid, String contact, String password) |
Cadena |
|
Devuelve un artefacto para añadir a direcciones URL. |
|
getAssetExtensionInformation (int sid, String assetHandle, ArrayOfString attributes, StringHolder getAssetExtInfoResult, StringHolder extensionHandle, StringHolder extensionName)
|
vacío |
getAssetExtInfoResult [UDSObject] extensionHandle extensionName |
Devuelve información sobre la extensión de un activo. |
|
getAttmntInfo (int sid, int attmntId) |
Cadena [UDSObjectList] |
|
Devuelve los atributos de un adjunto. |
|
getAttmntList (int sid, int folderId, int repId) |
Cadena [UDSObjectList] |
|
Devuelve una lista de los adjuntos que hay en una carpeta de adjuntos determinada. |
|
getAttmntListPerKD (int sid, int docId) |
Cadena [UDSObjectList] |
|
Devuelve una lista de archivos adjuntos para un documento de conocimiento determinado. |
|
getBookmarks (int sid, String contactId) |
Cadena [UDSObjectList] |
|
Recupera los marcadores de un contacto determinado. |
|
getBopsid (int sid, String contact) |
Cadena |
|
Devuelve un token para añadir a direcciones URL. |
|
getCategory (int sid, int catId, boolean getCategoryPaths) |
Cadena [UDSObjectList] |
|
Recupera información para una categoría de conocimiento. |
|
getComments (int sid, String docIds) |
Cadena [UDSObjectList] |
|
Recupera todos los comentarios de la lista de documentos de conocimiento. |
|
getConfigurationMode (int sid) |
Cadena |
|
Devuelve una confirmación cuando CA SDM se ejecuta en el modo ITIL. |
|
getContact (int sid, String contactId) |
Cadena [UDSObject] |
|
Recupera información de un contacto determinado. |
|
getDecisionTrees (int sid, String propertyList, String sortBy, boolean descending) |
Cadena [UDSObjectList] |
|
Recupera todos los documentos de conocimiento del árbol de decisión. |
|
getDependentAttrControls (int sid, String handle, ArrayOfString attrVals) |
Cadena [UDSObjectList] |
|
Devuelve una lista de atributos bloqueados y necesarios para el objeto de estado. |
|
getDocument (int sid, int docId, String propertyList, boolean relatedDoc, boolean getAttmnt, boolean getHistory, boolean getComment, boolean getNotiList) |
Cadena [UDSObject] |
|
Recupera información para un documento de conocimiento. |
|
getDocumentsByIDs (int sid, String docIds, String propertyList, String sortBy, boolean descending) |
Cadena [UDSObjectList] |
|
Recupera información para uno o más documentos de conocimiento. |
|
getDocumentTypes (int sid) |
Cadena [UDSObjectList] |
|
Devuelve una lista con todos los tipos de documentos de conocimiento. |
|
getFolderInfo (int sid, int folderId) |
Cadena [UDSObject]
|
|
Recupera información para una carpeta de archivos adjunto determinada. |
|
getFolderList (int sid, int parentFolderId, int repId) |
Cadena [UDSObjectList] |
|
Devuelve la lista de las carpetas de una carpeta padre determinada. |
|
getGroupMemberListValues (int sid, String whereClause, int numToFetch, ArrayOfString attributes) |
Cadena [UDSObjectList] |
|
Consulta el grupo del sistema y la relación de los miembros. |
|
getHandleForUserid (int sid, String userID) |
Cadena |
|
Devuelve el identificador constante para un contacto. |
|
getKDListPerAttmnt (int sid, int attmntId) |
Cadena [UDSObjectList] |
|
Devuelve una lista de documentos de conocimiento relacionados con un adjunto determinado. |
|
getListValues (int sid, int listHandle, int startIndex, int endIndex, ArrayOfString attributeNames) |
Cadena [UDSObjectList] |
|
Devuelve los valores de atributo para un intervalo de objetos de una lista. |
|
getLrelLength (int sid, String contextObject, String lrelName) |
int |
|
Devuelve el número de objetos de una parte de una relación de muchos a muchos. |
|
getLrelValues (int sid, String contextObject, String lrelName, int startIndex, int endIndex, ArrayOfString attributes) |
Cadena [UDSObjectList] |
|
Devuelve los valores de atributo para un intervalo de objetos en una relación de muchos a muchos. |
|
getNotificationsForContact (int sid, String contactHandle, int queryStatus) |
ListResult [listHandle, listLength] |
|
Devuelve un identificador de lista de notificaciones (objetos lr) para un contacto dado. |
|
getObjectTypeInformation (int sid, String factory) |
Cadena [UDSObject (special)] |
|
Devuelve una lista de todos los nombres de atributo de un objeto dado. |
|
getObjectValues (int sid, String objectHandle, ArrayOfString attributes) |
Cadena [UDSObject] |
|
Devuelve los valores de atributo de un identificador de objeto dado. |
|
getPendingChangeTaskListForContact (int sid, String contactHandle) |
ListResult [listHandle, listLength] |
|
Devuelve todas las tareas de workflow de orden de cambio pendientes asignadas a un contacto dado. |
|
getPendingIssueTaskListForContact (int sid, String contactHandle) |
ListResult [listHandle, listLength] |
|
Devuelve todas las tareas de workflow de incidencias pendientes asignadas a un contacto. |
|
getPermissionGroups (int sid, int groupId) |
Cadena [UDSObjectList] |
|
Recupera información para un grupo de permisos. |
|
getPolicyInfo (int sid) |
Cadena [SAPolicy] |
|
Devuelve información acerca de la política de acceso de la sesión actual. |
|
getPriorities (int sid) |
Cadena [UDSObjectList] |
|
Recupera todas las prioridades de conocimiento. |
|
getPropertyInfoForCategory (int sid, String categoryHandle, ArrayOfString attributes) |
Cadena [UDSObjectList] |
|
Recupera información de propiedad de una categoría dada. |
|
getQuestionsAsked (int sid, int resultSize, boolean descending) |
Cadena [UDSObjectList] |
|
Recupera texto de búsqueda de documentos de conocimiento históricos. |
|
getRelatedList (int sid, String objectHandle, String listName) |
ListResult [listHandle, listLength] |
|
Devuelve un identificador de lista para la lista (QREL o BREL) de un objeto. |
|
getRelatedListValues (int sid, String objectHandle, String listName, int numToFetch, ArrayOfString attributes, StringHolder getRelatedListValuesResult, IntHolder numRowsFound) |
vacío |
getRelatedListValuesResult [UDSObjectList] numRowsFound (IntHolder) |
Valores de retornos de listas de un objeto. |
|
getRepositoryInfo (int sid, int repositoryId) |
Cadena [UDSObject] |
|
Devuelve información de un repositorio. |
|
getStatuses (int sid) |
Cadena [UDSObjectList] |
|
Recupera todos los estados de conocimiento. |
|
getTaskListValues (int sid, String objectHandle, ArrayOfString attributes) |
Cadena [UDSObjectList] |
|
Devuelve valores de tareas asociadas con una incidencia o una orden de cambio determinada. |
|
getTemplateList (int sid) |
Cadena [UDSObjectList] |
|
Recupera todas las plantillas de documento. |
|
getValidTaskTransitions (int sid, String taskHandle, ArrayOfString attributes) |
Cadena [UDSObjectList] |
|
Devuelve todas las transiciones de estado posibles de una tarea particular. |
|
Devuelve todas las transiciones de estado posibles de una tarea particular. |
Cadena [UDSObjectList] |
|
Devuelve todas las transiciones de estado posibles de un ticket específico. |
|
getWorkflowTemplateList (int sid) |
Cadena [UDSObjectList] |
|
Recupera todas las plantillas de workflow de conocimiento. |
|
getWorkFlowTemplates (int sid, String objectHandle, ArrayOfString attributes) |
Cadena [UDSObjectList] |
|
Devuelve todas las plantillas de workflow asociadas a la categoría de una orden de cambio o incidencia. |
|
impersonate (int sid, String userid) |
int |
|
Invalida la sesión anterior y devuelve un ID de sesión nuevo para el usuario nuevo. |
|
isAttmntLinkedKD (int sid, int attmntId) |
int |
|
Devuelve el número de vínculos de archivo adjunto de todos los documentos de conocimiento. |
|
logComment (int sid, String ticketHandle, String comment, int internalFlag) |
vacío |
|
Realiza una actividad de comentario de registro en un ticket. |
|
inicio de sesión (String username, String password) |
int |
|
Autentica a un usuario y devuelve un ID de sesión único. |
|
loginService (String username, String password, String policy) |
int |
|
Autentica a un usuario y devuelve un ID de sesión único. |
|
loginServiceManaged (String policy, String encrypted_policy) |
Cadena |
|
Realiza la autenticación del usuario para las configuraciones de PKI y devuelve un ID de sesión. |
|
loginWithArtifact (String userid, String artifact) |
int |
|
Autentica a un usuario con un artefacto y devuelve un ID de sesión único. |
|
logout (int sid) |
vacío |
|
Invalida y libera un ID de sesión. |
|
modifyDocument (int sid, int docId, ArrayOfString kdAttributes) |
Cadena [UDSObject] |
|
Actualiza un documento de conocimiento. |
|
notifyContacts (int sid, String creator, String contextObject, String messageTitle, String messageBody, int notifyLevel, ArrayOfString notifyees, boolean internal) |
Cadena [UDSObject (Handle only)] |
|
Envía una notificación a uno o más contactos. |
|
rateDocument (int sid, int docId, int rating, int multiplier, String ticketPerId, boolean onTicketAccept, boolean solveUserProblem, boolean isDefault) |
Cadena [UDSObjectList] |
|
Clasifica un documento de conocimiento determinado. |
|
removeAttachment (int sid, String attHandle) |
int |
|
Elimina un adjunto de un ticket. |
|
removeLrelRelationships (int sid, String contextObject, String lrelName, ArrayOfString removeObjectHandles) |
vacío |
|
Elimina una o más relaciones de muchos a muchos. |
|
removeMemberFromGroup (int sid, String contactHandle, String groupHandle) |
vacío |
|
Elimina un contacto de un grupo. |
|
buscar (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) |
Cadena [UDSObjectList (nested)] |
|
Busca soluciones de documento de conocimiento. |
|
serverStatus (int sid) |
int |
|
Devuelve el estado (arriba o abajo) del servidor de CA SDM. |
|
transfer (int sid, String creator, String objectHandle, String description, boolean setAssignee, String newAssigneeHandle, boolean setGroup, String newGroupHandle, boolean setOrganization, String newOrganizationHandle) |
Cadena [UDSObject (Handle only)] |
|
Realiza una actividad de traslado en un ticket. |
|
updateObject (int sid, String objectHandle, ArrayOfString attrVals, ArrayOfString attributes) |
Cadena [UDSObject] |
|
Actualiza uno o varios atributos de un objeto específico. |
|
updateRating (int sid, int buId, int rate) |
Cadena [UDSObject] |
|
Actualiza una valoración existente de un documento de conocimiento. |
|
loginWithArtifact (String userid, String artifact) |
int |
|
Autentica a un usuario con un artefacto y devuelve un ID de sesión único. |
|
getArtifact (int sid, String contact, String password) |
Cadena |
|
Devuelve un artefacto para añadir a direcciones URL. |
|
Copyright © 2013 CA.
Todos los derechos reservados.
|
|