FamilyService

ListFamilyAlignmentPoints

Lists all alignment points for a specific family version alignment.

get/api/v1/families/alignments/{familyAlignmentId}/points

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/families/alignments/{familyAlignmentId}/points
  • Auth: HTTP bearer

Path parameters

familyAlignmentIdstring required

Provide family_alignment_id to identify the family to list alignments points.

Query parameters

pageSizeinteger

The maximum number of family version alignment points to return. The service may return fewer than this value, even if there are additional pages. If unspecified, the limit defaults to 200. The maximum value is 1000.

filterstring

A Common Expression Language (CEL) filter string. Available fields to filter by are: family_run_id, and for the associated Run: name, description, start_time, end_time, duration. Note: name, description, start_time, end_time, and duration are filters on the associated run. For further information about how to use CELs, please refer to this guide.

pageTokenstring

A page token, received from a previous ListFamilyAlignmentPoints call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListFamilyAlignmentPoints must match the call that provided the page token.

Response

A successful response.

nextPageTokenstring

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Changes

No recorded changes to this operation across all 1 revision of this API.