Back to Main Menu

Get Assessment Forms

Introduction

There are two API's for getting information about an Assessment Form:

  • GET /api/v2/assessmentformdetail
    • Gets a list of assessment forms with basic detail about the form
  • GET /api/v2/assessmentform/{id}
    • Gets the full detail of a specific form

GET /api/v2/assessmentformdetail

The Assetic REST API GET /api/v2/assessmentformdetail returns a list of Assessment Forms with the following fields for each form:

Property Description
Id Unique system generated identifier for the form
Label The user friendly name of the form
Name The reference name of the form
Version A version number to assign.  Integer value.
CanAddAttachment Whether documents be attached to form results.  Boolean true or false
ApplicableLevel What Assetic module/level is the form for
Status The current status of the form

Note that this API currently only ever returns forms with a status of "Published"

Filters and Pagination

A filter can be applied to restrict the number of forms returned.  The article Search Filters and Pagination describes how to apply search filters.

The sample below illustrates a search for all published assessment forms where the name contains "Sample".  It returns 50 forms in the first page.

https://[yoursite].assetic.net/api/v2/assessmentformdetail?
requestParams.filters=Name~contains~'Sample'
&requestParams.page=1&requestParams.pageSize=50

GET /api/v2/assessmentform/{id} 

The Assetic REST API GET /api/v2/assessmentform/{id} returns the complete form definition for a given Assessment Form "Name" or "Id".  The structure of the form definition is defined in the article Assessment Form Creation.

The sample below illustrates the GET for a form with the Name "KBSample" using the form "Name" property

https://[yoursite].assetic.net/api/v2/assessmentform/KBSample

The same form may be retrieved using it's "Id" property (obtained via the API  GET /api/v2/assessmentformdetail)

https://[yoursite].assetic.net/api/v2/assessmentform/6a061465-5a98-e711-8187-025500ccdddb