Skip to main content

Formations

SDK methods for the Formations module, accessed via soat.formations. See the Formations module docs for permissions and data model, and each method's REST page for the full request/response schema.

soat.formations.validateFormation()​

Validate a formation template

  • Method: POST
  • Path: /api/v1/formations/validate
await soat.formations.validateFormation({
  body: { /* + optional */ },
});

→ Request & response schema

soat.formations.planFormation()​

Plan a formation deployment

  • Method: POST
  • Path: /api/v1/formations/plan
await soat.formations.planFormation({
  body: { template, /* + optional */ },
});

→ Request & response schema

soat.formations.listFormations()​

List formations

  • Method: GET
  • Path: /api/v1/formations
await soat.formations.listFormations({
  query: { /* + optional */ },
});

→ Request & response schema

soat.formations.createFormation()​

Create a new formation

  • Method: POST
  • Path: /api/v1/formations
await soat.formations.createFormation({
  body: { name, template, /* + optional */ },
});

→ Request & response schema

soat.formations.getFormation()​

Get a specific formation

  • Method: GET
  • Path: /api/v1/formations/{formation_id}
await soat.formations.getFormation({
  path: { formation_id },
});

→ Request & response schema

soat.formations.updateFormation()​

Update an formation

  • Method: PUT
  • Path: /api/v1/formations/{formation_id}
await soat.formations.updateFormation({
  path: { formation_id },
  body: { /* + optional */ },
});

→ Request & response schema

soat.formations.deleteFormation()​

Delete an formation

  • Method: DELETE
  • Path: /api/v1/formations/{formation_id}
await soat.formations.deleteFormation({
  path: { formation_id },
});

→ Request & response schema

soat.formations.listFormationEvents()​

List formation operation events

  • Method: GET
  • Path: /api/v1/formations/{formation_id}/events
await soat.formations.listFormationEvents({
  path: { formation_id },
  query: { /* + optional */ },
});

→ Request & response schema