APPS_V2

Get Summary Endpoint

Changed on

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}

Request

  • Base URL: https://api.myaltimate.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.myaltimate.com/api/v2/summaries/{name}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

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

  • a1870d258a3aRevision changes
    • info

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

  • eb8306fa77ddRevision changes
    • info

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

    • info

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