PUT FormTypes
Updates the given form type.
Request Information
URI Parameters
None.
Body Parameters
Form type to update
FormType| Name | Description | Type | Additional information |
|---|---|---|---|
| FormTypeId | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| Description | string |
None. |
|
| AssetType | AssetType |
None. |
|
| FrequencyNeeded | integer |
None. |
|
| ValueNeededDate | date |
None. |
|
| Fields | Collection of FormTypeField |
None. |
|
| SourceSystemId | string |
None. |
|
| CompanyId | globally unique identifier |
None. |
|
| CreateDate | date |
None. |
|
| CreateUser | string |
None. |
|
| LastModifiedDate | date |
None. |
|
| LastModifiedUser | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"FormTypeId": "734f952a-079b-4c19-9ebb-fe56807d2dd6",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "cdcb5ee4-4259-477e-bfbd-1dc98ed519c9",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7f7fcf0a-3e2a-4f7a-abef-118b1815b710",
"CreateDate": "2026-08-03T02:24:06.8871906-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-03T02:24:06.8871906-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-03T02:24:06.8871906-07:00",
"Fields": [
{
"FormTypeFieldId": "f5a1b88b-2c40-46d4-88ed-20e10b9f914a",
"Section": {
"FormTypeSectionId": "235f4bcd-2eb8-4bf4-95af-ee87863aad0a",
"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": "d5a066a4-272c-480c-9d62-fbccc490501a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "5c82e93a-393e-462a-897c-1f3fa1b58102",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fb913947-8b5f-4534-8ced-cc030ee740c2",
"CreateDate": "2026-08-03T02:24:06.8871906-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-03T02:24:06.8871906-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": "f5a1b88b-2c40-46d4-88ed-20e10b9f914a",
"Section": {
"FormTypeSectionId": "235f4bcd-2eb8-4bf4-95af-ee87863aad0a",
"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": "d5a066a4-272c-480c-9d62-fbccc490501a",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "5c82e93a-393e-462a-897c-1f3fa1b58102",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "fb913947-8b5f-4534-8ced-cc030ee740c2",
"CreateDate": "2026-08-03T02:24:06.8871906-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-03T02:24:06.8871906-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": "ee07dad3-bfd9-44b9-9779-d4ec6c65f335",
"CreateDate": "2026-08-03T02:24:06.8871906-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-03T02:24:06.8871906-07:00",
"LastModifiedUser": "sample string 6"
}
Response Information
Resource Description
On success, the updated 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": "c479e09a-5ae3-4d6e-8ff5-a61c14ed1156",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "75e8cf29-e3e6-4008-8379-4148369fc24c",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "7df03dfa-4e8a-4756-a6eb-6fc493e14e33",
"CreateDate": "2026-08-03T02:24:06.9028251-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2026-08-03T02:24:06.9028251-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-08-03T02:24:06.9028251-07:00",
"Fields": [
{
"FormTypeFieldId": "7d35a723-9b94-4ea0-9547-7ad6df89c8b3",
"Section": {
"FormTypeSectionId": "23f74e44-0ced-4717-bd74-209f913f9567",
"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": "c8badd2d-a0a9-4ed9-9440-e20a78aeab63",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2e3548db-416d-4f3c-a972-3d7da1a9dc3a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d1980a94-f96d-4e76-9da1-1ca458d79513",
"CreateDate": "2026-08-03T02:24:06.9028251-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-03T02:24:06.9028251-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": "7d35a723-9b94-4ea0-9547-7ad6df89c8b3",
"Section": {
"FormTypeSectionId": "23f74e44-0ced-4717-bd74-209f913f9567",
"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": "c8badd2d-a0a9-4ed9-9440-e20a78aeab63",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "2e3548db-416d-4f3c-a972-3d7da1a9dc3a",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "d1980a94-f96d-4e76-9da1-1ca458d79513",
"CreateDate": "2026-08-03T02:24:06.9028251-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-03T02:24:06.9028251-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": "bd642300-7643-477e-8966-f9ea3356c945",
"CreateDate": "2026-08-03T02:24:06.9028251-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-08-03T02:24:06.9028251-07:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}