Aller au contenu principal

Navigation du site

Votre compte

Choisissez votre langue

Step Forms

A Step Form is attached to a guide step as part of the data-entry feature. Data recorded from these forms may be accessed via the Work Log endpoints.

GET /step_forms/stepid/{stepid}

Get metadata on a Step Form for a step with a known stepid. Data on Step Form Fields includes field_guid. This is a string that will remain the same between revisions of the same field. This allows old data to be correlated with new data after a modification is made to a form, since the field_revisionid changes, but the field_guid does not. Also listed is the field_type. This can be one of 'Text Input', 'Text Area', 'Numeric Input', 'Checkbox', 'Image', 'Radios', or 'Select'. Text Inputs use the 'placeholder' field and ignore the 'textarea' field. Text Areas use the 'textarea' field and ignore the 'placeholder' field. Checkboxes default to a checked state when 'placeholder' is '1'. Text Areas may include line breaks, while Text Inputs may not. 'options' holds JSON representing an array of options.

GET /step_forms/form_revisionid/{form_revisionid}

Get metadata on a Step Form with a known form_revisionid. See detailed description at GET /step_forms/stepid/{stepid}.

GET /step_forms/field_revisionid/{field_revisionid}

Get metadata on a Step Form containing a field with a known field_revisionid. See detailed description at GET /step_forms/stepid/{stepid}. This may be useful when examining old Work Log data, since that data may be keyed on field_revisionid. Multiple field_revisionids may give the same response, since a form may have multiple fields.

GET /step_forms/guideid/{guideid}

Get metadata on a Step Form for all steps attached to a known guideid, including prerequisite guides. Using the max_form_revisionid query parameter makes retrieving Step Form data for a given Work Log entry simple, since the Work Log specifies max_form_revisionid. See detailed description at GET /step_forms/stepid/{stepid}. Note that ordering of forms is not guaranteed, and there may not be a form for each step.

POST /step_forms/{stepid}

Save a new or updated Step Form to a given stepid. Not all fields must be supplied, but some fields are required with certain input types.