API reference · SoftwareOne Extensions
POST/api/extensions/{extensionId}/sync

Sync extension data

Generic extension sync placeholder. The current handler accepts any extensionId and optional syncAgreements and syncStatements booleans, simulates work, and returns dummy agreement and statement counts with meta extensionId in the response data. A full implementation will validate extension identity, check permissions, derive tenant context, call the extension-specific backend, and persist data.

Path parameters

extensionIdstringRequired
Extension identifier from the URL. The MVP generic routes accept any value and echo it in response metadata.

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 GenericExtensionSyncResponse

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.
extensionIdstringRequired
Extension ID echoed from the path.

Response codes

200
Generic extension sync placeholder completed successfully with dummy counts.
401
API key missing at middleware before the handler executes.
500
Unexpected failure while syncing extension data.