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": "649b31f3-f93a-40b9-8359-f90af088da22", "Asset": { "AssetId": "cee2a8c8-71e0-44a4-8eca-b766662c597d", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "156699d9-309c-441a-8cbf-bd41f4a600b5", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "db95cbb9-f60f-4715-9575-e50c37402784", "CreateDate": "2025-07-31T17:56:30.5623915-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T17:56:30.5623915-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "6f69efff-4583-4ecf-81e9-739dfa34e4d4", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T17:56:30.5623915-07:00", "MeasurementValueNeededDate": "2025-07-31T17:56:30.5623915-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b688011d-a846-4d10-81eb-c3668c29520b", "CreateDate": "2025-07-31T17:56:30.5623915-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:56:30.5623915-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-07-31T17:56:30.5623915-07:00", "MeasurementValueNeededDate": "2025-07-31T17:56:30.5623915-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e4d32e27-d3d0-4046-9fcc-7a753969c300", "CreateDate": "2025-07-31T17:56:30.5623915-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-31T17:56:30.5623915-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "6d4b6f8f-b4fb-422d-b15a-4bb4f2c9d692", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "156699d9-309c-441a-8cbf-bd41f4a600b5", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "db95cbb9-f60f-4715-9575-e50c37402784", "CreateDate": "2025-07-31T17:56:30.5623915-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T17:56:30.5623915-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-31T17:56:30.5623915-07:00", "Fields": [ { "FormTypeFieldId": "9f2cdfba-9ae7-4628-945f-d669703d5135", "Section": { "FormTypeSectionId": "fe6a6d48-27f6-4eb6-be6f-8abe423fa911", "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": "d7df543e-c8e0-4e7d-9297-6a1e352da631", "Name": "sample string 1" }, "Unit": { "UnitId": "b2e55111-5d94-42a9-a110-191aeb65e018", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1079c117-a292-49b4-bd99-55d27c4ea3ed", "CreateDate": "2025-07-31T17:56:30.5623915-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:56:30.5623915-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": "9f2cdfba-9ae7-4628-945f-d669703d5135", "Section": { "FormTypeSectionId": "fe6a6d48-27f6-4eb6-be6f-8abe423fa911", "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": "d7df543e-c8e0-4e7d-9297-6a1e352da631", "Name": "sample string 1" }, "Unit": { "UnitId": "b2e55111-5d94-42a9-a110-191aeb65e018", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1079c117-a292-49b4-bd99-55d27c4ea3ed", "CreateDate": "2025-07-31T17:56:30.5623915-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:56:30.5623915-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": "88b3e3a6-ee23-4119-a230-400eaee7e4d6", "CreateDate": "2025-07-31T17:56:30.5623915-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:56:30.5623915-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-07-31T17:56:30.5623915-07:00", "Location": "sample string 1", "TaskId": "41583ef8-433c-48cf-bdaf-5836b6255358", "Values": [ { "FormFieldValueId": "33022686-f462-4a4b-908c-b11839d31a7c", "FormTypeField": { "FormTypeFieldId": "9f2cdfba-9ae7-4628-945f-d669703d5135", "Section": { "FormTypeSectionId": "fe6a6d48-27f6-4eb6-be6f-8abe423fa911", "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": "d7df543e-c8e0-4e7d-9297-6a1e352da631", "Name": "sample string 1" }, "Unit": { "UnitId": "b2e55111-5d94-42a9-a110-191aeb65e018", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1079c117-a292-49b4-bd99-55d27c4ea3ed", "CreateDate": "2025-07-31T17:56:30.5623915-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:56:30.5623915-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": "33022686-f462-4a4b-908c-b11839d31a7c", "FormTypeField": { "FormTypeFieldId": "9f2cdfba-9ae7-4628-945f-d669703d5135", "Section": { "FormTypeSectionId": "fe6a6d48-27f6-4eb6-be6f-8abe423fa911", "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": "d7df543e-c8e0-4e7d-9297-6a1e352da631", "Name": "sample string 1" }, "Unit": { "UnitId": "b2e55111-5d94-42a9-a110-191aeb65e018", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1079c117-a292-49b4-bd99-55d27c4ea3ed", "CreateDate": "2025-07-31T17:56:30.5623915-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:56:30.5623915-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": "8e8f5257-1e78-4d60-af20-7816147bbe72", "CreateDate": "2025-07-31T17:56:30.5623915-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-31T17:56:30.5623915-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": "0842ada6-0887-42bc-a2a4-400f38a9bfc6", "Asset": { "AssetId": "3c3bec89-5a9b-4e69-87b5-4ed3d600a1fa", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "136dbb5d-0454-4193-93c0-67cd3c92fea5", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "34dde505-88b6-40d2-868d-b479065de75b", "CreateDate": "2025-07-31T17:56:30.5935746-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T17:56:30.5935746-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "3d98a1da-1caa-4781-b644-4197e8ba878b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T17:56:30.5935746-07:00", "MeasurementValueNeededDate": "2025-07-31T17:56:30.5935746-07:00", "SourceSystemId": "sample string 3", "CompanyId": "d4106f00-6059-48a1-8b2b-5be7d6b30204", "CreateDate": "2025-07-31T17:56:30.5935746-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:56:30.5935746-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-07-31T17:56:30.5935746-07:00", "MeasurementValueNeededDate": "2025-07-31T17:56:30.5935746-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "a6814daf-9ba1-41cd-886a-338376f28400", "CreateDate": "2025-07-31T17:56:30.5935746-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-31T17:56:30.5935746-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "7ef050dc-b1f3-4f80-94aa-d87e4d1485c3", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "136dbb5d-0454-4193-93c0-67cd3c92fea5", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "34dde505-88b6-40d2-868d-b479065de75b", "CreateDate": "2025-07-31T17:56:30.5935746-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T17:56:30.5935746-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-31T17:56:30.5935746-07:00", "Fields": [ { "FormTypeFieldId": "ce14ab85-65d5-4976-9531-979045bebc37", "Section": { "FormTypeSectionId": "c7c52627-ca6d-46d4-b95d-d15e6f8e6322", "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": "3f49a30a-7b32-4659-804a-1310304e0beb", "Name": "sample string 1" }, "Unit": { "UnitId": "0e4bb1b3-3528-4d2a-9a3e-855a0b200bfb", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "cf538fe1-7c67-4470-95af-5c485949ebd3", "CreateDate": "2025-07-31T17:56:30.5935746-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:56:30.5935746-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": "ce14ab85-65d5-4976-9531-979045bebc37", "Section": { "FormTypeSectionId": "c7c52627-ca6d-46d4-b95d-d15e6f8e6322", "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": "3f49a30a-7b32-4659-804a-1310304e0beb", "Name": "sample string 1" }, "Unit": { "UnitId": "0e4bb1b3-3528-4d2a-9a3e-855a0b200bfb", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "cf538fe1-7c67-4470-95af-5c485949ebd3", "CreateDate": "2025-07-31T17:56:30.5935746-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:56:30.5935746-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": "e5bc59fa-7103-43e4-b1d9-85ec5c37efa1", "CreateDate": "2025-07-31T17:56:30.5935746-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:56:30.5935746-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-07-31T17:56:30.5935746-07:00", "Location": "sample string 1", "TaskId": "e334bdc5-d0cb-46e7-82a1-74fccec37a1c", "Values": [ { "FormFieldValueId": "b0da1e71-b2ba-4f83-a6f7-12c7823d6618", "FormTypeField": { "FormTypeFieldId": "ce14ab85-65d5-4976-9531-979045bebc37", "Section": { "FormTypeSectionId": "c7c52627-ca6d-46d4-b95d-d15e6f8e6322", "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": "3f49a30a-7b32-4659-804a-1310304e0beb", "Name": "sample string 1" }, "Unit": { "UnitId": "0e4bb1b3-3528-4d2a-9a3e-855a0b200bfb", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "cf538fe1-7c67-4470-95af-5c485949ebd3", "CreateDate": "2025-07-31T17:56:30.5935746-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:56:30.5935746-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": "b0da1e71-b2ba-4f83-a6f7-12c7823d6618", "FormTypeField": { "FormTypeFieldId": "ce14ab85-65d5-4976-9531-979045bebc37", "Section": { "FormTypeSectionId": "c7c52627-ca6d-46d4-b95d-d15e6f8e6322", "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": "3f49a30a-7b32-4659-804a-1310304e0beb", "Name": "sample string 1" }, "Unit": { "UnitId": "0e4bb1b3-3528-4d2a-9a3e-855a0b200bfb", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "cf538fe1-7c67-4470-95af-5c485949ebd3", "CreateDate": "2025-07-31T17:56:30.5935746-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T17:56:30.5935746-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": "5fee919c-7635-4b3f-bdc8-674da9aac20f", "CreateDate": "2025-07-31T17:56:30.5935746-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-31T17:56:30.5935746-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }