Aller au contenu
TellMeHow Documentation
fr

Documentation de l’API

Sources

Sources : 10 opérations de l’API, avec leurs paramètres, leur corps, leurs réponses et un exemple curl.

GET /engagements/{engagement}/artifacts

Lecture engagements.sources.artifacts.index

Paramètres

engagement chemin
Identifiant (ULID).
cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/artifacts" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/artifacts

Écriture engagements.sources.artifacts.store

Paramètres

engagement chemin
Identifiant (ULID).

Corps multipart/form-data

  • file file requis

    longueur : au plus 25600

Réponses

  • 201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/artifacts" \
  -H "Authorization: Bearer pat_…" \
  -F "file=@./file.pdf"

GET /engagements/{engagement}/artifacts/{artifact}

Lecture engagements.sources.artifacts.show

Paramètres

engagement chemin
Identifiant (ULID).
artifact chemin
Identifiant (ULID).
cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/artifacts/{artifact}" \
  -H "Authorization: Bearer pat_…"

DELETE /engagements/{engagement}/artifacts/{artifact}

Écriture engagements.sources.artifacts.destroy

Paramètres

engagement chemin
Identifiant (ULID).
artifact chemin
Identifiant (ULID).

Réponses

  • 204 Supprimé, sans contenu.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl -X DELETE "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/artifacts/{artifact}" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/artifacts/{artifact}/download

Lecture engagements.sources.artifacts.download

Paramètres

engagement chemin
Identifiant (ULID).
artifact chemin
Identifiant (ULID).
cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/artifacts/{artifact}/download" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/external-sources

Lecture engagements.sources.external-sources.index

Paramètres

engagement chemin
Identifiant (ULID).
cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/external-sources" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/external-sources

Écriture engagements.sources.external-sources.store

Paramètres

engagement chemin
Identifiant (ULID).

Corps multipart/form-data

  • file file requis

    longueur : au plus 10240

  • name string requis

    longueur : au plus 255

Réponses

  • 201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/external-sources" \
  -H "Authorization: Bearer pat_…" \
  -F "file=@./file.pdf" \
  -F "name=…"

DELETE /engagements/{engagement}/external-sources/{source}

Écriture engagements.sources.external-sources.destroy

Paramètres

engagement chemin
Identifiant (ULID).
source chemin
Identifiant (ULID).

Réponses

  • 204 Supprimé, sans contenu.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl -X DELETE "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/external-sources/{source}" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/external-sources/{source}/items

Lecture engagements.sources.external-sources.items

Paramètres

engagement chemin
Identifiant (ULID).
source chemin
Identifiant (ULID).
cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/external-sources/{source}/items" \
  -H "Authorization: Bearer pat_…"

GET /sources/schema/external-source/{version}

Lecture sources.schema

Paramètres

version chemin
Identifiant (ULID).
cursor limit requête
Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

  • 200 Succès : la ressource dans data.
  • 401 Jeton absent, invalide, révoqué ou expiré.
  • 403 Non autorisé par le rôle, une règle ou la portée.
  • 404 Ressource inconnue ou hors de l’espace.
  • 422 Données invalides (validation.failed).
  • 429 Limite de débit atteinte.
Exemple 
curl "https://{votre-espace}.tellmehow.io/api/v1/sources/schema/external-source/{version}" \
  -H "Authorization: Bearer pat_…"