Campos de cabecera HTTP y parámetros de URI genéricos

Los URI de los recursos REST de BPD admiten determinados campos de cabecera HTTP y parámetros URI genéricos.
Los siguientes campos de cabecera HTTP están soportados por todos los recursos REST.
Tabla 1. Campos de cabecera HTTP soportados
Nombre de campo Descripción
Accept Utilizado en el mensaje de solicitud para especificar los tipos de soporte aceptables en el mensaje de respuesta. Si el servidor no puede responder con el tipo de contenido solicitado, el406 Not AcceptableSe devuelve el código de estado HTTP.

Si la solicitud es para un recurso relacionado con BPD, puede utilizar el parámetro URI equivalente en lugar del campo de cabecera HTTP.

Accept-Encoding Utilizado en el mensaje de solicitud para restringir las codificaciones aceptables en el mensaje de respuesta. Si no se especifica un valor, la codificación del mensaje de respuesta se establece en identity (sin codificación) de forma predeterminada.

Si el servidor no puede responder con ninguna de las codificaciones de contenido listadas, el406 Not AcceptableSe devuelve el código de estado HTTP.

Si la solicitud es para un recurso relacionado con BPD, puede utilizar el parámetro URI equivalente en lugar del campo de cabecera HTTP.

Accept-Language Utilizado en el mensaje de solicitud para enviar la lista de idiomas aceptables para el mensaje de respuesta. Por ejemplo, "Accept-Language: da, en-gb", significa que el idioma preferido es danés, pero también se acepta inglés británico.

Si la solicitud es para un recurso relacionado con BPD, puede utilizar el parámetro URI equivalente en lugar del campo de cabecera HTTP.

Content-Encoding Describe la codificación de contenido que se utiliza en el cuerpo de entidad. Si se especifica una codificación de contenido no soportada, el415 Unsupported Media TypeSe devuelve el código de estado HTTP.
Content-Language Identifica el idioma del mensaje de respuesta que se devuelve al destinatario.
Content-Type Indica el tipo de soporte del cuerpo de entidad enviado al destinatario.
X-Method-Override
X-HTTP-Method-Override
Indica la operación HTTP por la que atraviesa la solicitud actual.

Si la solicitud es para un recurso relacionado con BPD, puede utilizar los parámetros URI equivalentes en lugar de los campos de cabecera HTTP.

Todos los recursos REST dan soporte al parámetro federationMode .
Tabla 2. El parámetro URI soportado por dominios federados
Parámetro URI Descripción
federationMode Para los métodos expuestos por recursos relacionados con la BPD, este parámetro URI puede utilizarse para especificar el formato de los datos de respuesta. De forma predeterminada, el mensaje de respuesta tiene una estructura raíz con una propiedad "status" de método y una propiedad "data" con datos de respuesta específicos de método. Si se especifica "federationMode=true", la estructura contenedora se suprime y solo se devuelven los datos de respuesta específicos de método.

Para los métodos expuestos por los recursos relacionados con BPEL y los recursos federados, "federationMode=true" es el único valor soportado. Si se especifica "federationMode=false", se creará un400 Bad RequestSe devuelve el código de estado HTTP.

Si el recurso REST es un recurso relacionado con BPD, puede utilizar los siguientes parámetros URI en lugar de los campos de cabecera HTTP. Si están disponibles tanto un campo de cabecera HTTP como un parámetro URI equivalente, entonces el valor del parámetro URI tiene prioridad sobre el valor de la cabecera HTTP.
Tabla 3. Parámetros de URI soportados por los recursos relacionados con BPD
Parámetro URI Descripción
accept Utilizado en el mensaje de solicitud para especificar los tipos de soporte aceptables en el mensaje de respuesta. Este parámetro equivale al campo HTTP Accept.
accept-encoding Utilizado en el mensaje de solicitud para restringir las codificaciones aceptables en el mensaje de respuesta. Este parámetro equivale al campo HTTP Accept-Encoding.
accept-language Utilizado en el mensaje de solicitud para enviar la lista de idiomas aceptables para el mensaje de respuesta. Este parámetro equivale al campo HTTP Accept-Language.
callback El nombre de la función de devolución de llamada JavaScript que se utiliza en las respuestas JSONP.
parts Utilizado en el mensaje de solicitud para especificar una lista de una o varias partes a devolver en el mensaje de respuesta. Utilice una línea vertical (|) para separar los elementos de la lista. También puede especificar all o none como el valor del parámetro parts; all es el valor predeterminado. Por ejemplo:
parts=header|data
parts=all
parts=none
x-method-override
x-http-method-override
Indica la operación HTTP por la que atraviesa la solicitud actual. Estos parámetros equivalen a los campos HTTP X-Method-Override y X-HTTP-Method-Override.