Zones d'en-tête HTTP et paramètres d'URI génériques

Les URI des ressources REST du BPD prennent en charge certains champs d'en-tête HTTP et paramètres URI génériques.
Les zones d'en-tête HTTP ci-dessous sont prises en charge par toutes les ressources REST.
Tableau 1. Zones d'en-tête HTTP prises en charge
Nom de zone Description
Accept Utilisée dans le message de demande pour indiquer les types de support admissibles dans le message de réponse. Si le serveur ne parvient pas à répondre avec le type de contenu demandé, le406 Not AcceptableLe code d'état HTTP est renvoyé.

Si votre demande concerne une ressource associée à une définition de processus métier, vous pouvez utiliser le paramètre d'URI équivalent à la place de la zone d'en-tête HTTP.

Accept-Encoding Utilisée dans le message de demande pour restreindre les codages de contenu admissibles dans le message de réponse. Si aucune valeur n'est spécifiée, le codage du message de réponse est défini sur identity (pas de codage) par défaut.

Si le serveur ne parvient pas à répondre avec l'un des codages de contenu répertoriés, le406 Not AcceptableLe code d'état HTTP est renvoyé.

Si votre demande concerne une ressource associée à une définition de processus métier, vous pouvez utiliser le paramètre d'URI équivalent à la place de la zone d'en-tête HTTP.

Accept-Language Utilisée dans le message de demande pour envoyer la liste des langues admissibles pour le message de réponse. Par exemple, "Accept-Language: da, en-gb" signifie que la langue préférée est le danois, mais l'anglais britannique est également accepté.

Si votre demande concerne une ressource associée à une définition de processus métier, vous pouvez utiliser le paramètre d'URI équivalent à la place de la zone d'en-tête HTTP.

Content-Encoding Décrit le codage de contenu utilisé dans le corps d'entité. Si un codage de contenu non pris en charge est spécifié, le415 Unsupported Media TypeLe code d'état HTTP est renvoyé.
Content-Language Identifie la langue du message de réponse renvoyé au destinataire.
Content-Type Indique le type de support du corps d'entité envoyé au destinataire.
X-Method-Override
X-HTTP-Method-Override
Indique l'opération HTTP encapsulée par le biais de la demande en cours.

Si votre demande concerne une ressource associée à une définition de processus métier, vous pouvez utiliser les paramètres d'URI équivalents à la place des zones d'en-tête HTTP.

Toutes les ressources REST prennent en charge le paramètre federationMode .
Tableau 2. Paramètre d'URI pris en charge par les domaines fédérés
Paramètre d'URI Description
federationMode Pour les méthodes exposées par une ressource associée à une définition de processus métier, ce paramètre d'URI permet d'indiquer le format des données de réponse. Par défaut, le message de réponse possède une structure principale comportant une propriété "statut" de méthode et une propriété "données" comportant des données de réponse spécifiques à la méthode. Si "federationMode=true" est spécifié, la structure de l'encapsuleur est supprimée et seules les données de réponse spécifiques à la méthode sont renvoyées.

Pour les méthodes exposées par des ressources fédérées et des ressources associées aux processus BPEL, "federationMode=true" est la seule valeur prise en charge. Si l'"federationMode=false" est spécifiée, un400 Bad RequestLe code d'état HTTP est renvoyé.

Si la ressource REST est une ressource associée à une définition de processus métier, vous pouvez utiliser les paramètres d'URI ci-dessous à la place des zones d'en-tête HTTP. Si une zone d'en-tête HTTP et un paramètre d'URI équivalent sont disponibles, la valeur du paramètre d'URI prévaut sur la valeur de l'en-tête HTTP.
Tableau 3. Paramètres d'URI pris en charge par les ressources associées à une définition de processus métier
Paramètre d'URI Description
accept Utilisée dans le message de demande pour indiquer les types de support admissibles dans le message de réponse. Ce paramètre est équivalent au champ HTTP Accept.
accept-encoding Utilisée dans le message de demande pour restreindre les codages de contenu admissibles dans le message de réponse. Ce paramètre est équivalent au champ HTTP Accept-Encoding.
accept-language Utilisée dans le message de demande pour envoyer la liste des langues admissibles pour le message de réponse. Ce paramètre est équivalent au champ HTTP Accept-Language.
callback Nom de la fonction de rappel JavaScript utilisée dans les réponses JSONP.
parts Utilisée dans le message de demande pour indiquer une liste d'une ou plusieurs parties à renvoyer dans le message de réponse. Utilisez une barre verticale (|) pour séparer les éléments de la liste. Vous pouvez également spécifier all ou none comme valeur du paramètre parts ; all est la valeur par défaut. Par exemple :
parts=header|data
parts=all
parts=none
x-method-override
x-http-method-override
Indique l'opération HTTP encapsulée par le biais de la demande en cours. Ces paramètres sont équivalents aux champs HTTP X-Method-Override et X-HTTP-Method-Override.