Pipeline REST APIs
Authorized users can use REST APIs to manage Population Health Analytics pipelines programmatically from external applications instead of using the Population Health Analytics user interface.
This table shows the APIs that are available for pipeline management:
| API | Method | Description |
|---|---|---|
| Launch Pipeline | POST | Launches a pipeline |
| Get Pipeline Status | GET | Retrieves the status of a pipeline |
| Get Last N Pipeline Status | GET | Retrieves status information for recent pipeline launches and currently queued pipelines |
To use Pipeline REST APIs, the Infor API infrastructure is used for authentication and authorization. All API requests must include valid authentication credentials.
Required roles
Access to each API is determined by the role of the user in Population Health Analytics.
This table shows the roles that can access each Pipeline REST API:
| API | IPHA-User | IPHA-ProcessAdmin | IPHA-SysAdmin |
|---|---|---|---|
| Launch Pipeline | ✓ | ✓ | |
| Get Pipeline Status | ✓ | ✓ | ✓ |
| Get Last N Pipeline Status | ✓ | ✓ | ✓ |