PUT FormTypes
Updates the given form type.
Request Information
URI Parameters
None.
Body Parameters
Form type to update
FormTypeName | Description | Type | Additional information |
---|---|---|---|
FormTypeId | globally unique identifier |
None. |
|
Name | string |
None. |
|
Description | string |
None. |
|
AssetType | AssetType |
None. |
|
FrequencyNeeded | integer |
None. |
|
ValueNeededDate | date |
None. |
|
Active | boolean |
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": "1097c99b-f68b-49cc-838e-44201b6d6e18", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "a6641caf-1b26-4b80-b071-c5e5166176f5", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "fe79844a-7aac-41e3-b885-ad9fd7d5898c", "CreateDate": "2025-07-30T11:56:02.6107131-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T11:56:02.6107131-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-30T11:56:02.6107131-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "60927140-e495-46da-815a-4acba60e5c89", "Section": { "FormTypeSectionId": "77a841a4-7166-44cb-9a03-08fad82c5178", "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": "cb627e94-e963-4193-b26f-2f363065c6d8", "Name": "sample string 1" }, "Unit": { "UnitId": "12e96985-c355-4eba-b23a-937373bf9eff", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "96df79dc-c29e-47b2-ad19-384f009d9cac", "CreateDate": "2025-07-30T11:56:02.6107131-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T11:56:02.6107131-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "b7c738c0-982b-4071-8074-26f422e0e3e1", "FieldId": "cb5e9f6a-3435-483f-bc1e-97d375f18743", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "b7c738c0-982b-4071-8074-26f422e0e3e1", "FieldId": "cb5e9f6a-3435-483f-bc1e-97d375f18743", "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": "60927140-e495-46da-815a-4acba60e5c89", "Section": { "FormTypeSectionId": "77a841a4-7166-44cb-9a03-08fad82c5178", "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": "cb627e94-e963-4193-b26f-2f363065c6d8", "Name": "sample string 1" }, "Unit": { "UnitId": "12e96985-c355-4eba-b23a-937373bf9eff", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "96df79dc-c29e-47b2-ad19-384f009d9cac", "CreateDate": "2025-07-30T11:56:02.6107131-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T11:56:02.6107131-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "b7c738c0-982b-4071-8074-26f422e0e3e1", "FieldId": "cb5e9f6a-3435-483f-bc1e-97d375f18743", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "b7c738c0-982b-4071-8074-26f422e0e3e1", "FieldId": "cb5e9f6a-3435-483f-bc1e-97d375f18743", "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 4", "CompanyId": "fa8a6208-8490-4144-a8f1-0d094db2fbe2", "CreateDate": "2025-07-30T11:56:02.6107131-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T11:56:02.6107131-07:00", "LastModifiedUser": "sample string 7" }
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": "c1e1874a-ab9c-4454-9b8a-387a2df52572", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "e8f9be3d-2646-4ed4-8789-d22eb765832c", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "49783bb3-304c-4308-92c9-20cd9656af60", "CreateDate": "2025-07-30T11:56:02.6107131-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T11:56:02.6107131-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-30T11:56:02.6107131-07:00", "Active": true, "Fields": [ { "FormTypeFieldId": "4a59c809-876f-4ca1-b37a-752b57d77698", "Section": { "FormTypeSectionId": "a8d6853a-3281-4f23-85f5-8f4756634683", "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": "6eef72bc-1afc-4ae3-bb05-0ad0a6922318", "Name": "sample string 1" }, "Unit": { "UnitId": "e70a2fc6-98bf-42f6-83d6-a295558e0c24", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a2032aa8-b4d0-49b8-be39-ef390d563ef8", "CreateDate": "2025-07-30T11:56:02.6107131-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T11:56:02.6107131-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "6ac864bf-e870-4b98-b130-291aeb0c7d7d", "FieldId": "37804805-09f1-42a7-8eb7-bf62d4c959aa", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "6ac864bf-e870-4b98-b130-291aeb0c7d7d", "FieldId": "37804805-09f1-42a7-8eb7-bf62d4c959aa", "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": "4a59c809-876f-4ca1-b37a-752b57d77698", "Section": { "FormTypeSectionId": "a8d6853a-3281-4f23-85f5-8f4756634683", "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": "6eef72bc-1afc-4ae3-bb05-0ad0a6922318", "Name": "sample string 1" }, "Unit": { "UnitId": "e70a2fc6-98bf-42f6-83d6-a295558e0c24", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a2032aa8-b4d0-49b8-be39-ef390d563ef8", "CreateDate": "2025-07-30T11:56:02.6107131-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-30T11:56:02.6107131-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "6ac864bf-e870-4b98-b130-291aeb0c7d7d", "FieldId": "37804805-09f1-42a7-8eb7-bf62d4c959aa", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "6ac864bf-e870-4b98-b130-291aeb0c7d7d", "FieldId": "37804805-09f1-42a7-8eb7-bf62d4c959aa", "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 4", "CompanyId": "6ac67cd5-ae1b-406b-9a97-db16cb3907d4", "CreateDate": "2025-07-30T11:56:02.6107131-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-30T11:56:02.6107131-07:00", "LastModifiedUser": "sample string 7" }, "Total": 1, "Message": "sample string 1" }