Skip to content

Latest commit

 

History

History
440 lines (239 loc) · 14.2 KB

FormInstanceResponse.md

File metadata and controls

440 lines (239 loc) · 14.2 KB

FormInstanceResponse

Properties

Name Type Description Notes
Created Pointer to time.Time Created is the date the form instance was assigned [optional]
CreatedBy Pointer to FormInstanceCreatedBy [optional]
Expire Pointer to string Expire is the maximum amount of time that a form can be in progress. After this time is reached then the form will be moved to a CANCELED state automatically. The user will no longer be able to complete the submission. When a form instance is expires an audit log will be generated for that record [optional]
FormConditions Pointer to []FormCondition FormConditions is the conditional logic that modify the form dynamically modify the form as the recipient is interacting out the form [optional]
FormData Pointer to map[string]interface{} FormData is the data provided by the form on submit. The data is in a key -> value map [optional]
FormDefinitionId Pointer to string FormDefinitionID is the id of the form definition that created this form [optional]
FormElements Pointer to []FormElement FormElements is the configuration of the form, this would be a repeat of the fields from the form-config [optional]
FormErrors Pointer to []FormError FormErrors is an array of form validation errors from the last time the form instance was transitioned to the SUBMITTED state. If the form instance had validation errors then it would be moved to the IN PROGRESS state where the client can retrieve these errors [optional]
FormInput Pointer to map[string]map[string]interface{} FormInput is an object of form input labels to value [optional]
Id Pointer to string Unique guid identifying this form instance [optional]
Modified Pointer to time.Time Modified is the last date the form instance was modified [optional]
Recipients Pointer to []FormInstanceRecipient Recipients references to the recipient of a form. The recipients are those who are responsible for filling out a form and completing it [optional]
StandAloneForm Pointer to bool StandAloneForm is a boolean flag to indicate if this form should be available for users to complete via the standalone form UI or should this only be available to be completed by as an embedded form [optional] [default to false]
StandAloneFormUrl Pointer to string StandAloneFormURL is the URL where this form may be completed by the designated recipients using the standalone form UI [optional]
State Pointer to string State the state of the form instance ASSIGNED FormInstanceStateAssigned IN_PROGRESS FormInstanceStateInProgress SUBMITTED FormInstanceStateSubmitted COMPLETED FormInstanceStateCompleted CANCELLED FormInstanceStateCancelled [optional]

Methods

NewFormInstanceResponse

func NewFormInstanceResponse() *FormInstanceResponse

NewFormInstanceResponse instantiates a new FormInstanceResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewFormInstanceResponseWithDefaults

func NewFormInstanceResponseWithDefaults() *FormInstanceResponse

NewFormInstanceResponseWithDefaults instantiates a new FormInstanceResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetCreated

func (o *FormInstanceResponse) GetCreated() time.Time

GetCreated returns the Created field if non-nil, zero value otherwise.

GetCreatedOk

func (o *FormInstanceResponse) GetCreatedOk() (*time.Time, bool)

GetCreatedOk returns a tuple with the Created field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCreated

func (o *FormInstanceResponse) SetCreated(v time.Time)

SetCreated sets Created field to given value.

HasCreated

func (o *FormInstanceResponse) HasCreated() bool

HasCreated returns a boolean if a field has been set.

GetCreatedBy

func (o *FormInstanceResponse) GetCreatedBy() FormInstanceCreatedBy

GetCreatedBy returns the CreatedBy field if non-nil, zero value otherwise.

GetCreatedByOk

func (o *FormInstanceResponse) GetCreatedByOk() (*FormInstanceCreatedBy, bool)

GetCreatedByOk returns a tuple with the CreatedBy field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCreatedBy

func (o *FormInstanceResponse) SetCreatedBy(v FormInstanceCreatedBy)

SetCreatedBy sets CreatedBy field to given value.

HasCreatedBy

func (o *FormInstanceResponse) HasCreatedBy() bool

HasCreatedBy returns a boolean if a field has been set.

GetExpire

func (o *FormInstanceResponse) GetExpire() string

GetExpire returns the Expire field if non-nil, zero value otherwise.

GetExpireOk

func (o *FormInstanceResponse) GetExpireOk() (*string, bool)

GetExpireOk returns a tuple with the Expire field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetExpire

func (o *FormInstanceResponse) SetExpire(v string)

SetExpire sets Expire field to given value.

HasExpire

func (o *FormInstanceResponse) HasExpire() bool

HasExpire returns a boolean if a field has been set.

GetFormConditions

func (o *FormInstanceResponse) GetFormConditions() []FormCondition

GetFormConditions returns the FormConditions field if non-nil, zero value otherwise.

GetFormConditionsOk

func (o *FormInstanceResponse) GetFormConditionsOk() (*[]FormCondition, bool)

GetFormConditionsOk returns a tuple with the FormConditions field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetFormConditions

func (o *FormInstanceResponse) SetFormConditions(v []FormCondition)

SetFormConditions sets FormConditions field to given value.

HasFormConditions

func (o *FormInstanceResponse) HasFormConditions() bool

HasFormConditions returns a boolean if a field has been set.

GetFormData

func (o *FormInstanceResponse) GetFormData() map[string]interface{}

GetFormData returns the FormData field if non-nil, zero value otherwise.

GetFormDataOk

func (o *FormInstanceResponse) GetFormDataOk() (*map[string]interface{}, bool)

GetFormDataOk returns a tuple with the FormData field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetFormData

func (o *FormInstanceResponse) SetFormData(v map[string]interface{})

SetFormData sets FormData field to given value.

HasFormData

func (o *FormInstanceResponse) HasFormData() bool

HasFormData returns a boolean if a field has been set.

SetFormDataNil

func (o *FormInstanceResponse) SetFormDataNil(b bool)

SetFormDataNil sets the value for FormData to be an explicit nil

UnsetFormData

func (o *FormInstanceResponse) UnsetFormData()

UnsetFormData ensures that no value is present for FormData, not even an explicit nil

GetFormDefinitionId

func (o *FormInstanceResponse) GetFormDefinitionId() string

GetFormDefinitionId returns the FormDefinitionId field if non-nil, zero value otherwise.

GetFormDefinitionIdOk

func (o *FormInstanceResponse) GetFormDefinitionIdOk() (*string, bool)

GetFormDefinitionIdOk returns a tuple with the FormDefinitionId field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetFormDefinitionId

func (o *FormInstanceResponse) SetFormDefinitionId(v string)

SetFormDefinitionId sets FormDefinitionId field to given value.

HasFormDefinitionId

func (o *FormInstanceResponse) HasFormDefinitionId() bool

HasFormDefinitionId returns a boolean if a field has been set.

GetFormElements

func (o *FormInstanceResponse) GetFormElements() []FormElement

GetFormElements returns the FormElements field if non-nil, zero value otherwise.

GetFormElementsOk

func (o *FormInstanceResponse) GetFormElementsOk() (*[]FormElement, bool)

GetFormElementsOk returns a tuple with the FormElements field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetFormElements

func (o *FormInstanceResponse) SetFormElements(v []FormElement)

SetFormElements sets FormElements field to given value.

HasFormElements

func (o *FormInstanceResponse) HasFormElements() bool

HasFormElements returns a boolean if a field has been set.

GetFormErrors

func (o *FormInstanceResponse) GetFormErrors() []FormError

GetFormErrors returns the FormErrors field if non-nil, zero value otherwise.

GetFormErrorsOk

func (o *FormInstanceResponse) GetFormErrorsOk() (*[]FormError, bool)

GetFormErrorsOk returns a tuple with the FormErrors field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetFormErrors

func (o *FormInstanceResponse) SetFormErrors(v []FormError)

SetFormErrors sets FormErrors field to given value.

HasFormErrors

func (o *FormInstanceResponse) HasFormErrors() bool

HasFormErrors returns a boolean if a field has been set.

GetFormInput

func (o *FormInstanceResponse) GetFormInput() map[string]map[string]interface{}

GetFormInput returns the FormInput field if non-nil, zero value otherwise.

GetFormInputOk

func (o *FormInstanceResponse) GetFormInputOk() (*map[string]map[string]interface{}, bool)

GetFormInputOk returns a tuple with the FormInput field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetFormInput

func (o *FormInstanceResponse) SetFormInput(v map[string]map[string]interface{})

SetFormInput sets FormInput field to given value.

HasFormInput

func (o *FormInstanceResponse) HasFormInput() bool

HasFormInput returns a boolean if a field has been set.

SetFormInputNil

func (o *FormInstanceResponse) SetFormInputNil(b bool)

SetFormInputNil sets the value for FormInput to be an explicit nil

UnsetFormInput

func (o *FormInstanceResponse) UnsetFormInput()

UnsetFormInput ensures that no value is present for FormInput, not even an explicit nil

GetId

func (o *FormInstanceResponse) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *FormInstanceResponse) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *FormInstanceResponse) SetId(v string)

SetId sets Id field to given value.

HasId

func (o *FormInstanceResponse) HasId() bool

HasId returns a boolean if a field has been set.

GetModified

func (o *FormInstanceResponse) GetModified() time.Time

GetModified returns the Modified field if non-nil, zero value otherwise.

GetModifiedOk

func (o *FormInstanceResponse) GetModifiedOk() (*time.Time, bool)

GetModifiedOk returns a tuple with the Modified field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetModified

func (o *FormInstanceResponse) SetModified(v time.Time)

SetModified sets Modified field to given value.

HasModified

func (o *FormInstanceResponse) HasModified() bool

HasModified returns a boolean if a field has been set.

GetRecipients

func (o *FormInstanceResponse) GetRecipients() []FormInstanceRecipient

GetRecipients returns the Recipients field if non-nil, zero value otherwise.

GetRecipientsOk

func (o *FormInstanceResponse) GetRecipientsOk() (*[]FormInstanceRecipient, bool)

GetRecipientsOk returns a tuple with the Recipients field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRecipients

func (o *FormInstanceResponse) SetRecipients(v []FormInstanceRecipient)

SetRecipients sets Recipients field to given value.

HasRecipients

func (o *FormInstanceResponse) HasRecipients() bool

HasRecipients returns a boolean if a field has been set.

GetStandAloneForm

func (o *FormInstanceResponse) GetStandAloneForm() bool

GetStandAloneForm returns the StandAloneForm field if non-nil, zero value otherwise.

GetStandAloneFormOk

func (o *FormInstanceResponse) GetStandAloneFormOk() (*bool, bool)

GetStandAloneFormOk returns a tuple with the StandAloneForm field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetStandAloneForm

func (o *FormInstanceResponse) SetStandAloneForm(v bool)

SetStandAloneForm sets StandAloneForm field to given value.

HasStandAloneForm

func (o *FormInstanceResponse) HasStandAloneForm() bool

HasStandAloneForm returns a boolean if a field has been set.

GetStandAloneFormUrl

func (o *FormInstanceResponse) GetStandAloneFormUrl() string

GetStandAloneFormUrl returns the StandAloneFormUrl field if non-nil, zero value otherwise.

GetStandAloneFormUrlOk

func (o *FormInstanceResponse) GetStandAloneFormUrlOk() (*string, bool)

GetStandAloneFormUrlOk returns a tuple with the StandAloneFormUrl field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetStandAloneFormUrl

func (o *FormInstanceResponse) SetStandAloneFormUrl(v string)

SetStandAloneFormUrl sets StandAloneFormUrl field to given value.

HasStandAloneFormUrl

func (o *FormInstanceResponse) HasStandAloneFormUrl() bool

HasStandAloneFormUrl returns a boolean if a field has been set.

GetState

func (o *FormInstanceResponse) GetState() string

GetState returns the State field if non-nil, zero value otherwise.

GetStateOk

func (o *FormInstanceResponse) GetStateOk() (*string, bool)

GetStateOk returns a tuple with the State field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetState

func (o *FormInstanceResponse) SetState(v string)

SetState sets State field to given value.

HasState

func (o *FormInstanceResponse) HasState() bool

HasState returns a boolean if a field has been set.

[Back to Model list] [Back to API list] [Back to README]