Método api_post()

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

Sintaxis

hcl.api_post("detalles de la solicitud de la API de HighBond", data = carga_solicitud)

Parámetros

Nombre Descripción
Detalles de la solicitud de la API de HighBond

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

hcl.api_post proporciona automáticamente la parte estándar de los detalles de la solicitud en segundo plano. No es necesario especificar de manera explícita estos elementos de la solicitud a menos que desee reemplazar un valor predeterminado:

  • información del host

  • Región de Diligent One

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

  • información del encabezado

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

Nota

Si especifica explícitamente información del host, debe utilizar el protocolo HTTPS para conectarse con la API de HighBond. Por ejemplo: https://apis-us.highbond.com
data = carga_solicitud

Los datos que se deben enviar al servidor de la API de Diligent One.

Los datos de carga deben tener el formato JSON.

Devuelve

Objeto de respuesta del servidor de la API de HighBond.

Ejemplos

Crear un asunto en un proyecto de Diligent One

Debe crear una carga de solicitud que use el formato JSON y asignar la carga a la variable payload. A continuación, debe usar el método hcl.api_post y hacer referencia a la variable payload en el método para crear un asunto en el proyecto con el identificador 19756.

Consejo

Para generar sintaxis de carga rápidamente, copie el bloque de sintaxis de carga correspondiente de la Referencia de la API de HighBond. Después de copiar el bloque de carga, puede quitar los pares de clave-valor que pretende dejar vacíos.

payload = {"data":
        { 
            "type": "issues",
            "attributes": {
                "description": "Description of issue",
                "owner": "Jane Sleaman",
                "deficiency_type": "Deficiency",
                "title": "Data retention and backup",
                "severity": "High",
                "published": True,
                "identified_at": "2021-11-01T18:15:30Z"
                    }
                }
            }

hcl.api_post("projects/19756/issues", data = payload)

Observaciones

Autenticación

Todas las solicitudes de la API de HighBond necesitan una autenticación. Para acceder a la API, debe ser administrador del sistema en al menos una instancia de Diligent One.

Para la autenticación, use Launchpad para crear un token de API de HighBond para su cuenta. El token es una cadena que le brinda autenticación y le permite acceder a la API de HighBond de manera segura. Si necesita ayuda para crear un token, consulte Crear y administrar tokens de acceso de HighBond.

Uso de un token de API de HighBond con los métodos de la API de HighBond

Para utilizar un token de la API de HighBond con los métodos de la API de HighBond, debe asignar un token a una variable de HCL llamada v_hb_token. Una vez asignado, el token se utiliza de manera automática para la autenticación en segundo plano sin necesidad de especificarlo explícitamente en el script de Diligent One. Si desea obtener información sobre la asignación del token a la variable, consulte Utilice la ventana Variables para definir una variable de HCL.

Token de usuario del sistema

Los clientes que adquirieron juegos de herramientas de Diligent One específicos también pueden realizar la autenticación con un token de usuario del sistema genérico en lugar de utilizar un token asociado con una cuenta de usuario específica.

Especifique solo la porción exclusiva del URL del recurso

Cuando utilice el método de la API de HighBond, debe especificar únicamente la parte exclusiva, o punto de conexión, del URL del recurso de Diligent One. No es necesario que especifique la parte común (URL base) ni el identificador de la instancia de Diligent One en la que está trabajando. Esta información se proporciona automáticamente en segundo plano.

Por ejemplo, si está trabajando en una instancia de Diligent One con el identificador 1000236, las siguientes solicitudes de la API devuelven la misma respuesta. Ambas incluyen todos los asuntos del proyecto 19756.

hcl.api_get("projects/19756/issues")
hcl.api_get("https://apis.highbond.com/v1/orgs/1000236/projects/19756/issues")

Consulte la Referencia de API de HighBond.

Puede encontrar la sintaxis de la solicitud para cada recurso de Diligent One en la Referencia de API de HighBond. Aquí, por ejemplo, se incluye la sintaxis de la solicitud para obtener una lista de asuntos de un proyecto.

Si está utilizando un método de HCL para hacer la solicitud, puede comenzar especificando la sintaxis en projects/....

Si está haciendo la solicitud desde fuera de Diligent One, debe especificar todo el URL del recurso, comenzando con el protocolo (https://...).

Uso de una variable en el URL del recurso

En lugar de especificar un identificador literal en el URL del recurso puede usar un código que requiera el uso de una variable en el URL. El URL del recurso tiene el formato de una cadena por eso, para incorporar una variable en la cadena, debe usar alguna de las técnicas de Python que se incluyen a continuación.

Puede usar una cadena f-string de Python:

v_project_id = "19756"
hcl.api_get(f"projects/{v_project_id}/issues")

Puede utilizar una concatenación de cadenas de Python:

v_project_id = "19756"
hcl.api_get("projects/" + v_project_id + "/issues")