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": "a7e20414-650a-4821-bde1-8b99c00a8682", "Asset": { "AssetId": "82e58980-4046-4876-994f-08f0704d2a82", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d0d15244-4a89-4bc2-9d3f-253672aeaa92", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bf8d20e7-52b8-4f70-920a-fa1e569d1c56", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-30T12:53:53.2698264-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "ef53e9c4-9767-4348-a609-ca2dafae43c3", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:53:53.2698264-07:00", "MeasurementValueNeededDate": "2025-08-30T12:53:53.2698264-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d4837dc3-6c9c-4bfe-9dad-e934fc9e8901", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2698264-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-08-30T12:53:53.2698264-07:00", "MeasurementValueNeededDate": "2025-08-30T12:53:53.2698264-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "01f5858d-f2a0-4fa0-835f-f60e8d99ab6c", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-30T12:53:53.2698264-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "01e55ee7-c850-4089-8c3a-1701524f412b", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "d0d15244-4a89-4bc2-9d3f-253672aeaa92", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bf8d20e7-52b8-4f70-920a-fa1e569d1c56", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-30T12:53:53.2698264-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-30T12:53:53.2698264-07:00", "Fields": [ { "FormTypeFieldId": "d704358c-bacc-47e1-bd30-bcffcfab4564", "Section": { "FormTypeSectionId": "243e7376-739e-4cb2-9bed-329ccc58d6f6", "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": "8f0548e5-6f49-4cd3-b1de-2910dd502d1a", "Name": "sample string 1" }, "Unit": { "UnitId": "ee972c98-2fd4-4f5e-87a8-3c7b0acceed4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ec434f04-2d5a-4d68-83e2-6f398c917088", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2698264-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": "d704358c-bacc-47e1-bd30-bcffcfab4564", "Section": { "FormTypeSectionId": "243e7376-739e-4cb2-9bed-329ccc58d6f6", "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": "8f0548e5-6f49-4cd3-b1de-2910dd502d1a", "Name": "sample string 1" }, "Unit": { "UnitId": "ee972c98-2fd4-4f5e-87a8-3c7b0acceed4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ec434f04-2d5a-4d68-83e2-6f398c917088", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2698264-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": "0016a148-fbee-4430-a2c4-0a573396c675", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2698264-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-08-30T12:53:53.2698264-07:00", "Location": "sample string 1", "TaskId": "568be231-a46b-45da-a7e6-26f2ff955a35", "Values": [ { "FormFieldValueId": "b127a47d-4deb-42b5-9ff6-1428eb3a44a9", "FormTypeField": { "FormTypeFieldId": "d704358c-bacc-47e1-bd30-bcffcfab4564", "Section": { "FormTypeSectionId": "243e7376-739e-4cb2-9bed-329ccc58d6f6", "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": "8f0548e5-6f49-4cd3-b1de-2910dd502d1a", "Name": "sample string 1" }, "Unit": { "UnitId": "ee972c98-2fd4-4f5e-87a8-3c7b0acceed4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ec434f04-2d5a-4d68-83e2-6f398c917088", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2698264-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": "b127a47d-4deb-42b5-9ff6-1428eb3a44a9", "FormTypeField": { "FormTypeFieldId": "d704358c-bacc-47e1-bd30-bcffcfab4564", "Section": { "FormTypeSectionId": "243e7376-739e-4cb2-9bed-329ccc58d6f6", "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": "8f0548e5-6f49-4cd3-b1de-2910dd502d1a", "Name": "sample string 1" }, "Unit": { "UnitId": "ee972c98-2fd4-4f5e-87a8-3c7b0acceed4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ec434f04-2d5a-4d68-83e2-6f398c917088", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2698264-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": "bb050810-3e9e-4df4-ac27-e4396a4dd312", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-08-30T12:53:53.2698264-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": "c1979b78-b3fe-49a0-bd46-b00d5cbf9767", "Asset": { "AssetId": "a8b6e1ff-ab2f-4b3f-81e7-9126e1583cb0", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "1d12db6e-c0e1-4f60-8e0f-04278f19aed2", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "d872e13e-9fec-4672-a300-4ea5e4725751", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-30T12:53:53.2854926-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "3ff95cae-709a-4ad9-8d91-2237662e4244", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:53:53.2854926-07:00", "MeasurementValueNeededDate": "2025-08-30T12:53:53.2854926-07:00", "SourceSystemId": "sample string 3", "CompanyId": "20301867-761a-423e-9d96-1ba750f5ed43", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2854926-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-08-30T12:53:53.2854926-07:00", "MeasurementValueNeededDate": "2025-08-30T12:53:53.2854926-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "ef1692c0-2f91-4ccd-8fe5-807283817582", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-30T12:53:53.2854926-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "72cfb3d0-5041-4a8d-82aa-9b409d6f4fd6", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "1d12db6e-c0e1-4f60-8e0f-04278f19aed2", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "d872e13e-9fec-4672-a300-4ea5e4725751", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-30T12:53:53.2854926-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-30T12:53:53.2854926-07:00", "Fields": [ { "FormTypeFieldId": "a0389c1e-f30e-42d6-b197-38c36df28c5f", "Section": { "FormTypeSectionId": "677d6ffc-519b-43bd-a5c6-f407531d781d", "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": "16e157c3-13d4-4a18-99ec-50c1f3e954ca", "Name": "sample string 1" }, "Unit": { "UnitId": "1dc485e5-77eb-4612-aaff-11f60570c680", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "08972445-3073-46f5-a48b-65fde3882039", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2854926-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": "a0389c1e-f30e-42d6-b197-38c36df28c5f", "Section": { "FormTypeSectionId": "677d6ffc-519b-43bd-a5c6-f407531d781d", "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": "16e157c3-13d4-4a18-99ec-50c1f3e954ca", "Name": "sample string 1" }, "Unit": { "UnitId": "1dc485e5-77eb-4612-aaff-11f60570c680", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "08972445-3073-46f5-a48b-65fde3882039", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2854926-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": "9296ab73-d70e-4e44-ab96-319241c8de52", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2854926-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-08-30T12:53:53.2854926-07:00", "Location": "sample string 1", "TaskId": "c11ccf28-f3a6-4aed-88ea-99046f8c5469", "Values": [ { "FormFieldValueId": "1ce4459b-b875-43b2-a290-4798d3ae3110", "FormTypeField": { "FormTypeFieldId": "a0389c1e-f30e-42d6-b197-38c36df28c5f", "Section": { "FormTypeSectionId": "677d6ffc-519b-43bd-a5c6-f407531d781d", "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": "16e157c3-13d4-4a18-99ec-50c1f3e954ca", "Name": "sample string 1" }, "Unit": { "UnitId": "1dc485e5-77eb-4612-aaff-11f60570c680", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "08972445-3073-46f5-a48b-65fde3882039", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2854926-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": "1ce4459b-b875-43b2-a290-4798d3ae3110", "FormTypeField": { "FormTypeFieldId": "a0389c1e-f30e-42d6-b197-38c36df28c5f", "Section": { "FormTypeSectionId": "677d6ffc-519b-43bd-a5c6-f407531d781d", "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": "16e157c3-13d4-4a18-99ec-50c1f3e954ca", "Name": "sample string 1" }, "Unit": { "UnitId": "1dc485e5-77eb-4612-aaff-11f60570c680", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "08972445-3073-46f5-a48b-65fde3882039", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2854926-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": "947dca4a-7faa-48ac-b851-2db240e846fd", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-08-30T12:53:53.2854926-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }