The POST {{davinciAuthPath}}/company/{{companyID}}/policy/{{policyID}}/start endpoint initiates the flow (or flows) that are included in the flow policy specified by {{policyID}} in the request URL. However, before you can initiate a flow policy, you must complete the following tasks:

  1. Create an application configuration.

  2. Create the flow actions.

  3. Create the flow policy and associate a flow (or flows) with the policy.

  4. Associate the deployed flow policy with the application.

For more information, see Creating an application, How to create a flow, and How to create a flow policy.

You can associate multiple flow policies with an application. The /start API initiates a flow policy associated with an application, depending on the {{policyID}} passed in with the request.

Using an input schema with the flow

Flows can receive input parameters when invoked. It is good practice to configure the flow to validate input provided by users. Associating an input schema with the flow achieves input validation to ensure that the flow only allows input that meets your data criteria.

The following sample shows the request body for a /start request that uses input schema values in a user profile update flow. If input schema properties are designated as required, the flow invocation needs to pass in the required parameters to start the flow.

{
    "hostname": "bxhealth.devops.com",
    "dn": "uid=testpatient,ou=People,dc=bxhealth,dc=org",
    "modifications": [
        {
            "attributeName": "givenName",
            "modificationType": "set",
            "values": [
                "PatientFirst"
            ]
        },
        {
            "attributeName": "sn",
            "modificationType": "set",
            "values": [
                "PatientLast"
            ]
        }
    ]
}