Aller au contenu
TellMeHow Documentation

Documentation de l’API

Analyse

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

GET /analysis/enums/{name}

Lecture analysis.enums

Paramètres

name chemin
Valeur d’une liste fixe (type, langue, niveau…).
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/analysis/enums/{name}" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/analysis/runs

Lecture engagements.analysis.runs.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}/analysis/runs" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/analysis/runs

Écriture engagements.analysis.runs.store

Paramètres

engagement chemin
Identifiant (ULID).

Corps application/json

  • mode object requis

    une valeur parmi incremental full

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}/analysis/runs" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"mode":"incremental"}'

POST /engagements/{engagement}/analysis/runs/{run}/cancel

Écriture engagements.analysis.runs.cancel

Paramètres

engagement chemin
Identifiant (ULID).
run chemin
Identifiant (ULID).

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}/analysis/runs/{run}/cancel" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/analysis/summary

Lecture engagements.analysis.summary

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}/analysis/summary" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/change-proposals

Lecture engagements.analysis.change-proposals.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}/change-proposals" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/change-proposals/accept-all

Écriture engagements.analysis.change-proposals.accept-all

Paramètres

engagement chemin
Identifiant (ULID).

Corps application/json

  • entity_type object

    une valeur parmi process process_step process_flow finding opportunity

  • analysis_run_id string | null

    longueur : exactement 26

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}/change-proposals/accept-all" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"entity_type":"process","analysis_run_id":"01JABCDEFGHJKMNPQRSTVWXYZ0"}'

POST /engagements/{engagement}/change-proposals/reject-all

Écriture engagements.analysis.change-proposals.reject-all

Paramètres

engagement chemin
Identifiant (ULID).

Corps application/json

  • entity_type object

    une valeur parmi process process_step process_flow finding opportunity

  • analysis_run_id string | null

    longueur : exactement 26

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}/change-proposals/reject-all" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"entity_type":"process","analysis_run_id":"01JABCDEFGHJKMNPQRSTVWXYZ0"}'

POST /engagements/{engagement}/change-proposals/{proposal}/accept

Écriture engagements.analysis.change-proposals.accept

Paramètres

engagement chemin
Identifiant (ULID).
proposal chemin
Identifiant (ULID).

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}/change-proposals/{proposal}/accept" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/change-proposals/{proposal}/reject

Écriture engagements.analysis.change-proposals.reject

Paramètres

engagement chemin
Identifiant (ULID).
proposal chemin
Identifiant (ULID).

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}/change-proposals/{proposal}/reject" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/contradictions

Lecture engagements.analysis.contradictions.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}/contradictions" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/contradictions/{contradiction}/resolve

Écriture engagements.analysis.contradictions.resolve

Paramètres

engagement chemin
Identifiant (ULID).
contradiction chemin
Identifiant (ULID).

Corps application/json

  • status string requis

    une valeur parmi resolved kept_as_finding dismissed

  • resolution_note string | null

    longueur : au plus 2000

  • resolved_finding_id string | null

    longueur : exactement 26

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}/contradictions/{contradiction}/resolve" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"status":"resolved"}'

PATCH /engagements/{engagement}/evidences/{evidence}

Écriture engagements.analysis.evidences.update

Paramètres

engagement chemin
Identifiant (ULID).
evidence chemin
Identifiant (ULID).

Corps application/json

  • is_publishable boolean requis

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 -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/evidences/{evidence}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"is_publishable":true}'

GET /engagements/{engagement}/evidences/{evidence}/preview

Lecture engagements.analysis.evidences.preview

Paramètres

engagement chemin
Identifiant (ULID).
evidence 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}/evidences/{evidence}/preview" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/findings

Lecture engagements.analysis.findings.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}/findings" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/findings

Écriture engagements.analysis.findings.store

Paramètres

engagement chemin
Identifiant (ULID).

Corps application/json

  • type object requis

    une valeur parmi irritant re_entry volume duration business_rule tool key_person_dependency risk good_practice other

  • statement string requis

    longueur : au plus 1000

  • details string | null

    longueur : au plus 4000

  • quantity array<object> | null
  • process_id string | null

    longueur : exactement 26

  • step_id string | null

    longueur : exactement 26

  • deliverable_category string | null

    longueur : au plus 64

  • evidences array<object>
  • evidences[].source_type object requis

    une valeur parmi transcript_segment screen_frame pin artifact_chunk external_source_item recap_item

  • evidences[].source_id string requis

    longueur : exactement 26

  • evidences[].locator array<object> | null
  • evidences[].excerpt string | null

    longueur : au plus 1000

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}/findings" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"type":"irritant","statement":"…"}'

GET /engagements/{engagement}/findings/{finding}

Lecture engagements.analysis.findings.show

Paramètres

engagement chemin
Identifiant (ULID).
finding 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}/findings/{finding}" \
  -H "Authorization: Bearer pat_…"

PATCH /engagements/{engagement}/findings/{finding}

Écriture engagements.analysis.findings.update

Paramètres

engagement chemin
Identifiant (ULID).
finding chemin
Identifiant (ULID).

Corps application/json

  • type object

    une valeur parmi irritant re_entry volume duration business_rule tool key_person_dependency risk good_practice other

  • statement string

    longueur : au plus 1000

  • details string | null

    longueur : au plus 4000

  • quantity array<object> | null
  • process_id string | null

    longueur : exactement 26

  • step_id string | null

    longueur : exactement 26

  • deliverable_category string | null

    longueur : au plus 64

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 -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/findings/{finding}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"type":"irritant","statement":"…","details":"…"}'

DELETE /engagements/{engagement}/findings/{finding}

Écriture engagements.analysis.findings.destroy

Paramètres

engagement chemin
Identifiant (ULID).
finding 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}/findings/{finding}" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/findings/{finding}/evidences

Écriture engagements.analysis.findings.evidences.store

Paramètres

engagement chemin
Identifiant (ULID).
finding chemin
Identifiant (ULID).

Corps application/json

  • source_type object requis

    une valeur parmi transcript_segment screen_frame pin artifact_chunk external_source_item recap_item

  • source_id string requis

    longueur : exactement 26

  • locator array<object> | null
  • excerpt string | null

    longueur : au plus 1000

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}/findings/{finding}/evidences" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"source_type":"transcript_segment","source_id":"01JABCDEFGHJKMNPQRSTVWXYZ0"}'

DELETE /engagements/{engagement}/findings/{finding}/evidences/{evidence}

Écriture engagements.analysis.findings.evidences.destroy

Paramètres

engagement chemin
Identifiant (ULID).
finding chemin
Identifiant (ULID).
evidence 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}/findings/{finding}/evidences/{evidence}" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/findings/{finding}/review

Écriture engagements.analysis.findings.review

Paramètres

engagement chemin
Identifiant (ULID).
finding chemin
Identifiant (ULID).

Corps application/json

  • review_status object requis

    une valeur parmi proposed validated rejected

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}/findings/{finding}/review" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"review_status":"proposed"}'

GET /engagements/{engagement}/follow-ups

Lecture engagements.analysis.follow-ups.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}/follow-ups" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/follow-ups

Écriture engagements.analysis.follow-ups.store

Paramètres

engagement chemin
Identifiant (ULID).

Corps application/json

  • reason object requis

    une valeur parmi contradiction gap uncertain_figure shallow_topic gain_data

  • title string requis

    longueur : au plus 255

  • questions array<string> requis

    éléments : au moins 2 éléments : au plus 5

  • estimated_minutes integer requis

    au moins 5 au plus 15

  • participant_ids array<string> requis

    éléments : au moins 1

  • contradiction_id string | null

    longueur : exactement 26

  • finding_id string | null

    longueur : exactement 26

  • topic_key string | null

    longueur : au plus 64

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}/follow-ups" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"reason":"contradiction","title":"…","questions":[],"estimated_minutes":5,"participant_ids":[]}'

PATCH /engagements/{engagement}/follow-ups/{proposal}

Écriture engagements.analysis.follow-ups.update

Paramètres

engagement chemin
Identifiant (ULID).
proposal chemin
Identifiant (ULID).

Corps application/json

  • title string

    longueur : au plus 255

  • questions array<string>

    éléments : au moins 2 éléments : au plus 5

  • estimated_minutes integer

    au moins 5 au plus 15

  • participant_ids array<string>

    éléments : au moins 1

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 -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/follow-ups/{proposal}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"title":"…","questions":[],"estimated_minutes":5}'

POST /engagements/{engagement}/follow-ups/{proposal}/accept

Écriture engagements.analysis.follow-ups.accept

Paramètres

engagement chemin
Identifiant (ULID).
proposal chemin
Identifiant (ULID).

Corps application/json

  • send_now boolean | null

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}/follow-ups/{proposal}/accept" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"send_now":true}'

POST /engagements/{engagement}/follow-ups/{proposal}/decline

Écriture engagements.analysis.follow-ups.decline

Paramètres

engagement chemin
Identifiant (ULID).
proposal chemin
Identifiant (ULID).

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}/follow-ups/{proposal}/decline" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/opportunities

Lecture engagements.analysis.opportunities.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}/opportunities" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/opportunities

Écriture engagements.analysis.opportunities.store

Paramètres

engagement chemin
Identifiant (ULID).

Corps application/json

  • title string requis

    longueur : au plus 255

  • problem string requis

    longueur : au plus 4000

  • solution string requis

    longueur : au plus 4000

  • category string requis

    longueur : au plus 64

  • gain array<object> | null
  • effort object requis

    une valeur parmi low medium high

  • priority string | null

    longueur : au plus 32

  • risks string | null

    longueur : au plus 2000

  • finding_ids array<string> requis

    éléments : au moins 1

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}/opportunities" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"title":"…","problem":"…","solution":"…","category":"…","effort":"low","finding_ids":[]}'

PATCH /engagements/{engagement}/opportunities/{opportunity}

Écriture engagements.analysis.opportunities.update

Paramètres

engagement chemin
Identifiant (ULID).
opportunity chemin
Identifiant (ULID).

Corps application/json

  • title string

    longueur : au plus 255

  • problem string

    longueur : au plus 4000

  • solution string

    longueur : au plus 4000

  • category string

    longueur : au plus 64

  • gain array<object> | null
  • effort object

    une valeur parmi low medium high

  • priority string | null

    longueur : au plus 32

  • risks string | null

    longueur : au plus 2000

  • finding_ids array<string>

    éléments : au moins 1

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 -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/opportunities/{opportunity}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"title":"…","problem":"…","solution":"…"}'

DELETE /engagements/{engagement}/opportunities/{opportunity}

Écriture engagements.analysis.opportunities.destroy

Paramètres

engagement chemin
Identifiant (ULID).
opportunity 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}/opportunities/{opportunity}" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/opportunities/{opportunity}/review

Écriture engagements.analysis.opportunities.review

Paramètres

engagement chemin
Identifiant (ULID).
opportunity chemin
Identifiant (ULID).

Corps application/json

  • review_status object requis

    une valeur parmi proposed validated rejected

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}/opportunities/{opportunity}/review" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"review_status":"proposed"}'

GET /engagements/{engagement}/processes

Lecture engagements.analysis.processes.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}/processes" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/processes

Écriture engagements.analysis.processes.store

Paramètres

engagement chemin
Identifiant (ULID).

Corps application/json

  • name string requis

    longueur : au plus 255

  • description string | null

    longueur : au plus 4000

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}/processes" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"…"}'

GET /engagements/{engagement}/processes/{process}

Lecture engagements.analysis.processes.show

Paramètres

engagement chemin
Identifiant (ULID).
process 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}/processes/{process}" \
  -H "Authorization: Bearer pat_…"

PATCH /engagements/{engagement}/processes/{process}

Écriture engagements.analysis.processes.update

Paramètres

engagement chemin
Identifiant (ULID).
process chemin
Identifiant (ULID).

Corps application/json

  • name string

    longueur : au plus 255

  • description string | null

    longueur : au plus 4000

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 -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/processes/{process}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","description":"…"}'

DELETE /engagements/{engagement}/processes/{process}

Écriture engagements.analysis.processes.destroy

Paramètres

engagement chemin
Identifiant (ULID).
process 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}/processes/{process}" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/processes/{process}/actors

Écriture engagements.analysis.actors.store

Paramètres

engagement chemin
Identifiant (ULID).
process chemin
Identifiant (ULID).

Corps application/json

  • role_label string requis

    longueur : au plus 255

  • population_id string | null

    longueur : exactement 26

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}/processes/{process}/actors" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"role_label":"…"}'

PATCH /engagements/{engagement}/processes/{process}/actors/{actor}

Écriture engagements.analysis.actors.update

Paramètres

engagement chemin
Identifiant (ULID).
process chemin
Identifiant (ULID).
actor chemin
Identifiant (ULID).

Corps application/json

  • role_label string requis

    longueur : au plus 255

  • population_id string | null

    longueur : exactement 26

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 -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/processes/{process}/actors/{actor}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"role_label":"…"}'

DELETE /engagements/{engagement}/processes/{process}/actors/{actor}

Écriture engagements.analysis.actors.destroy

Paramètres

engagement chemin
Identifiant (ULID).
process chemin
Identifiant (ULID).
actor 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}/processes/{process}/actors/{actor}" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/processes/{process}/flows

Écriture engagements.analysis.flows.store

Paramètres

engagement chemin
Identifiant (ULID).
process chemin
Identifiant (ULID).

Corps application/json

  • from_step_id string requis

    longueur : exactement 26

  • to_step_id string requis

    longueur : exactement 26

  • condition_label string | null

    longueur : au plus 255

  • variant_id string | null

    longueur : exactement 26

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}/processes/{process}/flows" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"from_step_id":"01JABCDEFGHJKMNPQRSTVWXYZ0","to_step_id":"01JABCDEFGHJKMNPQRSTVWXYZ0"}'

PATCH /engagements/{engagement}/processes/{process}/flows/{flow}

Écriture engagements.analysis.flows.update

Paramètres

engagement chemin
Identifiant (ULID).
process chemin
Identifiant (ULID).
flow chemin
Identifiant (ULID).

Corps application/json

  • condition_label string | null

    longueur : au plus 255

  • variant_id string | null

    longueur : exactement 26

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 -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/processes/{process}/flows/{flow}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"condition_label":"…","variant_id":"01JABCDEFGHJKMNPQRSTVWXYZ0"}'

DELETE /engagements/{engagement}/processes/{process}/flows/{flow}

Écriture engagements.analysis.flows.destroy

Paramètres

engagement chemin
Identifiant (ULID).
process chemin
Identifiant (ULID).
flow 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}/processes/{process}/flows/{flow}" \
  -H "Authorization: Bearer pat_…"

PUT /engagements/{engagement}/processes/{process}/layout

Écriture engagements.analysis.processes.layout

Paramètres

engagement chemin
Identifiant (ULID).
process chemin
Identifiant (ULID).

Corps application/json

  • nodes array<object> requis
  • edges array<object> | null
  • lanes string | null

    une valeur parmi none actor population

  • manual array<string>

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 -X PUT "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/processes/{process}/layout" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"nodes":[]}'

POST /engagements/{engagement}/processes/{process}/merge

Écriture engagements.analysis.processes.merge

Paramètres

engagement chemin
Identifiant (ULID).
process chemin
Identifiant (ULID).

Corps application/json

  • into_process_id string requis

    longueur : exactement 26

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}/processes/{process}/merge" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"into_process_id":"01JABCDEFGHJKMNPQRSTVWXYZ0"}'

POST /engagements/{engagement}/processes/{process}/review

Écriture engagements.analysis.processes.review

Paramètres

engagement chemin
Identifiant (ULID).
process chemin
Identifiant (ULID).

Corps application/json

  • review_status object requis

    une valeur parmi proposed validated rejected

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}/processes/{process}/review" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"review_status":"proposed"}'

POST /engagements/{engagement}/processes/{process}/split

Écriture engagements.analysis.processes.split

Paramètres

engagement chemin
Identifiant (ULID).
process chemin
Identifiant (ULID).

Corps application/json

  • step_ids array<string> requis

    éléments : au moins 1

  • new_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}/processes/{process}/split" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"step_ids":[],"new_name":"…"}'

POST /engagements/{engagement}/processes/{process}/steps

Écriture engagements.analysis.steps.store

Paramètres

engagement chemin
Identifiant (ULID).
process chemin
Identifiant (ULID).

Corps application/json

  • name string requis

    longueur : au plus 255

  • description string | null

    longueur : au plus 2000

  • step_type object

    une valeur parmi start task decision wait end

  • position integer | null

    au moins 1

  • after_step_id string | null

    longueur : exactement 26

  • actor_id string | null

    longueur : exactement 26

  • actor_role string | null

    longueur : au plus 255

  • tool_id string | null

    longueur : exactement 26

  • input_text string | null

    longueur : au plus 255

  • output_text string | null

    longueur : au plus 255

  • duration_estimate array<object> | null
  • volume_estimate array<object> | null

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}/processes/{process}/steps" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"…"}'

PATCH /engagements/{engagement}/processes/{process}/steps/{step}

Écriture engagements.analysis.steps.update

Paramètres

engagement chemin
Identifiant (ULID).
process chemin
Identifiant (ULID).
step chemin
Identifiant (ULID).

Corps application/json

  • name string

    longueur : au plus 255

  • description string | null

    longueur : au plus 2000

  • step_type object

    une valeur parmi start task decision wait end

  • position integer

    au moins 1

  • actor_id string | null

    longueur : exactement 26

  • actor_role string | null

    longueur : au plus 255

  • tool_id string | null

    longueur : exactement 26

  • input_text string | null

    longueur : au plus 255

  • output_text string | null

    longueur : au plus 255

  • duration_estimate array<object> | null
  • volume_estimate array<object> | null

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 -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/processes/{process}/steps/{step}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","description":"…","step_type":"start"}'

DELETE /engagements/{engagement}/processes/{process}/steps/{step}

Écriture engagements.analysis.steps.destroy

Paramètres

engagement chemin
Identifiant (ULID).
process chemin
Identifiant (ULID).
step 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}/processes/{process}/steps/{step}" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/processes/{process}/steps/{step}/evidences

Lecture engagements.analysis.steps.evidences

Paramètres

engagement chemin
Identifiant (ULID).
process chemin
Identifiant (ULID).
step 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}/processes/{process}/steps/{step}/evidences" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/processes/{process}/variants

Écriture engagements.analysis.variants.store

Paramètres

engagement chemin
Identifiant (ULID).
process chemin
Identifiant (ULID).

Corps application/json

  • name string requis

    longueur : au plus 255

  • condition_text string | null

    longueur : au plus 2000

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}/processes/{process}/variants" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"…"}'

PATCH /engagements/{engagement}/processes/{process}/variants/{variant}

Écriture engagements.analysis.variants.update

Paramètres

engagement chemin
Identifiant (ULID).
process chemin
Identifiant (ULID).
variant chemin
Identifiant (ULID).

Corps application/json

  • name string requis

    longueur : au plus 255

  • condition_text string | null

    longueur : au plus 2000

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 -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/processes/{process}/variants/{variant}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"…"}'

DELETE /engagements/{engagement}/processes/{process}/variants/{variant}

Écriture engagements.analysis.variants.destroy

Paramètres

engagement chemin
Identifiant (ULID).
process chemin
Identifiant (ULID).
variant 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}/processes/{process}/variants/{variant}" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/tools

Lecture engagements.analysis.tools.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}/tools" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/tools

Écriture engagements.analysis.tools.store

Paramètres

engagement chemin
Identifiant (ULID).

Corps application/json

  • name string requis

    longueur : au plus 255

  • kind object

    une valeur parmi software spreadsheet email paper messaging other

  • aliases array<string>

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}/tools" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"…"}'

PATCH /engagements/{engagement}/tools/{tool}

Écriture engagements.analysis.tools.update

Paramètres

engagement chemin
Identifiant (ULID).
tool chemin
Identifiant (ULID).

Corps application/json

  • name string

    longueur : au plus 255

  • kind object

    une valeur parmi software spreadsheet email paper messaging other

  • aliases array<string>

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 -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/tools/{tool}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","kind":"software","aliases":[]}'

DELETE /engagements/{engagement}/tools/{tool}

Écriture engagements.analysis.tools.destroy

Paramètres

engagement chemin
Identifiant (ULID).
tool 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}/tools/{tool}" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/tools/{tool}/merge

Écriture engagements.analysis.tools.merge

Paramètres

engagement chemin
Identifiant (ULID).
tool chemin
Identifiant (ULID).

Corps application/json

  • into_tool_id string requis

    longueur : exactement 26

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}/tools/{tool}/merge" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"into_tool_id":"01JABCDEFGHJKMNPQRSTVWXYZ0"}'