Axuz Developers

POST /teams/{teamId}/flowcharts/{id}/commit

Commit explícito de uma versão.

  • Access: Team member
  • Service: https://api-flow.axuz.net

Accepted authentication

  • sessionCookie — Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.
  • bearerSession — JWT de acesso da sessão em `Authorization: Bearer`.

— POST /teams/{tid}/flowcharts/{id}/commit 1) Lê MAX(version) atual sob FOR UPDATE, 2) UPDATE flowcharts SET document=$, version=$, updated_at=now(), 3) INSERT INTO flowchart_versions com source/reason/created_by, 4) DELETE do draft do user (commit consumiu).

Retorna 201 { version: FlowchartVersion } com os campos populados.

Parameters

NameInTypeRequiredDescription
teamIdpathstringyes
idpathstringyes

Request body

application/json · Required

NameTypeRequiredDescription
documentFlowDocumentyes

Shape enxuta espelhando lib/types.ts:FlowDocument no client. Backend não valida a shape interna (opaco pro storage); os campos abaixo são o mínimo comum consumido pelo editor.

document.nodesarray<FlowNode>yes
document.nodes[].idstringyes
document.nodes[].typestringyes
document.nodes[].positionFlowXYyes
document.nodes[].position.xnumberyes
document.nodes[].position.ynumberyes
document.nodes[].widthinteger | nullno
document.nodes[].heightinteger | nullno
document.nodes[].parentNodestringno
document.nodes[].extentstringno
document.nodes[].dataobjectyes
document.nodes[].styleobjectno
document.edgesarray<FlowEdge>yes
document.edges[].idstringyes
document.edges[].sourcestringyes
document.edges[].targetstringyes
document.edges[].typestringno
document.edges[].dataobjectno
reasonstringno
sourcestringno

enum: "autosave", "manual", "ai", "branch"

{
  "document": {
    "nodes": [
      {
        "id": "string",
        "type": "string",
        "position": {},
        "width": 1,
        "height": 1,
        "parentNode": "string",
        "extent": "string",
        "data": {},
        "style": {}
      }
    ],
    "edges": [
      {
        "id": "string",
        "source": "string",
        "target": "string",
        "type": "string",
        "data": {}
      }
    ]
  },
  "reason": "string",
  "source": "manual"
}

Responses

201

Versão criada.

NameTypeRequiredDescription
idstring<uuid>yes
flowchart_idstring<uuid>yes
versionintegeryes
created_bystring<uuid>yes
created_atstring<date-time>yes
sourcestringyes

enum: "autosave", "manual", "ai", "branch", "shared_interact"

reasonstring | nullno
parent_version_idstring<uuid> | nullno

400

Payload inválido.

NameTypeRequiredDescription
errorstringyes

401

JWT ausente/expirado.

NameTypeRequiredDescription
errorstringyes

403

Sem permissao (nao e owner/admin; token sem escopo; token de integracao em rota nao permitida)

NameTypeRequiredDescription
errorstringyes

404

Recurso não encontrado ou fora de escopo.

NameTypeRequiredDescription
errorstringyes

429

Limite de requisições excedido.

NameTypeRequiredDescription
errorstringyes

500

Falha inesperada (log + trace).

NameTypeRequiredDescription
errorstringyes

Examples

"Try it" is turned off in this reference. Use the examples with your test credential.

curl

curl -sS -X POST 'https://api-flow.axuz.net/teams/TEAM_ID/flowcharts/ID/commit' \
  -H "Authorization: Bearer $AXUZ_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"document":{"nodes":[{"id":"string","type":"string","position":{},"width":1,"height":1,"parentNode":"string","extent":"string","data":{},"style":{}}],"edges":[{"id":"string","source":"string","target":"string","type":"string","data":{}}]},"reason":"string","source":"manual"}'

Node.js

const res = await fetch("https://api-flow.axuz.net/teams/TEAM_ID/flowcharts/ID/commit", {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "document": {
      "nodes": [
        {
          "id": "string",
          "type": "string",
          "position": {},
          "width": 1,
          "height": 1,
          "parentNode": "string",
          "extent": "string",
          "data": {},
          "style": {}
        }
      ],
      "edges": [
        {
          "id": "string",
          "source": "string",
          "target": "string",
          "type": "string",
          "data": {}
        }
      ]
    },
    "reason": "string",
    "source": "manual"
  }),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "POST",
    "https://api-flow.axuz.net/teams/TEAM_ID/flowcharts/ID/commit",
    headers={
        "Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
    },
    json={
        "document": {
            "nodes": [
                {
                    "id": "string",
                    "type": "string",
                    "position": {},
                    "width": 1,
                    "height": 1,
                    "parentNode": "string",
                    "extent": "string",
                    "data": {},
                    "style": {},
                },
            ],
            "edges": [
                {
                    "id": "string",
                    "source": "string",
                    "target": "string",
                    "type": "string",
                    "data": {},
                },
            ],
        },
        "reason": "string",
        "source": "manual",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())