PUT Forms
Updates the given form.
Request Information
URI Parameters
None.
Body Parameters
The form to update
FormName | Description | Type | Additional information |
---|---|---|---|
FormId | globally unique identifier |
None. |
|
Asset | Asset |
None. |
|
FormType | FormType |
None. |
|
EffectiveDate | date |
None. |
|
Location | string |
None. |
|
TaskId | globally unique identifier |
None. |
|
Values | Collection of FormFieldValue |
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:
{ "FormId": "89fd3e7b-6142-4d3a-a618-98c7329a2ac7", "Asset": { "AssetId": "9fe6ad5a-b77c-4fd1-9036-8a8ceb8cccd0", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "e1aec92a-ca1b-440a-916e-db329907a243", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "1cebaf49-26f4-4dfe-a0be-678a2cde1354", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T00:10:03.4683777-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "120f0a7c-f2d3-4231-b904-0071c31d82b6", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T00:10:03.4683777-07:00", "MeasurementValueNeededDate": "2025-05-09T00:10:03.4683777-07:00", "SourceSystemId": "sample string 3", "CompanyId": "35c11dfa-2115-4896-ac24-1ac81c5014ca", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:10:03.4683777-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-09T00:10:03.4683777-07:00", "MeasurementValueNeededDate": "2025-05-09T00:10:03.4683777-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "49a57cc2-4010-4553-b864-ea87d6c5e1bf", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T00:10:03.4683777-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "3de4097e-b45c-408d-a792-8fb59b0fe46c", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "e1aec92a-ca1b-440a-916e-db329907a243", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "1cebaf49-26f4-4dfe-a0be-678a2cde1354", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T00:10:03.4683777-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-09T00:10:03.4683777-07:00", "Fields": [ { "FormTypeFieldId": "ae097b7d-3f4e-4145-be1d-e936b98bc259", "Section": { "FormTypeSectionId": "f5893a4a-4766-44f6-8574-d57c10cb5d43", "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": "ef6db42e-6cad-4988-8869-e5feb109ec24", "Name": "sample string 1" }, "Unit": { "UnitId": "7be2114e-3a4b-47bb-936c-c3896392c898", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a82a4a2c-b3a3-46f1-a3a8-65b3d66fc2da", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:10:03.4683777-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": "ae097b7d-3f4e-4145-be1d-e936b98bc259", "Section": { "FormTypeSectionId": "f5893a4a-4766-44f6-8574-d57c10cb5d43", "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": "ef6db42e-6cad-4988-8869-e5feb109ec24", "Name": "sample string 1" }, "Unit": { "UnitId": "7be2114e-3a4b-47bb-936c-c3896392c898", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a82a4a2c-b3a3-46f1-a3a8-65b3d66fc2da", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:10:03.4683777-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": "903db7b6-381b-438b-9f7d-803298adb074", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:10:03.4683777-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-05-09T00:10:03.4683777-07:00", "Location": "sample string 1", "TaskId": "a4efb96e-a313-4c81-9c0d-330da0d6bb1d", "Values": [ { "FormFieldValueId": "2e76d1c4-9a3e-4ddc-ab1b-cc33de166e2e", "FormTypeField": { "FormTypeFieldId": "ae097b7d-3f4e-4145-be1d-e936b98bc259", "Section": { "FormTypeSectionId": "f5893a4a-4766-44f6-8574-d57c10cb5d43", "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": "ef6db42e-6cad-4988-8869-e5feb109ec24", "Name": "sample string 1" }, "Unit": { "UnitId": "7be2114e-3a4b-47bb-936c-c3896392c898", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a82a4a2c-b3a3-46f1-a3a8-65b3d66fc2da", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:10:03.4683777-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" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" }, { "FormFieldValueId": "2e76d1c4-9a3e-4ddc-ab1b-cc33de166e2e", "FormTypeField": { "FormTypeFieldId": "ae097b7d-3f4e-4145-be1d-e936b98bc259", "Section": { "FormTypeSectionId": "f5893a4a-4766-44f6-8574-d57c10cb5d43", "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": "ef6db42e-6cad-4988-8869-e5feb109ec24", "Name": "sample string 1" }, "Unit": { "UnitId": "7be2114e-3a4b-47bb-936c-c3896392c898", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a82a4a2c-b3a3-46f1-a3a8-65b3d66fc2da", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:10:03.4683777-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" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" } ], "SourceSystemId": "sample string 2", "CompanyId": "54f091eb-84ca-41fa-a38d-c1e1bdf5b83c", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-09T00:10:03.4683777-07:00", "LastModifiedUser": "sample string 5" }
Response Information
Resource Description
On success, the updated form.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Form |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "FormId": "f352e656-a95a-4552-8a97-0f482f07627e", "Asset": { "AssetId": "06de12b3-ef64-4130-8ad7-83d5324ef761", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "5da52f72-9fa2-4057-b16c-4ac11498ea79", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "606aa9d3-468e-416d-baf2-07467b2c0659", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T00:10:03.4683777-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "9fae498e-5a68-4dd6-aa92-822279c46032", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T00:10:03.4683777-07:00", "MeasurementValueNeededDate": "2025-05-09T00:10:03.4683777-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0e64086c-0990-42f0-865a-eb1d21bacda8", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:10:03.4683777-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-09T00:10:03.4683777-07:00", "MeasurementValueNeededDate": "2025-05-09T00:10:03.4683777-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "201467b6-e5df-4257-b56f-ccf0a5ffd21f", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T00:10:03.4683777-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "987cc8d1-a4cb-40c9-bca2-dce89597f587", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "5da52f72-9fa2-4057-b16c-4ac11498ea79", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "606aa9d3-468e-416d-baf2-07467b2c0659", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T00:10:03.4683777-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-09T00:10:03.4683777-07:00", "Fields": [ { "FormTypeFieldId": "b5eed4c1-b490-4c7b-baff-96f6587eb2af", "Section": { "FormTypeSectionId": "9cb64036-d80c-4b8a-9e28-076e21142c67", "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": "6dbe05bb-f0d6-41db-b320-4fbf0d302b13", "Name": "sample string 1" }, "Unit": { "UnitId": "e791bcb0-1a19-443a-a571-84b79f4156a8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f3c66d02-6c01-4731-b526-1dcc8002eaf1", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:10:03.4683777-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": "b5eed4c1-b490-4c7b-baff-96f6587eb2af", "Section": { "FormTypeSectionId": "9cb64036-d80c-4b8a-9e28-076e21142c67", "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": "6dbe05bb-f0d6-41db-b320-4fbf0d302b13", "Name": "sample string 1" }, "Unit": { "UnitId": "e791bcb0-1a19-443a-a571-84b79f4156a8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f3c66d02-6c01-4731-b526-1dcc8002eaf1", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:10:03.4683777-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": "16cd1f68-6a77-4094-908f-dbad981d506f", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:10:03.4683777-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-05-09T00:10:03.4683777-07:00", "Location": "sample string 1", "TaskId": "c457f303-be52-4a2c-b609-b984c24c67d2", "Values": [ { "FormFieldValueId": "dc27f171-efe0-4346-9734-cadfcb1e217a", "FormTypeField": { "FormTypeFieldId": "b5eed4c1-b490-4c7b-baff-96f6587eb2af", "Section": { "FormTypeSectionId": "9cb64036-d80c-4b8a-9e28-076e21142c67", "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": "6dbe05bb-f0d6-41db-b320-4fbf0d302b13", "Name": "sample string 1" }, "Unit": { "UnitId": "e791bcb0-1a19-443a-a571-84b79f4156a8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f3c66d02-6c01-4731-b526-1dcc8002eaf1", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:10:03.4683777-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" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" }, { "FormFieldValueId": "dc27f171-efe0-4346-9734-cadfcb1e217a", "FormTypeField": { "FormTypeFieldId": "b5eed4c1-b490-4c7b-baff-96f6587eb2af", "Section": { "FormTypeSectionId": "9cb64036-d80c-4b8a-9e28-076e21142c67", "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": "6dbe05bb-f0d6-41db-b320-4fbf0d302b13", "Name": "sample string 1" }, "Unit": { "UnitId": "e791bcb0-1a19-443a-a571-84b79f4156a8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f3c66d02-6c01-4731-b526-1dcc8002eaf1", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T00:10:03.4683777-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" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" } ], "SourceSystemId": "sample string 2", "CompanyId": "4a0d6ac2-dc65-4df5-8225-eb6d1f7af042", "CreateDate": "2025-05-09T00:10:03.4683777-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-09T00:10:03.4683777-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }