GET Forms/Field
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| IncludeActive | boolean |
None. |
|
| IncludeInactive | boolean |
None. |
|
| IncludeDeleted | boolean |
None. |
|
| Match | FormMatchCriteriaStringType |
None. |
|
| FieldIDs | Collection of integer |
None. |
|
| FieldNames | Collection of string |
None. |
|
| VersionMajor | byte |
None. |
|
| VersionMinor | byte |
None. |
|
| FieldAccessType | FormAccessType |
None. |
|
| Types | Collection of FormFieldType |
None. |
|
| SubType | FormFieldSubType |
None. |
|
| Caption | string |
None. |
|
| Introduction | string |
None. |
|
| Props | Collection of Object |
None. |
|
| DefaultType | FormFieldDefaultType |
None. |
|
| ValidationType | FormFieldValidationType |
None. |
|
| DependencyType | FormFieldDependencyType |
None. |
|
| AnnotationType | FormAnnotationType |
None. |
|
| Tips | string |
None. |
|
| CreatedDateUtcMin | date |
None. |
|
| CreatedDateUtcMax | date |
None. |
|
| LastUpdatedDateUtcMin | date |
None. |
|
| LastUpdatedDateUtcMax | date |
None. |
|
| FormID | integer |
None. |
|
| LatestVersion | boolean |
None. |
|
| LatestByType | boolean |
None. |
|
| IncludeDeployedFormNames | boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of FormFieldDto| Name | Description | Type | Additional information |
|---|---|---|---|
| FieldID | integer |
None. |
|
| FieldName | string |
Required |
|
| Version | string |
None. |
|
| VersionMajor | byte |
None. |
|
| VersionMinor | byte |
None. |
|
| FieldAccessType | FormAccessType |
None. |
|
| Type | FormFieldType |
None. |
|
| SubType | FormFieldSubType |
None. |
|
| Caption | string |
None. |
|
| Introduction | string |
None. |
|
| DefaultType | FormFieldDefaultType |
None. |
|
| ValidationType | FormFieldValidationType |
None. |
|
| DependencyType | FormFieldDependencyType |
None. |
|
| AnnotationType | FormAnnotationType |
None. |
|
| Tips | string |
None. |
|
| Choices | Collection of FormFieldChoiceDto |
None. |
|
| FormFieldLinkID | integer |
None. |
|
| FormSectionID | integer |
None. |
|
| FormSectionName | string |
None. |
|
| SortOrder | integer |
None. |
|
| FormSectionSortOrder | integer |
None. |
|
| FormSortOrder | integer |
None. |
|
| NumberType | FormNumberType |
None. |
|
| NumberText | string |
None. |
|
| CalculatedNumber | string |
None. |
|
| RecordState | FormRecordState |
None. |
|
| OriginalStoredFieldValue | string |
None. |
|
| VisibleScript | string |
None. |
|
| DefaultScript | string |
None. |
|
| ValidationScript | string |
None. |
|
| CarePlanMode | FormFieldCarePlanMode |
None. |
|
| CarePlanScript | string |
None. |
|
| CalculationProperties | FormFieldCalculationProperties |
None. |
|
| IsParentToScore | boolean |
None. |
|
| IsParentToField | boolean |
None. |
|
| ParametersExist | boolean |
None. |
|
| RequiresRecalcOnChange | boolean |
None. |
|
| IsPartialData | boolean |
None. |
|
| Created | FormAuditDataDto |
None. |
|
| LastUpdated | FormAuditDataDto |
None. |
|
| SelectedCarePlan | integer |
None. |
|
| CarePlanLevel | FormFieldCarePlanItemType |
None. |
|
| SelectedFocus | string |
None. |
|
| SelectedGoal | string |
None. |
|
| CarePlanItemName | string |
None. |
|
| DeployedParentForms | Collection of string |
None. |
|
| HasAnswer | boolean |
None. |
|
| HasChanged | boolean |
None. |
|
| IsVisible | boolean |
None. |
|
| IsReadOnly | boolean |
None. |
|
| AnswerAsString | string |
None. |
|
| IsValidForParameters | boolean |
None. |
|
| Layout | FormFieldLayoutDto |
None. |
Response Formats
application/json, text/json, application/xml, text/xml, application/x-compressed-json
Sample:
Sample not available.