GET FormTypes?formTypeId={formTypeId}
Retrieves a form type by its Id.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
formTypeId |
Id of the form type |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
On success, the form type.
Name | Description | Type | Additional information |
---|---|---|---|
Data | FormType |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "FormTypeId": "b077c838-79e5-4ff2-b637-eb364adebac2", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "b985c246-98ef-4ec2-af70-c33a29be6aa4", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7b84cb0d-013d-430d-ae1f-1e92d091a793", "CreateDate": "2024-12-08T07:36:32.9667512-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-08T07:36:32.9667512-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-12-08T07:36:32.9667512-08:00", "Fields": [ { "FormTypeFieldId": "0fca5835-580b-44cc-9b66-ff123219f759", "Section": { "FormTypeSectionId": "54c2ff23-247e-4b61-aad9-e2322995f870", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "d2316b03-a198-4bb5-b169-354b98641d4b", "Name": "sample string 1" }, "Unit": { "UnitId": "61b7a9fe-dc6f-4d71-b423-ac0ff4ef12ac", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "909f706d-34d0-45f7-8cac-05eb1b5b7101", "CreateDate": "2024-12-08T07:36:32.9667512-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-08T07:36:32.9667512-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "9e3168cd-7cd4-4c5c-9543-cce09e4e6366", "FieldId": "035e2a93-fa4a-46b9-b526-68535e053d8c", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "9e3168cd-7cd4-4c5c-9543-cce09e4e6366", "FieldId": "035e2a93-fa4a-46b9-b526-68535e053d8c", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, { "FormTypeFieldId": "0fca5835-580b-44cc-9b66-ff123219f759", "Section": { "FormTypeSectionId": "54c2ff23-247e-4b61-aad9-e2322995f870", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "d2316b03-a198-4bb5-b169-354b98641d4b", "Name": "sample string 1" }, "Unit": { "UnitId": "61b7a9fe-dc6f-4d71-b423-ac0ff4ef12ac", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "909f706d-34d0-45f7-8cac-05eb1b5b7101", "CreateDate": "2024-12-08T07:36:32.9667512-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-08T07:36:32.9667512-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "9e3168cd-7cd4-4c5c-9543-cce09e4e6366", "FieldId": "035e2a93-fa4a-46b9-b526-68535e053d8c", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "9e3168cd-7cd4-4c5c-9543-cce09e4e6366", "FieldId": "035e2a93-fa4a-46b9-b526-68535e053d8c", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" } ], "SourceSystemId": "sample string 3", "CompanyId": "ec3e3df1-aa1c-48bd-b3e5-efa4615b9464", "CreateDate": "2024-12-08T07:36:32.9667512-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-08T07:36:32.9667512-08:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }