API ReferenceBulk SyncExecutions

Export Sync Logs

Starts an asynchronous job that packages the log files for a single bulk sync execution into a downloadable archive. > 📘 Log export is asynchronous > > This endpoint starts a background job that packages an execution's log > files into a downloadable archive. The first call typically returns a > `job` descriptor instead of a completed result. Poll > [`GET /api/jobs/exportlogs/{id}`](https://apidocs.polytomic.com/api-reference/jobs/get) > with the returned `job_id` until `status` is `done`; the final response > contains a signed `url` that can be used to download the archive. > > Set `notify=true` to also email the requesting user when the archive is > ready.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Path parameters

sync_idstringRequiredformat: "uuid"
Unique identifier of the bulk sync.
execution_idstringRequiredformat: "uuid"
Unique identifier of the execution whose logs should be exported.

Headers

X-Polytomic-VersionstringRequired

Query parameters

notifybooleanOptional
Send a notification to the user when the logs are ready for download.

Response

OK
dataobject
jobobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error