latestOpenAPI 3.0.12026-08-1781258463.9 KB

2ecf51b1543e

AFNOR XP Z12-013/FlowService

🇫🇷 Norme · Select flows upon criteria

Retrieves a set of flows matching the provided search criteria:

  • Need at least one criterion to be specified

  • Assuming a logical AND when combining criteria

  • Assuming a logical OR for criteria allowing a list of values

Pagination works with 2 different ways:

  • with dates and the updatedAfter property

    • the comparison with current date is strict : updatedAt > updatedAfter
  • with cursors (more secure)

    • in case of pagination a nextCursor will be returned

    • next pagination call shall set cursor value to nextCursor value of last call

post/flow-service/v1/flows/search

Headers

Request-Idstring uuid
Organization-Idstring

Request body

limitinteger nullable
cursorstring nullable

If cursor is provided, then start search starting from that cursor

Response

OK

limitinteger nullable
nextCursorstring nullable

Pagination management:

  • If present, says where to start for next page, set nextCursor as the cursor in the next request

  • If omitted, says that pagination is finished