Encabezados de solicitud

Las siguientes cabeceras de solicitud HTTP son relevantes para todos los métodos de solicitud (GET, PUT, POST y DELETE) y son necesarias en todas las solicitudes de API.

Campos de cabecera de solicitud necesarios

Tabla 1. Cabecera HTTP
Cabecera HTTP	Descripción
Host	Especifica el host de Internet y el número de puerto de la HMC a la que se dirige la solicitud, tal como se obtiene del URI original especificado por la aplicación cliente. La API Web Services impone que la cabecera se proporcione según lo requiera el protocolo HTTP, pero no comprueba ni utiliza el valor de la cabecera.
X-API-Sesión	Serie opaca que proporciona un identificador criptográficamente fuerte de la sesión de API (conocida como ID de sesión) bajo la que se ejecuta esta solicitud. Esta cabecera es necesaria en todas las solicitudes que requieren autenticación. La operación de inicio de sesión inicia una nueva sesión de HMC e incluye credenciales que identifican al usuario de HMC para la sesión. Tras una autenticación satisfactoria, la operación de inicio de sesión devuelve el valor que se utilizará en la cabecera X-API-Session para todas las solicitudes posteriores de la misma sesión. Si no se incluye esta cabecera en una solicitud que requiere autenticación, se genera el código de estado 403 (Prohibido) con el código de razón 4. Si se especifica un ID de sesión no válido, se genera el código de estado 403 (Prohibido) con el código de razón 5.
Longitud de contenido	Cuando se utiliza en una solicitud, especifica la longitud del cuerpo de la solicitud. Si se omite, se supone que la solicitud no contiene un cuerpo.
Tipo-contenido	Cuando se utiliza en una solicitud, especifica el tipo de soporte MIME del cuerpo de solicitud contenido en la solicitud. Esta cabecera es necesaria si se proporciona la cabecera Content-Length y especifica una longitud de cuerpo de solicitud distinta de cero; de lo contrario, se generará el código de estado 400 (Solicitud errónea).
Aceptar	Especifica la lista de tipos de soporte MIME de respuesta que la aplicación cliente está preparada para aceptar para la respuesta a la solicitud. Esta cabecera se proporciona para la negociación de contenido entre el cliente y el servidor en los casos en los que la API de servicios web da soporte a varios tipos de soporte de respuesta posibles para una operación determinada. Si se incluye la cabecera, debe permitir los tipos de soporte a los que da soporte la operación; de lo contrario, la solicitud fallará con el código de estado HTTP 406 (No aceptable).

Campos de cabecera de solicitud opcionales

Tabla 2. Cabecera HTTP
Cabecera HTTP	Descripción
X-Auditoría-Memento	Los servicios web REST de HMC registran cada solicitud de consumidor en su registro de auditoría. El registro de auditoría se formatea utilizando el formato de syslog ampliado RFC-5424 . Para cada solicitud GET, PUT, POST o DELETE que se grabe en el registro de auditoría, si se ha especificado la cabecera X-Audit-Memento, ese valor se colocará en el registro de auditoría. El nombre de cabecera no se colocará en el registro de auditoría.
Correlacionador de cliente X	Serie opaca que proporciona un identificador criptográficamente fuerte de la sesión de API (conocida como ID de sesión) bajo la que se ejecuta esta solicitud. Esta cabecera es necesaria en todas las solicitudes que requieren autenticación. La operación de inicio de sesión inicia una nueva sesión de HMC e incluye credenciales que identifican al usuario de HMC para la sesión. Tras una autenticación satisfactoria, la operación de inicio de sesión devuelve el valor que se utilizará en la cabecera X-API-Session para todas las solicitudes posteriores de la misma sesión. Si no se incluye esta cabecera en una solicitud que requiere autenticación, se genera el código de estado 403 (Prohibido) con el código de razón 4. Si se especifica un ID de sesión no válido, se genera el código de estado 403 (Prohibido) con el código de razón 5.
If-Match	Proporciona un valor ETag o comodín recibido anteriormente, y habilita las operaciones PUT o POST condicionales basadas en una coincidencia del valor proporcionado con el valor real conocido actualmente por el servidor.
If-None-Match	Proporciona un valor ETag o comodín recibido anteriormente y habilita las operaciones PUT o POST condicionales basándose en que no coinciden con el valor proporcionado.
X-HMC-Esquema-Versión	Especifica la versión del esquema. Cuando se especifica con una versión de HMC 1.1.0 en una versión de HMC 1.2.0, la respuesta contiene atributos introducidos hasta la versión 1.1.0. Si no se especifica la versión de esquema, se devuelve la versión más reciente soportada por HMC como respuesta.
X-ID-transacción	Cuando el código de cliente lo establece con un valor alfanumérico, el ID de transacción se registra en los archivos de registro para la depuración. Cuando el cliente no especifica este valor, el servidor REST genera automáticamente este valor para la solicitud entrante. El objetivo principal es filtrar varios registros a la vez para un único ID de transacción, para facilitar la depuración