POST/api/extensions/softwareone/sync

Sync SoftwareOne data

Triggers the SoftwareOne aggregate sync placeholder. The current handler accepts optional syncAgreements and syncStatements booleans, waits briefly to simulate work, and returns dummy counts and a syncedAt timestamp. A full implementation will validate permissions, derive tenant context, connect to the SoftwareOne API, and persist agreement and statement data.

Request body

Content type: application/json · schema SoftwareOneSyncRequest

fullSyncboolean

Optional future full-sync flag. Currently ignored by the MVP handlers.

syncStatementsboolean

Optional future statement sync flag. Currently ignored by the MVP handlers.

syncAgreementsboolean

Optional future agreement sync flag. Currently ignored by the MVP handlers.

Response body

Success response 200 · schema SoftwareOneFullSyncResponse

successbooleanRequired

Sync request completed successfully.

Enum: true

messagestringRequired

Human-readable sync result message.

dataobjectRequired

agreementsCountintegerRequired

Number of agreements synced. Zero when syncAgreements is false.

statementsCountintegerRequired

Number of statements synced. Zero when syncStatements is false.

syncedAtstring <date-time>Required

ISO timestamp when the dummy sync completed.

Response codes

200

Sync placeholder completed successfully with dummy counts.

401

API key missing at middleware before the handler executes.

500

Unexpected failure while syncing SoftwareOne data.

POST /api/extensions/softwareone/sync

cURL

curl -X POST "https://algapsa.com/api/extensions/softwareone/sync" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "fullSync": false,
  "syncStatements": false,
  "syncAgreements": false
}'

TypeScript

const response = await fetch("https://algapsa.com/api/extensions/softwareone/sync", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "fullSync": false,
    "syncStatements": false,
    "syncAgreements": false
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/extensions/softwareone/sync");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""fullSync"": false,
  ""syncStatements"": false,
  ""syncAgreements"": false
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "success": true,
  "message": "string",
  "data": {
    "agreementsCount": 1,
    "statementsCount": 1,
    "syncedAt": "2026-04-18T15:22:14Z"
  }
}