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": "d27ac6a7-f8f8-479d-a417-643a4b74cc69",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "61eab99c-e5da-43b5-be2c-3ac7bcc97226",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "fe4262bd-227a-4206-976e-0508252d74f6",
"CreateDate": "2022-11-26T15:04:26.4083712-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2022-11-26T15:04:26.4083712-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2022-11-26T15:04:26.4083712-08:00",
"Fields": [
{
"FormTypeFieldId": "dc191d68-c3e4-40e6-8f0d-5b94b9a9ffc7",
"Section": {
"FormTypeSectionId": "26f5f86c-c9ad-496a-b09b-e71a41eac2a8",
"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": "ce6ca552-92da-4d95-ad1c-ed30a70f85c7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6a7e3774-9f4d-4694-be93-ba1993592ca9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d1d58e93-39dd-45ae-8c92-840f58bce99c",
"CreateDate": "2022-11-26T15:04:26.4083712-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2022-11-26T15:04:26.4083712-08: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": "dc191d68-c3e4-40e6-8f0d-5b94b9a9ffc7",
"Section": {
"FormTypeSectionId": "26f5f86c-c9ad-496a-b09b-e71a41eac2a8",
"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": "ce6ca552-92da-4d95-ad1c-ed30a70f85c7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6a7e3774-9f4d-4694-be93-ba1993592ca9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d1d58e93-39dd-45ae-8c92-840f58bce99c",
"CreateDate": "2022-11-26T15:04:26.4083712-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2022-11-26T15:04:26.4083712-08: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": "a2ab9f79-5ee8-46c3-ace5-8ec45661a23c",
"CreateDate": "2022-11-26T15:04:26.4083712-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2022-11-26T15:04:26.4083712-08:00",
"LastModifiedUser": "sample string 6"
},
{
"FormTypeId": "d27ac6a7-f8f8-479d-a417-643a4b74cc69",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "61eab99c-e5da-43b5-be2c-3ac7bcc97226",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "fe4262bd-227a-4206-976e-0508252d74f6",
"CreateDate": "2022-11-26T15:04:26.4083712-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2022-11-26T15:04:26.4083712-08:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2022-11-26T15:04:26.4083712-08:00",
"Fields": [
{
"FormTypeFieldId": "dc191d68-c3e4-40e6-8f0d-5b94b9a9ffc7",
"Section": {
"FormTypeSectionId": "26f5f86c-c9ad-496a-b09b-e71a41eac2a8",
"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": "ce6ca552-92da-4d95-ad1c-ed30a70f85c7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6a7e3774-9f4d-4694-be93-ba1993592ca9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d1d58e93-39dd-45ae-8c92-840f58bce99c",
"CreateDate": "2022-11-26T15:04:26.4083712-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2022-11-26T15:04:26.4083712-08: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": "dc191d68-c3e4-40e6-8f0d-5b94b9a9ffc7",
"Section": {
"FormTypeSectionId": "26f5f86c-c9ad-496a-b09b-e71a41eac2a8",
"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": "ce6ca552-92da-4d95-ad1c-ed30a70f85c7",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "6a7e3774-9f4d-4694-be93-ba1993592ca9",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d1d58e93-39dd-45ae-8c92-840f58bce99c",
"CreateDate": "2022-11-26T15:04:26.4083712-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2022-11-26T15:04:26.4083712-08: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": "a2ab9f79-5ee8-46c3-ace5-8ec45661a23c",
"CreateDate": "2022-11-26T15:04:26.4083712-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2022-11-26T15:04:26.4083712-08:00",
"LastModifiedUser": "sample string 6"
}
],
"Total": 1,
"Message": "sample string 1"
}