POST Forms/Field/GetFormFields
Request Information
URI Parameters
None.
Body Parameters
FindFormFieldCriteriaName | 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. |
Request Formats
application/json, text/json
Sample:
{ "includeActive": true, "includeInactive": true, "includeDeleted": true, "match": 1, "fieldIDs": [ 1, 2 ], "fieldNames": [ "sample string 1", "sample string 2" ], "versionMajor": 64, "versionMinor": 64, "fieldAccessType": 1, "types": [ 100, 100 ], "subType": 100, "caption": "sample string 4", "introduction": "sample string 5", "defaultType": 1, "validationType": 1, "dependencyType": 1, "annotationType": 1, "tips": "sample string 6", "createdDateUtcMin": "2024-12-04T07:51:26.6102341+00:00", "createdDateUtcMax": "2024-12-04T07:51:26.6102341+00:00", "lastUpdatedDateUtcMin": "2024-12-04T07:51:26.6102341+00:00", "lastUpdatedDateUtcMax": "2024-12-04T07:51:26.6102341+00:00", "formID": 1, "latestVersion": true, "latestByType": true, "includeDeployedFormNames": true }
application/xml, text/xml
Sample:
<FindFormFieldCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Forms.Models.Criteria"> <AnnotationType>None</AnnotationType> <Caption>sample string 4</Caption> <CreatedDateUtcMax>2024-12-04T07:51:26.6102341+00:00</CreatedDateUtcMax> <CreatedDateUtcMin>2024-12-04T07:51:26.6102341+00:00</CreatedDateUtcMin> <DefaultType>None</DefaultType> <DependencyType>None</DependencyType> <FieldAccessType>System</FieldAccessType> <FieldIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </FieldIDs> <FieldNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </FieldNames> <FormID>1</FormID> <IncludeActive>true</IncludeActive> <IncludeDeleted>true</IncludeDeleted> <IncludeDeployedFormNames>true</IncludeDeployedFormNames> <IncludeInactive>true</IncludeInactive> <Introduction>sample string 5</Introduction> <LastUpdatedDateUtcMax>2024-12-04T07:51:26.6102341+00:00</LastUpdatedDateUtcMax> <LastUpdatedDateUtcMin>2024-12-04T07:51:26.6102341+00:00</LastUpdatedDateUtcMin> <LatestByType>true</LatestByType> <LatestVersion>true</LatestVersion> <Match>Full</Match> <Props xmlns:d2p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" /> <SubType>TextBox</SubType> <Tips>sample string 6</Tips> <Types xmlns:d2p1="http://schemas.datacontract.org/2004/07/AlayaCare.Residential.Models.Forms"> <d2p1:FormFieldType>String</d2p1:FormFieldType> <d2p1:FormFieldType>String</d2p1:FormFieldType> </Types> <ValidationType>None</ValidationType> <VersionMajor>64</VersionMajor> <VersionMinor>64</VersionMinor> </FindFormFieldCriteria>
application/x-www-form-urlencoded
Sample:
Sample not available.
application/x-compressed-json
Sample:
� ���N�0�_��J���[Q����1� F�cٗ� �d<��%M�h; [����_>�����^���\�� �[�F������i�P?3)2���̢JLދ,����C,�:8�$��?M�H�Ȳ��l�o�K�,�b�H��s�!��6@��t�9�hQ��>���V� ���ޅ�1�>)����Z��a�Q�|��������*�!%���#(�iE� 5��T9ϋ�ȧ�X�K92/�K��B�q.9?���?��J� �_�'��]7�^T}/y��~w���x0v�5[0�Tb�����׀�I�
Response Information
Resource Description
Collection of FormFieldDtoName | 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.