Vincular objetos a los servicios web de REST

Puede agregar un comportamiento de Servicio web de REST a un objeto mediante Object Designer para proporcionar una amplia gama de opciones de integración con otras aplicaciones, como Ivanti Automation.

Se trata de una función avanzada para ser usada por gente que se sienta cómoda con la tecnología, como REST, JASON, Postman y Swagger. Si quiere soporte de los Servicios profesionales de Ivanti para utilizar esta función, contacte con su proveedor.

Antes de configurar Service Desk

Antes de empezar a configurar el comportamiento en Service Desk, es recomendable que utilice primero herramientas como Swagger y Postman para diseñar y configurar la interacción con el punto terminal para ayudarle con la depuración que necesite llevar a cabo. Cuando haya probado las interacciones de este modo, puede configurar Service Desk para que reproduzca esas interacciones.

También recomendamos que diseñe estas nuevas piezas en una instancia de desarrollo, que las pruebe minuciosamente, y que transfiera estos diseños a producción, en lugar de aplicar nuevo contenido directamente en el entorno de producción. Para obtener más información, consulte Promoción de los diseños REST en los entornos de producción.

Configuración de Service Desk

Cuando ha diseñado y probado sus llamadas API de RESTful fuera de Service Desk, reproduzca esas interacciones en los diseñadores de Service Desk. Tenga en cuenta que la llamada REST se hace solo cuando se crea una instancia de un objeto con comportamiento REST. Actualizar y guardar un objeto de nuevo no envía otra llamada REST.

El primer paso es agregar el comportamiento de servicio web REST al objeto que desee usar para integrar con el punto terminal.

Para agregar el comportamiento del servicio web de REST a un objeto:
  1. En Object Designer, abra el objeto con el que desee utilizar el servicio web de REST.
  2. Seleccione el objeto de la parte superior del árbol Atributos y a continuación, en el cuadro Propiedades, haga clic en icono de puntos suspensivos al lado de Comportamientos.
    Aparecerá el cuadro de diálogo Selección de comportamiento.
  3. Seleccione servicio web de REST en la lista Elementos disponibles, y haga clic en Icono dirección derecha.
    El Servicio web de REST se traslada a la lista Elementos seleccionados.
  4. Haga clic en Aceptar y guarde los cambios.
    El diálogo de Selección de comportamiento se cierra y aparece un nuevo elemento de Servicios web de REST en la cuadrícula Propiedad.
    Además, se crean cuatro atributos nuevos en el objeto: Cuerpo de la solicitud de creación del servicio Rest, Estado de creación del servicio Rest, URI de la solicitud de creación del servicio Rest y una relación llamada Plantilla del cuerpo de la solicitud de creación del servicio Rest que es una relación con un nuevo objeto de la lista de referencia a llamado Cuerpo del objeto. (Donde Objeto es el nombre del objeto al que ha añadido el comportamiento).

    5. Deberá crear ventanas para cualquier objeto nuevo que se cree.

  5. En la cuadrícula Propiedades, haga clic en icono de puntos suspensivos junto a Servicios web de REST.
    Aparece el diálogo de servicios web de REST.
  6. En la pestaña Solicitud, escriba el URI en el punto terminal que desee utilizar en el campo URI de punto terminal.

    7. Puede incluir variables de marcadores en el campo URI de punto terminal. Esto se suele hacer para PATCH.

  7. Seleccione POST, PATCH o DELETE según necesite.
    Se suele usar Post para crear elementos, mientras que Patch se usa para actualizar los elementos existentes. Si desea crear un elemento mediante el servicio web de REST y actualizar el mismo elemento mediante el servicio web de REST, debe crear dos objetos: uno para crear el elemento mediante Posto y otro para actualizarlo mediante Patch.
  8. En la lista desplegable Tipo de contenido, seleccione el tipo de contenido que va a enviar.
  9. En la lista Tipo de autenticación, seleccione el tipo de autenticación necesario: Ninguna, Básica, Clave API (encabezado), OAuth2 (Credenciales del cliente), o OAuth2 (contraseña) junto con los parámetros adicionales que necesite.
  10. Haga clic en Aceptar.

Es posible que a veces quiera desactivar temporalmente el comportamiento de REST. Puede hacer esto para un objeto concreto si desmarca la casilla Habilitar del diálogo de servicios web de REST.

Si quiere llevar a cabo más acciones en el registro que haya creado con el servicio web de REST, debe especificar la ruta de acceso al identificador único que haya devuelto la aplicación externa y la ubicación de Service Desk donde quiera guardar esta información.

Para guardar identificadores únicos:

  1. En la pestaña Asignación de respuestas del diálogo Selección de comportamiento, en el campo Origen introduzca la ruta de acceso al identificador único que ha devuelto la aplicación externa.
    Puede usar la notación de puntos para identificar elementos en la carga útil de origen. Introduzca * si quiere usar toda la respuesta.
  2. En el campo Destino, introduzca el atributo de Service Desk de cadena de texto de tipo donde desee que se devuelva el valor de Service Desk.
    Esto será en el formato {_Request/Field}.
  3. En la lista desplegable Aceptar, seleccione el tipo de contenido que espere recibir.
    Si selecciona un formato XML, especifique los Espacios de nombre de XML, separe los nombres de múltiples espacios de nombre con espacio. Por ejemplo, xmlns:h="http://www.w3.org/TR/html4/" xmlns:r="http://www.example.com/example/"
  4. Haga clic en Aceptar.

Ahora que ha configurado el enlace entre el objeto de Service Desk y el punto terminal, puede especificar el Cuerpo de la carga útil que desee enviar. La carga útil debe ser JSON o XML. Algunos puntos terminales aceptan varias cargas útiles distintas. Por ejemplo, Ivanti Automation proporciona un único endpoint que acepta cargas útiles de varios runbooks con el runbook requerido especificado en el cuerpo de la carga útil.

Por esto la relación de la Plantilla del cuerpo de la solicitud de creación del servicio Rest con el objeto de la lista de referencia Cuerpo del objeto se crea cuando se agrega el comportamiento del servicio web REST. Esto le permite crear una lista de referencia (para más información, consulte Creación de listas de referencias nuevas) para guardar los distintos Cuerpos de carga útil y, a continuación, como parte de su proceso, proporcionar un mecanismo para seleccionar la instancia adecuada de la lista de referencia (por ejemplo, usando un tipo de valor en una Acción automática; para obtener más información, consulte Especificar valores dinámicos para acciones automáticas). Al agregar marcadores similares a los que se usan cuando se especifican valores dinámicos en acciones automáticas en su Cuerpo del Objeto, puede incluir valores de instancias de objetos de Service Desk oara que se incluyan en la carga útil. Si utiliza variables de marcadores, agréguelas en el contexto del objeto RESTful.

Cada objeto que tiene el comportamiento REST debe tener, al menos, un elemento en la lista de referencia correspondiente que contenga la carga útil Cuerpo adecuada.

Puede usar una herramienta como Swagger para llamar a su punto terminal para que le ayuden a diseñar esta carga útil.

Para ver un ejemplo trabajado del uso del servicio web de REST para automatizar el cumplimiento de la solicitud mediante Ivanti Automation, consulte la Comunidad de Ivanti.