AWaws-samples
Flows

Flow Status

Changed on

Returns the Flow status property.

get/flows/{flowId}/status

Request

  • Base URL
    http://localhost:4010
  • URL
    http://localhost:4010/flows/{flowId}/status
  • Auth
    • HTTP bearer
    • or API key in query parameter access_token
    • or HTTP basic

Response

'awaiting_content' | 'ingesting' | 'replication_in_progress' | 'closed_complete' required

The current ingest status of a Flow. Available values are as follows. awaiting_content - Flow is expecting, but not currently receiving content. ingesting - Content is currently being ingested. replication_in_progress - Content is currently being ingested to this Flow from another Service Instance via a replication process. closed_complete - Flow is complete and will not receive any more content. NOTE: Because this parameter is maintained/updated by a Client, the value of this parameter is only indicative and not authoritative. If the Client ingesting the content becomes unavailable, it may leave this parameter in an incorrect state. Clients should aim to tidy up this state appropriately once they recover. Service Implementers MAY consider adding more active management of the status of Flows to mitigate Clients failing to tidy up on completion/failure, as part of more general lifecycle management capability, in line with the approach described for retention management. But Clients should not assume such capability.

Changes