Newer Version Available

This content describes an older version of this product. View Latest

Check Upload Readiness

Checks whether the UDLO (Unified Data Lake Object) is ACTIVE and ready for file uploads.

With waitMaxTime=0 (default), performs one check and returns immediately. With waitMaxTime > 0, the server polls internally until ready=true or the timeout, avoiding tight client polling loops.

Resource

1/einstein/data-libraries/libraryId/upload-readiness

The libraryId is the 18 character library ID that has a prefix of 1JD.

HTTP Methods

GET

Request parameters
Parameter Type Description Required Available Version
waitMaxTime integer (int64) Max milliseconds to wait for UDLO readiness (server-side polling). Default 0: single immediate check. Range 1120000 for wait behavior. Values < 0 or > 120000 produce 400. No 66.0
Request body

None.

Response body

HTTP 200—UploadReadinessOutputRepresentation

Property Type Description Available Version
libraryId string Library ID. 66.0
ready boolean true if UDLO is ACTIVE and uploads are allowed. 66.0
sourceType string Source type (example: SFDRIVE). 66.0
message string Human-readable status. 66.0

HTTP 400—Invalid waitMaxTime.

HTTP 404—Library not found.