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 DataFilter |
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": "272b5d42-d6b9-44d4-82f3-d16743369640",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c558e169-8de5-45e3-962c-3a667322f64a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "890a65f3-d103-429f-8f77-9263627f27e8",
"CreateDate": "2021-04-17T07:06:45.6315589-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T07:06:45.6315589-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2021-04-17T07:06:45.6315589-07:00",
"Fields": [
{
"FormTypeFieldId": "a3eefd6a-b830-42de-a4d7-54f8987ac460",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "1285ec52-2824-442b-bbbc-ec745243a4ba",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b769fb66-9aed-4c3a-a93b-4b629f7955e9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8e6d6202-a228-4d31-bd27-eb581558c0f7",
"CreateDate": "2021-04-17T07:06:45.6315589-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T07:06:45.6315589-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
},
{
"FormTypeFieldId": "a3eefd6a-b830-42de-a4d7-54f8987ac460",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "1285ec52-2824-442b-bbbc-ec745243a4ba",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b769fb66-9aed-4c3a-a93b-4b629f7955e9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8e6d6202-a228-4d31-bd27-eb581558c0f7",
"CreateDate": "2021-04-17T07:06:45.6315589-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T07:06:45.6315589-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "1adb4b6b-da94-4e53-b23d-d9fd54d46295",
"CreateDate": "2021-04-17T07:06:45.6315589-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T07:06:45.6315589-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
{
"FormTypeId": "272b5d42-d6b9-44d4-82f3-d16743369640",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "c558e169-8de5-45e3-962c-3a667322f64a",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "890a65f3-d103-429f-8f77-9263627f27e8",
"CreateDate": "2021-04-17T07:06:45.6315589-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T07:06:45.6315589-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2021-04-17T07:06:45.6315589-07:00",
"Fields": [
{
"FormTypeFieldId": "a3eefd6a-b830-42de-a4d7-54f8987ac460",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "1285ec52-2824-442b-bbbc-ec745243a4ba",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b769fb66-9aed-4c3a-a93b-4b629f7955e9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8e6d6202-a228-4d31-bd27-eb581558c0f7",
"CreateDate": "2021-04-17T07:06:45.6315589-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T07:06:45.6315589-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
},
{
"FormTypeFieldId": "a3eefd6a-b830-42de-a4d7-54f8987ac460",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "1285ec52-2824-442b-bbbc-ec745243a4ba",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "b769fb66-9aed-4c3a-a93b-4b629f7955e9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "8e6d6202-a228-4d31-bd27-eb581558c0f7",
"CreateDate": "2021-04-17T07:06:45.6315589-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T07:06:45.6315589-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "1adb4b6b-da94-4e53-b23d-d9fd54d46295",
"CreateDate": "2021-04-17T07:06:45.6315589-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T07:06:45.6315589-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
}
],
"Total": 1,
"Message": "sample string 1"
}