REST API for forms - when to use it

HFCDev

Hi, 

  I was reviewing the API docs for the REST API mainly the forms API, and it refers to Alpaca forms a fair bit.  Can someone tell me when you'd want to use this REST API? Alpaca is a jQuery forms library AFAIK.  What is the purpose of using requests like /forms/categories/create/{cat_id}?

I noticed that this particular REST API seems to touch on categories, forms, and workflows in no particular order. Once again, what is the "why" of this API? i.e. when *should* we use it, or when would we want to?

Thanks

-Hugh

Kyle_Swidrovich

Hey Hugh,

 

The Alpaca model is an artifact of the roots of the original UI Widget framework, however, the Smart View uses the forms response data for its widgets.

You can see their use in widgets such as the Properties widget where we are prompting the user with edit capability for metadata.

 

The idea behind a form is that is supplies the caller with a list of fields that can be updated, if desired, with typing.

So if you’re using the returned data to build a UI that allows for editing the data, the /forms/ resource would likely be of interest to you to aid in UI modeling.

 

Kyle