Sign in
APPS_V2

Get Summary Endpoint

Return a single summary's descriptor.

Resolved via visible_summary — the SAME platform-visibility (and feature-flag) gate POST /summaries/{name}/query uses — so a summary registered for another platform 404s (SUMMARY_NOT_FOUND), and a flag-gated summary with its flag off 404s (FEATURE_NOT_ENABLED), rather than either confirming its existence to a caller who should not see it.

get/api/v2/summaries/{name}

Path parameters

namestring required

Headers

x-tenantstring required
x-user-group-idstring nullable
x-timezonestring nullable

Response

Successful Response

namestring required
labelstring required
platformstring required
datasetstring required
partsstring[] required

Changes

Changed in 3 of the 55 revisions of this API.4

  • eb8306fa77dd2See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • fcb62c79da951See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a71fce1f5c261See the full diff
    • ○

      endpoint added

      endpoint-added