Sign in

List entities (optionally filtered by type), ordered by type then name. Paginated: limit defaults to 100 and is capped at 500; follow page.nextCursor to walk the Context.

get/api/v1/{context_id}/entities

Path parameters

context_idstring required

Spectron context id

Query parameters

typestring

Filter by entity type

limitinteger

Max entities to return (default 100, max 500)

cursorstring

Continuation token from the previous page's page.nextCursor

countboolean

Also return page.totalSize (costs a full count of the filtered set)

offsetinteger

Deprecated: rows to skip. Use cursor.

Response

Changes

Changed in 3 of the 5 revisions of this API.27

  • 9f15987130675See the full diff
    • ○

      added the new optional query request parameter count

      new-optional-request-parameter

    • ○

      added the new optional query request parameter cursor

      new-optional-request-parameter

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 503

      response-non-success-status-added

    • ○

      added the required property page to the response with the 200 status

      response-required-property-added

  • 52b41ab517b62See the full diff
    • ○

      added the new optional query request parameter limit

      new-optional-request-parameter

    • ○

      added the new optional query request parameter offset

      new-optional-request-parameter

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

  • 741d58b9ef892See the full diff
    • ●

      deleted the query request parameter limit

      request-parameter-removed

    • ●

      deleted the query request parameter offset

      request-parameter-removed

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