Configuring API-Enabled Fields

Global Administrators with an Advanced Administration certificate can define required fields for an API by API User. This allows each API user (i.e., consumer) of the API to have their own definition of the required fields for the dataform without impacting an API user who is running on a different pipeline.

 

You can set up distinct groupings of required fields for each API User (System Admin > Advanced > API Users) only if the API User record is configured with a unique pipeline (which is our recommended best practice). Then, when you associate a group of fields with the pipeline of API User 1, for instance, you can also associate another group of fields with the pipeline of API User 2 and have some of those fields be the same as or different from those associated with API User 1. This is illustrated in the diagram below:

To configure API-enabled fields:

  1. Go to System Admin > Advanced > Dataform Admin.

    The Dataform Admin dashboard opens.

  2. Locate the API-enabled dataform and then click (Open) next to the dataform name.

    The Dataform Properties form opens.

    Note: To make a dataform API-enabled, click the Include in API checkbox on the Dataform Properties. This setting enables the API Configuration link that we will be using to associate fields to pipelines.

  3. Click API Configuration in the Action Center.

    The API-Enabled Fields window displays.

  4. Click Add.

    The Select Pipeline window displays.

  5. Select the Pipeline and click Next. (This should match the pipeline of the API User record which coincides with the group of required API-enabled fields you are now configuring.)

    The API-Enable Fields window displays the fields for the dataform in alphabetical order under an All Fields group, with the column name of each field shown in parentheses next to the field name. Fields that are already API-enabled for the pipeline are selected.

  6. Select the fields to API-enable for the pipeline and then click Save.

    • Select or clear individual fields to add them to or remove them from the pipeline.

    • Select or clear All Fields to select or clear every field listed.

    • Use the search box to find fields by field name or column name. Selections you made remain in place when the search hides them, and the number of selected fields is displayed.

    Note: Click Back to return to the pipeline selection step; the pipeline you selected is cleared. If you have unsaved field changes when you click Back, Cancel, or close the window, a message asks you to confirm before you return to pipeline selection or to the API field configuration dashboard. Click Ok to discard your changes and continue, or Cancel to stay on the current window and keep your changes.

  7. Repeat these steps for each API User pipeline until you have defined the form for every API User.

    Note: When you are finished, you can conduct a More search to filter by pipeline and verify your entries.