- style
Llamadas API del servicio web
- Former user (Deleted)
| Argumento | Descripción |
| Credenciales | |
| authorizationToken | El Token de autorización para el cliente del servicio web. |
| sliceToken | El Token del segmento para el cliente del servicio web. |
| username | El Nombre de usuario del cliente para el cliente del servicio web. |
| userPassword | La Contraseña de usuario del cliente para el cliente del servicio web. |
| Configuración extendida | |
| responseFormat | Formato de datos de salida del servicio Web (JSON, XML y JavaBean) |
Esta sección contiene los siguientes temas:
Respuesta a todas las llamadas:
La respuesta a todas las llamadas de la API del servicio web del Centro de servicio al usuario se compone de una clase de bean de respuesta de servicio predeterminada tanto si la solicitud se realiza correctamente como si se produce un fallo. La clase de bean de respuesta get puede contener los siguientes miembros:
| Miembros | Descripción |
| Respuesta de servicio predeterminada | |
| responseStatus | El estado del mensaje saliente para una invocación de servicio Web |
| statusCode | Código de estado para la respuesta de servicio Web |
| statusMessage | Mensaje de estado para la respuesta de servicio Web |
| responseFormat | El formato del mensaje saliente para una invocación de servicio Web |
| responseText | El texto del mensaje saliente con formato (aplicable para tipos de formato XML, JSON) |
| responseBean | La clase de bean específica del servicio saliente (aplicable cuando el formato de respuesta es BEAN). |
| errors | La lista de mensajes de error que se han producido durante la invocación del servicio web. |
| warnings | La lista de mensajes de advertencia que informan al cliente de problemas no graves o de condiciones que puedan causar problemas. |
| notes | La lista de mensajes informativos para transmitir información o mejorar diagnósticos. |
La llamada Get
La llamada Get se utiliza para recuperar un conjunto predefinido de valores de campo para una entidad que se basa en el identificador del registro.
La solicitud Get
Además del ID de inicio de sesión normal y los argumentos de contraseña, la llamada Get también requiere el siguiente argumento:
| Miembros | Descripción |
| Identificador de registro | Identificador de registro (ID de fila) de la entidad |
La respuesta Get
La respuesta de servicio predeterminada para todas las llamadas de la API contiene el registro en el formato de salida solicitado para una llamada Get.
La llamada List
La llamada List se utiliza para recuperar registros (entidades) en función de los criterios de búsqueda especificados.
La solicitud List: además del ID de inicio de sesión normal y los argumentos de contraseña, la llamada List también requiere los siguientes argumentos:
| Miembros | Descripción |
| Texto de búsqueda | El valor del texto de búsqueda que se debe buscar en el conjunto identificado de campos para una entidad. |
La respuesta List
La respuesta de servicio predeterminada para todas las llamadas de la API contiene el conjunto de registros coincidentes con los criterios de búsqueda en el formato de salida solicitado para una llamada List.
La llamada Insert
La llamada Insert se utiliza para crear un nuevo registro (entidad) de un tipo particular con los valores especificados.
La solicitud Insert: además del ID de inicio de sesión normal y los argumentos de contraseña, la llamada Insert también requiere los siguientes argumentos:
| Miembros | Descripción |
| Clase de bean | Clase de Java Bean específica de la entidad (datos complejos) que contiene valores para los campos que se deben establecer al crear la nueva entidad. |
Durante una inserción, no es necesario especificar todos los campos para ese tipo de entidad. La mayor parte de los campos son opcionales, excepto los marcados como obligatorios en la respuesta de descripción, y se indica mediante el atributo 'nullable' con el valor booleano '0'. Los campos que no se especifican se dejan en blanco o se establecen con valores predeterminados. Los campos que son demasiado largos se truncan.
Cuando se envían valores de campo desconocidos en la solicitud insert, la API del servicio web rechaza la llamada. Como resultado, se transmite el código de estado 300, tal como se indica en el siguiente mensaje:
Rejecting the value that is supplied for input data element "{ 0} "; due to a correlation failure because the data transformation process could not resolve the supplied input data element into native format.La API aplica una definición estricta de valores de campo desconocidos por la que todos los campos en la llamada deben ser válidos para el usuario para esta operación.
Por ejemplo:
- La API rechaza llamadas que especifican un valor para un campo personalizado que se ha suprimido o eliminado del acceso de un usuario.
- La API rechaza llamadas que especifican campos de solo lectura.
Para algunos tipos de entidades, si se intenta insertar un nuevo registro que ya existe, la API no inserta ningún registro nuevo.
La respuesta Insert
La respuesta de servicio predeterminada para todas las llamadas de la API contiene el identificador del registro (ID de fila) de un registro que se inserta en el formato de salida solicitado para una llamada Insert.
La llamada Update
La llamada Update se utiliza para modificar un registro existente (entidad) identificado por el identificador de registro con valores especificados.
La solicitud Update
Además del ID de inicio de sesión normal y los argumentos de contraseña, la llamada Update también requiere lo siguiente:
Miembro: clase de bean
Descripción: clase de Java Bean específica de la entidad (tipo de datos complejos) que contiene valores para los campos que se deberán actualizar, mientras se actualiza una entidad existente identificada por el identificador del registro.
Durante una actualización, no es necesario especificar todos los campos para ese tipo de entidad. Se deben pasar los valores para estos campos que se desea actualizar durante esta llamada.
Los campos que no se han especificado se mantendrán intactos. Los campos que son demasiado largos se truncan. Si envía valores de campo desconocidos en la solicitud Update, la API del servicio web del Centro de servicio al usuario rechaza la llamada y envía el código de estado 300 con el siguiente mensaje de estado asociado:
Rejecting the value supplied for input data element "{ 0} "; due to a correlation failure because the data transformation process could not resolve the supplied input data element into native format.- La API aplica una definición estricta de valores de campo desconocidos por la que todos los campos en la llamada deben ser válidos para el usuario para esta operación. Por ejemplo: la API rechaza llamadas que especifican un valor para un campo personalizado que se ha suprimido o eliminado del acceso de un usuario.
- La API rechaza llamadas que especifican campos de solo lectura.
La respuesta Update: la respuesta de servicio predeterminada para todas las llamadas de la API contiene el identificador del registro (ID de fila) de un registro que se está actualizando en el formato de salida solicitado para una llamada Update.
Cuando un usuario intenta actualizar el ticket, se muestra un mensaje de error que indica que los siguientes campos son campos de solo lectura:
- Organización del solicitante
- Ubicación del solicitante
- Sitio del solicitante
- Organización del beneficiario
- Ubicación del beneficiario
- Sitio del beneficiario
- Caso padre
La llamada Delete
La llamada Delete se utiliza para suprimir un registro existente (entidad) identificado por el identificador de registro.
La solicitud Delete: además del ID de inicio de sesión normal y los argumentos de contraseña, la llamada Delete también requiere el siguiente argumento:
| Miembros | Descripción |
| Identificador de registro | Identificador de registro (ID de fila) de un registro |
La respuesta Delete
La respuesta de servicio predeterminada para todas las llamadas de la API contiene el identificador del registro (ID de fila) de un registro que se suprime en el formato de salida solicitado para una llamada Delete.
La llamada Relate
La llamada Relate se utiliza para relacionar una entidad (registro) con otra entidad identificadas por sus respectivos identificadores del registro.
La solicitud Relate: Además del ID de inicio de sesión y de los argumentos de contraseña habituales, la llamada Relate también requiere los siguientes argumentos:
| Miembros | Descripción |
| Identificador de registro | Identificador del registro (ID de fila) de una entidad con la que otra entidad debe estar relacionada. |
| Identificador de registro relacionado | Identificador del registro (ID de fila) de una entidad que debe estar relacionada con otra entidad. |
La respuesta Relate: la respuesta de servicio predeterminada para todas las llamadas de la API puede contener el identificador del registro (ID de fila) de un registro que se inserta en la tabla de relación en el formato de salida solicitado para una llamada Relate.
La llamada Unrelate
La llamada Unrelate se utiliza para eliminar la relación de un registro de la entidad con otra entidad identificada por sus respectivos identificadores de registro.
La solicitud Unrelate: además del ID de inicio de sesión normal y los argumentos de contraseña, la llamada Unrelate también requiere lo siguiente:
| Miembros | Descripción |
| Identificador de registro | El Identificador del registro (ID de fila) de una entidad con la que otra entidad no debe estar relacionada |
| Identificador de registro relacionado | El Identificador del registro (ID de fila) de una entidad que no debe estar relacionada con otra entidad |
La respuesta Unrelate: la respuesta de servicio predeterminada para todas las llamadas de la API puede contener el identificador del registro (ID de fila) de un registro que se inserta en la tabla de relación en el formato de salida solicitado para una llamada Unrelate.
Seguridad de nivel de campo
La API de servicio Web de Service Desk impone el modelo de seguridad de nivel de campo que se configura en la interfaz de usuario de Service Desk. En la interfaz de usuario, ciertos campos se pueden marcar como solo lectura u oculto en los diseños de página.
Para un usuario concreto, la API puede acceder solamente a esos campos que son accesibles para dicho usuario en su diseño de página asignado. Se aplican las siguientes restricciones:
- La API puede consultar campos de solo lectura, pero no puede insertarlos ni actualizarlos para este usuario.
- La API no puede consultar, insertar ni actualizar campos marcados como oculto para este usuario.
Con la API de servicio Web del Centro de servicio al usuario, los campos ocultos no son visibles para ningún usuario, ni siquiera para usuarios con privilegios completos. Este comportamiento es coherente con cómo funciona la aplicación.
Campos numéricos
Los campos numéricos incluyen campos de tipo entero y doble. Los campos estándar predeterminados son de tipo entero o doble, en función de los criterios explicados en Determinación del tipo de campos estándar. Todos los campos personalizados numéricos se gestionan como tipo doble.
Los campos numéricos se deben transferir como i4 o tipos doble, según sea necesario, con la excepción de que se puede establecer un campo numérico en nulo estableciéndolo en un valor de cadena vacía. El tipo se indica en la respuesta de descripción de una entidad.
El tipo se deberá respetar en todas las llamadas futuras que hagan referencia a dicho campo, incluidas las llamadas Insert y Update. El tipo del campo se devuelve también de la llamada de consulta.
Al insertar o actualizar registros, se imponen límites de campo numéricos. Los límites se indican en la respuesta de descripción mediante el atributo ‘dígitos’ a un campo de tipo entero, o por los atributos de ‘escala’ y ‘precisión’ a un campo de tipo doble.
| Miembros | Descripción |
| Dígitos | Especifica el número máximo de dígitos que puede tener un entero |
| Escala | Para campos de tipo doble, especifica el número máximo de dígitos a la derecha del decimal |
| Precisión | Para campos de tipo doble, especifica el número total de dígitos, incluidos los situados a la izquierda y a la derecha del decimal |
El número máximo de dígitos a la izquierda del decimal es igual a 'precisión' menos 'escala'. En la interfaz de usuario del centro de servicio al usuario, la precisión se define de forma diferente; es el número máximo de dígitos permitido a la izquierda del decimal.
Los límites para campos numéricos se imponen al insertar o actualizar datos. Sin embargo, la API del servicio web del centro de servicio al usuario puede devolver datos que no cumplen estas restricciones.
© 2017 ServiceAide 1-650-206-8988 http://www.serviceaide.com info@serviceaide.com