Crée une ressource ExtractorTrial.
const url = 'https://api.facteur.local/inboxes/example/extractors/trials';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"pattern":"code (\\d+)","scope":"text"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.facteur.local/inboxes/example/extractors/trials \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "pattern": "code (\\d+)", "scope": "text" }'Crée une ressource ExtractorTrial.
Authorizations
Section intitulée « Authorizations »- bearerAuthws:read
Parameters
Section intitulée « Parameters »Path Parameters
Section intitulée « Path Parameters »Identifiant ExtractorTrial
Request Bodyrequired
Section intitulée « Request Bodyrequired »La nouvelle ressource ExtractorTrial
Ce qu’un motif a capturé sur les derniers messages d’une inbox.
object
Le motif à essayer, avec les règles d’un motif enregistré.
Example
code (\d+)La partie des messages que le motif lit : text quand elle est absente.
Example
subjectResponses
Section intitulée « Responses »Ressource ExtractorTrial créée
Ce qu’un motif a capturé sur les derniers messages d’une inbox.
object
L’explication du moteur, en mots simples, quand le motif n’est pas valide ; null sinon.
La cause du refus sous forme de code, quand le motif n’est pas valide, pour un client qui la dit dans sa propre langue ; null sinon. invalid est un motif que le moteur ne sait pas compiler pour une raison qui n’a pas de code propre : error en donne les mots.
Sur combien de messages le motif a capturé exactement une valeur.
Un par message, le plus récent d’abord. Plus d’une capture sur un message est ambigu : seule la première est gardée à la réception.
object
Sur combien de messages le motif a été essayé : vingt au plus.
Faux quand le moteur ne peut pas compiler le motif : error dit alors pourquoi et il n’y a pas de résultat.
Example
{ "errorCode": "lookahead"}Entrée invalide
Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.
object
Le code stable du refus. Il ne change jamais une fois publié.
Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.
Le statut HTTP.
Le nom du statut HTTP.
L’adresse du problème : /errors/<code>.
Sur un corps qui échoue à la validation, une entrée par champ.
object
Example
{ "code": "BAD_REQUEST", "status": 404, "title": "Not Found", "type": "/errors/INBOX_NOT_FOUND", "violations": [ { "code": "BAD_REQUEST" } ]}Aucune clé, ou une clé refusée. WWW-Authenticate dit où lire comment en présenter une.
Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.
object
Le code stable du refus. Il ne change jamais une fois publié.
Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.
Le statut HTTP.
Le nom du statut HTTP.
L’adresse du problème : /errors/<code>.
Sur un corps qui échoue à la validation, une entrée par champ.
object
Example
{ "code": "BAD_REQUEST", "status": 404, "title": "Not Found", "type": "/errors/INBOX_NOT_FOUND", "violations": [ { "code": "BAD_REQUEST" } ]}La clé n’a pas la permission de l’opération, ou l’opération refuse toutes les clés.
Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.
object
Le code stable du refus. Il ne change jamais une fois publié.
Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.
Le statut HTTP.
Le nom du statut HTTP.
L’adresse du problème : /errors/<code>.
Sur un corps qui échoue à la validation, une entrée par champ.
object
Example
{ "code": "BAD_REQUEST", "status": 404, "title": "Not Found", "type": "/errors/INBOX_NOT_FOUND", "violations": [ { "code": "BAD_REQUEST" } ]}Il n’y a rien avec cet identifiant à la portée de la clé. La réponse est la même pour une autre organisation ou un espace de travail que la clé ne nomme pas.
Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.
object
Le code stable du refus. Il ne change jamais une fois publié.
Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.
Le statut HTTP.
Le nom du statut HTTP.
L’adresse du problème : /errors/<code>.
Sur un corps qui échoue à la validation, une entrée par champ.
object
Example
{ "code": "BAD_REQUEST", "status": 404, "title": "Not Found", "type": "/errors/INBOX_NOT_FOUND", "violations": [ { "code": "BAD_REQUEST" } ]}Plus d’appels que la clé n’en peut faire en une minute. Retry-After dit quand réessayer.
Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.
object
Le code stable du refus. Il ne change jamais une fois publié.
Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.
Le statut HTTP.
Le nom du statut HTTP.
L’adresse du problème : /errors/<code>.
Sur un corps qui échoue à la validation, une entrée par champ.
object
Example
{ "code": "BAD_REQUEST", "status": 404, "title": "Not Found", "type": "/errors/INBOX_NOT_FOUND", "violations": [ { "code": "BAD_REQUEST" } ]}Any refusal: an application/problem+json body whose code says which.
Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.
object
Le code stable du refus. Il ne change jamais une fois publié.
Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.
Le statut HTTP.
Le nom du statut HTTP.
L’adresse du problème : /errors/<code>.
Sur un corps qui échoue à la validation, une entrée par champ.
object
Example
{ "code": "BAD_REQUEST", "status": 404, "title": "Not Found", "type": "/errors/INBOX_NOT_FOUND", "violations": [ { "code": "BAD_REQUEST" } ]}