Skip to main content

Response Conventions - TypeScript SDK

ShapeFieldsMeaning
PageResult<T>items, total, page, pageSize, totalPagesA 1-based page of resources.
DownloadUrlurl, expirationA temporary object download URL and its expiration time.
TrainingArtifactDownloadurls, optional files; legacy url may also appearTemporary URLs for one or more Training artifact files.
WorkloadAdmissionPreviewVOclusterId, decision, maxSchedulableReplicas, reasonCodes, reasons, warningCodes, warnings, capacity, snapshotAtPoint-in-time resource preflight; it does not reserve capacity.
WorkloadClusterOptionVOid, name, status, selectable, reasonCodes, reasons, warnings, capacityA cluster option and why it can or cannot be selected.
nullno fieldsThe server accepted a command that has no result payload.

Unknown response fields are preserved. The field lists below identify the stable fields callers normally consume; they do not remove additional fields returned by the server.