Référence API
API : reply-templates
1 opérations REST du groupe reply-templates.
GET /reply-templates#
Réponses types des requêtes (organisation et personnelles de l'acteur, actives)
Scopes d'app : requests:read. Les autres droits, périmètres et contrôles métier restent applicables.
Paramètres
| Nom | Emplacement | Requis | Schéma |
|---|---|---|---|
reason | query | Non | {"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Ne garder que ce motif et les réponses de tous les motifs","type":"string","maxLength":200} |
Aucun corps de requête déclaré dans ce contrat.
Réponses
200 : Les réponses types utilisables par l'acteur de la clé
Contenu de la réponse 200
{
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"reason": {
"description": "Motif visé ; null = tous les motifs",
"type": [
"string",
"null"
]
},
"body": {
"type": "string",
"description": "Texte en marqueurs du fil (**gras**, _italique_), variables {{prenom}}, {{nom}}, {{societe}}, {{numero}}, {{titre}}, {{entite}}, {{signature}}"
},
"setStatus": {
"anyOf": [
{
"type": "string",
"enum": [
"in_progress",
"waiting_client",
"resolved"
]
},
{
"type": "null"
}
],
"description": "Statut posé à l'envoi"
},
"addTag": {
"description": "Étiquette posée à l'envoi",
"type": [
"string",
"null"
]
},
"scope": {
"type": "string",
"enum": [
"organization",
"personal"
]
}
},
"required": [
"id",
"name",
"reason",
"body",
"setStatus",
"addTag",
"scope"
],
"additionalProperties": false
}
},
"nextCursor": {
"type": "null"
}
},
"required": [
"data",
"nextCursor"
],
"additionalProperties": false
}
}
}default : Erreur - enveloppe problem+json (RFC 9457)
Contenu de la réponse default
{
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}Opération OpenAPI complète
{
"summary": "Réponses types des requêtes (organisation et personnelles de l'acteur, actives)",
"tags": [
"Requêtes"
],
"parameters": [
{
"name": "reason",
"in": "query",
"required": false,
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Ne garder que ce motif et les réponses de tous les motifs",
"type": "string",
"maxLength": 200
}
}
],
"security": [
{
"oauth2": [
"requests:read"
]
},
{
"userSession": []
}
],
"responses": {
"200": {
"description": "Les réponses types utilisables par l'acteur de la clé",
"content": {
"application/json": {
"schema": {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"name": {
"type": "string"
},
"reason": {
"description": "Motif visé ; null = tous les motifs",
"type": [
"string",
"null"
]
},
"body": {
"type": "string",
"description": "Texte en marqueurs du fil (**gras**, _italique_), variables {{prenom}}, {{nom}}, {{societe}}, {{numero}}, {{titre}}, {{entite}}, {{signature}}"
},
"setStatus": {
"anyOf": [
{
"type": "string",
"enum": [
"in_progress",
"waiting_client",
"resolved"
]
},
{
"type": "null"
}
],
"description": "Statut posé à l'envoi"
},
"addTag": {
"description": "Étiquette posée à l'envoi",
"type": [
"string",
"null"
]
},
"scope": {
"type": "string",
"enum": [
"organization",
"personal"
]
}
},
"required": [
"id",
"name",
"reason",
"body",
"setStatus",
"addTag",
"scope"
],
"additionalProperties": false
}
},
"nextCursor": {
"type": "null"
}
},
"required": [
"data",
"nextCursor"
],
"additionalProperties": false
}
}
}
},
"default": {
"description": "Erreur - enveloppe problem+json (RFC 9457)",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
}
}
}