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": "e43bc168-e484-4d84-bd8c-f15ae62aafbe",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "6888eef5-049d-4fd4-a4a1-68611c74c024",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b55a7570-aa92-4203-b9a4-122d095eb75c",
"CreateDate": "2024-10-10T04:10:13.895935-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-10-10T04:10:13.895935-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2024-10-10T04:10:13.895935-07:00",
"Fields": [
{
"FormTypeFieldId": "aaffb6a9-6bf8-47d4-aee0-33007018f6e0",
"Section": {
"FormTypeSectionId": "e3546170-bb04-4bcd-b1c8-ddc72b5900ca",
"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": "ca0769b8-f21d-4080-9e97-ada2b71611b0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d3cc6193-eb6e-4349-828b-25ca1a2b52d9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "df5f072b-46ee-44ca-b820-ca9b00d697fe",
"CreateDate": "2024-10-10T04:10:13.895935-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-10-10T04:10:13.895935-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "aaffb6a9-6bf8-47d4-aee0-33007018f6e0",
"Section": {
"FormTypeSectionId": "e3546170-bb04-4bcd-b1c8-ddc72b5900ca",
"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": "ca0769b8-f21d-4080-9e97-ada2b71611b0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d3cc6193-eb6e-4349-828b-25ca1a2b52d9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "df5f072b-46ee-44ca-b820-ca9b00d697fe",
"CreateDate": "2024-10-10T04:10:13.895935-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-10-10T04:10:13.895935-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "01dd9269-657c-4aa9-9ca5-635dd25a644f",
"CreateDate": "2024-10-10T04:10:13.895935-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-10-10T04:10:13.895935-07:00",
"LastModifiedUser": "sample string 6"
},
{
"FormTypeId": "e43bc168-e484-4d84-bd8c-f15ae62aafbe",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "6888eef5-049d-4fd4-a4a1-68611c74c024",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b55a7570-aa92-4203-b9a4-122d095eb75c",
"CreateDate": "2024-10-10T04:10:13.895935-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2024-10-10T04:10:13.895935-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2024-10-10T04:10:13.895935-07:00",
"Fields": [
{
"FormTypeFieldId": "aaffb6a9-6bf8-47d4-aee0-33007018f6e0",
"Section": {
"FormTypeSectionId": "e3546170-bb04-4bcd-b1c8-ddc72b5900ca",
"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": "ca0769b8-f21d-4080-9e97-ada2b71611b0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d3cc6193-eb6e-4349-828b-25ca1a2b52d9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "df5f072b-46ee-44ca-b820-ca9b00d697fe",
"CreateDate": "2024-10-10T04:10:13.895935-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-10-10T04:10:13.895935-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "aaffb6a9-6bf8-47d4-aee0-33007018f6e0",
"Section": {
"FormTypeSectionId": "e3546170-bb04-4bcd-b1c8-ddc72b5900ca",
"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": "ca0769b8-f21d-4080-9e97-ada2b71611b0",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "d3cc6193-eb6e-4349-828b-25ca1a2b52d9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "df5f072b-46ee-44ca-b820-ca9b00d697fe",
"CreateDate": "2024-10-10T04:10:13.895935-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-10-10T04:10:13.895935-07:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"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": "01dd9269-657c-4aa9-9ca5-635dd25a644f",
"CreateDate": "2024-10-10T04:10:13.895935-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2024-10-10T04:10:13.895935-07:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}