Comando HB_API_DELETE

Envía una solicitud DELETE a la API de HighBond.

Sintaxis

HB_API_DELETE URL_solicitud_API_HighBond HEADERS información_encabezado PASSWORD núm <TO archivo_respuesta>HighBond_API_request_URL

Parámetros

Nombre Descripción
URL_solicitud_API_HighBond

Los detalles de la solicitud para el recurso de Diligent One.

Incluya los siguientes detalles en la URL de la solicitud:

  • Información del host, incluida la región de Diligent One

  • Número de versión de API (número de versión principal actual)

  • ID de la instancia de Diligent One (ID de la organización)

  • Nombre del extremo de la API de HighBond y todo otro detalle adicional relevante, como el número de identificador

Por ejemplo:

"https://apis-us.highbond.com/v1/orgs/11594/robots"

Si desea conocer la sintaxis de la solicitud para un recurso específico de Diligent One, consulte la Referencia de la API de HighBond.Diligent OneHighBond API

HEADERS información_encabezado

La información del encabezado de la solicitud.

En el encabezado, especifique el tipo de contenido de la solicitud de la API de HighBond:

'{"content-type": "application/vnd.api+json"}'

PASSWORD núm

La definición de contraseña que se debe usar.

No se utiliza PASSWORD núm para solicitar o especificar una contraseña real. La definición de contraseña hace referencia a una contraseña proporcionada o configurada previamente con el comando PASSWORD, el comando SET PASSWORD o la etiqueta de estudio analítico PASSWORD.

núm es el número de la definición de contraseña. Por ejemplo, si se proporcionaron o configuraron dos contraseñas previamente en un script, o al programar un script de estudio analítico, PASSWORD 2 especifica que se utiliza la contraseña número 2.

Si desea obtener más información acerca de la especificación o configuración de contraseñas, consulte:

El valor de la contraseña obligatoria es un token de acceso a Diligent One. Si desea obtener más información, consulte Creación de una definición de contraseña y especificación de un valor de contraseña.

El parámetro PASSWORD núm puede ser obligatorio o no, según el entorno en el que se ejecute el script.

Entorno en el que se ejecuta el script Requisito PASSWORD núm
Analytics

(activación en línea)

El parámetro PASSWORD núm no es obligatorio.

Se utiliza automáticamente el token de acceso Diligent One del usuario actual, que se almacena en su registro de Windows.
Analytics

(activación sin conexión)

El parámetro PASSWORD núm es obligatorio.
Robots
TO archivo_respuesta

opcional

El nombre del archivo que contiene la respuesta a la solicitud.

Especifique archivo_respuesta como una cadena entre comillas con una extensión de archivo *.json. Por ejemplo:

TO "response.json"

Ubicación en la que se guarda el archivo de respuesta JSON

La ubicación donde se guarda el archivo de respuesta JSON depende del lugar en el que ejecute el script.

Ejecutar el script en Analytics

Por defecto, el archivo de respuesta JSON se guarda en la carpeta que contiene el proyecto de Analytics.

Incluya una ruta al archivo junto con el nombre para guardar el archivo en una carpeta existente distinta:

TO "C:\HighBond API responses\response.json"

Ejecutar el script en Robots

Si especifica una etiqueta //RESULT FILE en el encabezado de estudio analítico, el archivo de respuesta JSON se guarda como salida con cada ejecución de la tarea en el robot.

Especifique únicamente el nombre del archivo. No especifique ninguna ruta al archivo.

Observaciones

Creación de una definición de contraseña y especificación de un valor de contraseña

Cuando ejecuta un script en Robots que envía una solicitud a la API de HighBond, debe incluir una definición de contraseña con el comando que envía la solicitud. El mismo requisito se aplica a la ejecución de scripts en Analytics cuando usa la activación sin conexión.

Independientemente del método que utilice para crear una definición de contraseña, el valor de la contraseña requerida es un token de acceso a Diligent One que puede generar en Launchpad. Si desea obtener más información, consulte Adquiera un token de acceso de Diligent One.

Métodos de definición de contraseñas

Método Descripción

Etiqueta de estudio analítico PASSWORD

(para scripts que se ejecutan en Robots)

Si utiliza la etiqueta de estudio analítico PASSWORD para crear la definición de contraseña numerada para conectarse a Diligent One, no se especifica ningún valor de contraseña en el script. Cuando crea una tarea para ejecutar el script en Robots, un campo de entrada del Diseñador de tareas le permite a usted o a otro usuario especificar la contraseña real.

Si desea obtener más información, consulte Etiqueta de estudio analítico PASSWORD.

Comando PASSWORD

(para scripts que se ejecutan en Analytics, activación sin conexión)

Si utiliza el comando PASSWORD para crear la definición de contraseña numerada para conectarse a Diligent One, no se especifica ningún valor de contraseña en el script. Cuando el script trata de conectarse, aparece una solicitud de contraseña.

Si desea obtener más información, consulte Comando PASSWORD.

Comando SET PASSWORD

(para scripts que se ejecutan en Analytics, activación sin conexión)

Si utiliza el comando SET PASSWORD para crear la definición de contraseña numerada para conectarse a Diligent One, se especifica un valor de contraseña en el script, por lo que no aparece ninguna solicitud de contraseña. Este método es apropiado para scripts diseñados para ejecutarse sin intervención. No obstante, se expone una contraseña real con texto claro en el script, por lo que puede que no sea conveniente para su situación.

Si desea obtener más información, consulte Comando SET PASSWORD.

Adquiera un token de acceso de Diligent One

¡Precaución!

El token de acceso generado concuerda con la cuenta utilizada para iniciar sesión en Diligent One. Como escritor de scripts, puede no ser apropiado especificar su propio token de acceso si otras personas van a usar el script.

Proteja los tokens de acceso como cualquier contraseña de cuenta.

Utilice un token de acceso existente, a menos que tenga un motivo para crear uno nuevo. Si el token existente no funciona, cree uno nuevo. El uso de un token existente reduce la cantidad de tokens que necesita administrar.

  1. Realice una de las siguientes acciones:

    • En el menú principal de Analytics, seleccione Herramientas > Token de acceso Diligent One.

    • En el Editor de scripts, haga clic con el botón derecho del ratón y seleccione Insertar > Token de Diligent One.

    Se abre la página Administrar tokens de API en el navegador. Es posible que deba iniciar sesión primero en Diligent One.

    Acceder a la página Administrar tokens de API desde Analytics es una función muy práctica. También puede iniciar sesión en Diligent One para acceder a la página desde su perfil de usuario sin usar Analytics.

  2. Realice una de las siguientes acciones:

    • Usar un token existente

      1. En la columna Token, haga clic en el token parcialmente enmascarado que desea utilizar.

      2. Introduzca la contraseña de su cuenta de Diligent One y haga clic en Confirmar.Diligent One

        Se muestra el token sin enmascarar.

      3. Haga clic en Copiar para copiar el token.

        Consejo

        No cierre el cuadro de diálogo que contiene el token hasta que haya pegado el token correctamente.

    • Cree un nuevo token

      1. Haga clic en Agregar token > Analytics.

      2. En el panel lateral Nuevo token de Analytics, especifique la siguiente información:

        Campo u opción Descripción
        Descripción

        Introduzca una descripción que proporcione información útil, por ejemplo:

        • El propósito del token
        • Dónde se utiliza el token, por ejemplo, el nombre y la ubicación del script de Analytics, o el nombre y la ubicación de la tarea del robot
        Caducidad del token
        • Activado el token caduca después del número de días que especifique
        • Desactivado el token nunca caduca

        Nota

        Es posible que su organización tenga una política de seguridad que requiera que los tokens caduquen después de cierto tiempo. La creación de tokens con fecha de caducidad es una buena práctica. Diligent One le envía por correo electrónico una notificación automatizada antes de la fecha de caducidad.
        Caduca en Especifique los días que faltan para que el token caduque (de 1 a 365).
        Contraseña Introduzca la contraseña de su cuenta de Diligent One.

      3. Haga clic en Generar token.

      4. Haga clic en Copiar para copiar el token.

        Consejo

        No cierre el panel lateral que contiene el token hasta que haya pegado el token correctamente.

  3. En función del método de definición de contraseña que utilice, realice una de estas acciones:

    • Etiqueta de estudios analíticos PASSWORD En el Diseñador de la tarea de un robot ACL, pegue el token que ha copiado en un campo de parámetro de contraseña.ACL robot

    • Comando PASSWORD En Analytics, pegue el token que ha copiado en la solicitud de contraseña que aparezca durante la ejecución del script. Analytics

    • Comando SET PASSWORD En Analytics, pegue el token que ha copiado en el lugar adecuado de la sintaxis del comando SET PASSWORD de un script.Analytics

  4. En Launchpad, cierre el cuadro de diálogo o el panel lateral que contiene el token.

    Si creó un nuevo token, se agrega una versión parcialmente enmascarada del token en la parte superior de su lista de tokens.

    Si desea más información, consulte Creación y administración de tokens de acceso de Diligent One.