GET FormTypes?assetTypeId={assetTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves form types for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetTypeId |
Id of the asset type |
globally unique identifier |
None. |
take |
Number of form types to retrieve. Default is all form types |
integer |
None. |
skip |
Number of form types to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the form types before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of form types.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of FormType |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "FormTypeId": "c53585c9-dba6-4a3f-b276-a0a6b6cea503", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "9aab8130-9667-43bc-8065-5f2ff9decadd", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bb799dc3-113d-4548-bdbe-c0c0e8923382", "CreateDate": "2024-12-08T10:35:23.4528697-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-08T10:35:23.4528697-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-12-08T10:35:23.4528697-08:00", "Fields": [ { "FormTypeFieldId": "ad397e0b-8481-493b-9d1e-80c566d6c453", "Section": { "FormTypeSectionId": "2fe3fd37-1696-4991-b499-d79e17f51e6d", "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": "be0e1f45-06aa-4e3e-a2da-7b67e9e47033", "Name": "sample string 1" }, "Unit": { "UnitId": "00e3fa77-a624-4fb2-9e63-61d2ccf4bcf8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9fc0bc90-34d3-4df2-b80f-3ba9a2076d65", "CreateDate": "2024-12-08T10:35:23.4528697-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-08T10:35:23.4528697-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "b02c2bbd-6e50-48c7-ba88-d87e48f670bf", "FieldId": "26e9cd19-cbc4-4d31-8dec-8e517f345912", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "b02c2bbd-6e50-48c7-ba88-d87e48f670bf", "FieldId": "26e9cd19-cbc4-4d31-8dec-8e517f345912", "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": "ad397e0b-8481-493b-9d1e-80c566d6c453", "Section": { "FormTypeSectionId": "2fe3fd37-1696-4991-b499-d79e17f51e6d", "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": "be0e1f45-06aa-4e3e-a2da-7b67e9e47033", "Name": "sample string 1" }, "Unit": { "UnitId": "00e3fa77-a624-4fb2-9e63-61d2ccf4bcf8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9fc0bc90-34d3-4df2-b80f-3ba9a2076d65", "CreateDate": "2024-12-08T10:35:23.4528697-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-08T10:35:23.4528697-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "b02c2bbd-6e50-48c7-ba88-d87e48f670bf", "FieldId": "26e9cd19-cbc4-4d31-8dec-8e517f345912", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "b02c2bbd-6e50-48c7-ba88-d87e48f670bf", "FieldId": "26e9cd19-cbc4-4d31-8dec-8e517f345912", "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": "d1eb1cba-7f64-4f7f-9826-0a7af9ab7c9e", "CreateDate": "2024-12-08T10:35:23.4528697-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-08T10:35:23.4528697-08:00", "LastModifiedUser": "sample string 6" }, { "FormTypeId": "c53585c9-dba6-4a3f-b276-a0a6b6cea503", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "9aab8130-9667-43bc-8065-5f2ff9decadd", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bb799dc3-113d-4548-bdbe-c0c0e8923382", "CreateDate": "2024-12-08T10:35:23.4528697-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-08T10:35:23.4528697-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-12-08T10:35:23.4528697-08:00", "Fields": [ { "FormTypeFieldId": "ad397e0b-8481-493b-9d1e-80c566d6c453", "Section": { "FormTypeSectionId": "2fe3fd37-1696-4991-b499-d79e17f51e6d", "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": "be0e1f45-06aa-4e3e-a2da-7b67e9e47033", "Name": "sample string 1" }, "Unit": { "UnitId": "00e3fa77-a624-4fb2-9e63-61d2ccf4bcf8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9fc0bc90-34d3-4df2-b80f-3ba9a2076d65", "CreateDate": "2024-12-08T10:35:23.4528697-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-08T10:35:23.4528697-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "b02c2bbd-6e50-48c7-ba88-d87e48f670bf", "FieldId": "26e9cd19-cbc4-4d31-8dec-8e517f345912", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "b02c2bbd-6e50-48c7-ba88-d87e48f670bf", "FieldId": "26e9cd19-cbc4-4d31-8dec-8e517f345912", "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": "ad397e0b-8481-493b-9d1e-80c566d6c453", "Section": { "FormTypeSectionId": "2fe3fd37-1696-4991-b499-d79e17f51e6d", "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": "be0e1f45-06aa-4e3e-a2da-7b67e9e47033", "Name": "sample string 1" }, "Unit": { "UnitId": "00e3fa77-a624-4fb2-9e63-61d2ccf4bcf8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9fc0bc90-34d3-4df2-b80f-3ba9a2076d65", "CreateDate": "2024-12-08T10:35:23.4528697-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-08T10:35:23.4528697-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "b02c2bbd-6e50-48c7-ba88-d87e48f670bf", "FieldId": "26e9cd19-cbc4-4d31-8dec-8e517f345912", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "b02c2bbd-6e50-48c7-ba88-d87e48f670bf", "FieldId": "26e9cd19-cbc4-4d31-8dec-8e517f345912", "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": "d1eb1cba-7f64-4f7f-9826-0a7af9ab7c9e", "CreateDate": "2024-12-08T10:35:23.4528697-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-08T10:35:23.4528697-08:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }