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": "4f8cc4f4-aa01-4d04-87f0-3c3f912ee8da", "Asset": { "AssetId": "918ea144-2a9e-4420-8432-af988763d549", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "941ad82e-6369-4a92-8ff1-fdf68cb9d788", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a87eb4d3-46c0-4aa0-ab2b-6a7bf66edbda", "CreateDate": "2025-06-26T20:30:43.7194197-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-26T20:30:43.7194197-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "75168322-0011-4aba-bc8d-3d74bac7c21d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-26T20:30:43.7194197-07:00", "MeasurementValueNeededDate": "2025-06-26T20:30:43.7194197-07:00", "SourceSystemId": "sample string 3", "CompanyId": "64610621-3d8a-441b-b950-afee9b1deb83", "CreateDate": "2025-06-26T20:30:43.7194197-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T20:30:43.7194197-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-26T20:30:43.7194197-07:00", "MeasurementValueNeededDate": "2025-06-26T20:30:43.7194197-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "7a35fefc-cc63-43d4-9f66-9894197e46ba", "CreateDate": "2025-06-26T20:30:43.7194197-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-26T20:30:43.7194197-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "dd1a1545-6044-4974-93dc-22a29a1e2f98", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "941ad82e-6369-4a92-8ff1-fdf68cb9d788", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a87eb4d3-46c0-4aa0-ab2b-6a7bf66edbda", "CreateDate": "2025-06-26T20:30:43.7194197-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-26T20:30:43.7194197-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-26T20:30:43.7194197-07:00", "Fields": [ { "FormTypeFieldId": "bd8eb255-f1e4-4039-bef5-8604d8c68001", "Section": { "FormTypeSectionId": "9614fdd5-4b52-45f6-985d-af287ba45462", "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": "e330cac2-9896-42ff-a4d0-1367e6cda042", "Name": "sample string 1" }, "Unit": { "UnitId": "d43eca0d-f791-4f86-8af9-cc512f795a57", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f819a699-1418-4a41-bb46-7ca851993a64", "CreateDate": "2025-06-26T20:30:43.7194197-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T20:30:43.7194197-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": "bd8eb255-f1e4-4039-bef5-8604d8c68001", "Section": { "FormTypeSectionId": "9614fdd5-4b52-45f6-985d-af287ba45462", "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": "e330cac2-9896-42ff-a4d0-1367e6cda042", "Name": "sample string 1" }, "Unit": { "UnitId": "d43eca0d-f791-4f86-8af9-cc512f795a57", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f819a699-1418-4a41-bb46-7ca851993a64", "CreateDate": "2025-06-26T20:30:43.7194197-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T20:30:43.7194197-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": "9746cd85-17dd-498d-94ae-4eea302b09ea", "CreateDate": "2025-06-26T20:30:43.7194197-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T20:30:43.7194197-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-06-26T20:30:43.7194197-07:00", "Location": "sample string 1", "TaskId": "3f5916cd-6f87-4f34-a253-5547311253d5", "Values": [ { "FormFieldValueId": "e783b0fe-ebf5-4b7b-80a0-992238c40969", "FormTypeField": { "FormTypeFieldId": "bd8eb255-f1e4-4039-bef5-8604d8c68001", "Section": { "FormTypeSectionId": "9614fdd5-4b52-45f6-985d-af287ba45462", "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": "e330cac2-9896-42ff-a4d0-1367e6cda042", "Name": "sample string 1" }, "Unit": { "UnitId": "d43eca0d-f791-4f86-8af9-cc512f795a57", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f819a699-1418-4a41-bb46-7ca851993a64", "CreateDate": "2025-06-26T20:30:43.7194197-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T20:30:43.7194197-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": "e783b0fe-ebf5-4b7b-80a0-992238c40969", "FormTypeField": { "FormTypeFieldId": "bd8eb255-f1e4-4039-bef5-8604d8c68001", "Section": { "FormTypeSectionId": "9614fdd5-4b52-45f6-985d-af287ba45462", "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": "e330cac2-9896-42ff-a4d0-1367e6cda042", "Name": "sample string 1" }, "Unit": { "UnitId": "d43eca0d-f791-4f86-8af9-cc512f795a57", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f819a699-1418-4a41-bb46-7ca851993a64", "CreateDate": "2025-06-26T20:30:43.7194197-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T20:30:43.7194197-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": "e4d001a1-cae3-4f1e-b173-3bb18db52277", "CreateDate": "2025-06-26T20:30:43.7194197-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-26T20:30:43.7194197-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": "1949b054-895a-424e-9f43-66fee602e81b", "Asset": { "AssetId": "452bb708-3774-4ed4-878a-e04f4fb2287a", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "2365dc37-3e60-44a3-91fe-19b93db2fb1d", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0efa665d-87e9-443c-a4b7-ebc84bd4c07a", "CreateDate": "2025-06-26T20:30:43.7350699-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-26T20:30:43.7350699-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "be33f351-7f95-4ae0-9c54-200bc0b582bf", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-26T20:30:43.7350699-07:00", "MeasurementValueNeededDate": "2025-06-26T20:30:43.7350699-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9f5f3558-5bb7-48c6-91c2-f4f22feb0286", "CreateDate": "2025-06-26T20:30:43.7350699-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T20:30:43.7350699-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-26T20:30:43.7350699-07:00", "MeasurementValueNeededDate": "2025-06-26T20:30:43.7350699-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "2719e8cc-84a9-4828-b405-fb0ee36cf576", "CreateDate": "2025-06-26T20:30:43.7350699-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-26T20:30:43.7350699-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "b79fa8b9-c92c-4fed-86cd-bb1e78131242", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "2365dc37-3e60-44a3-91fe-19b93db2fb1d", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0efa665d-87e9-443c-a4b7-ebc84bd4c07a", "CreateDate": "2025-06-26T20:30:43.7350699-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-26T20:30:43.7350699-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-26T20:30:43.7350699-07:00", "Fields": [ { "FormTypeFieldId": "b85b129e-9d43-4ef1-abf9-6a078af89a72", "Section": { "FormTypeSectionId": "36c9a8f0-323e-449b-8c8d-a819fbfa6e21", "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": "14f28f01-423c-47fa-8b0a-61d2518de2ab", "Name": "sample string 1" }, "Unit": { "UnitId": "ceaf9cc1-06b9-41b9-a24c-a94fb42c5958", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "39f63322-4368-4d0a-b55c-7a8881df04a4", "CreateDate": "2025-06-26T20:30:43.7350699-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T20:30:43.7350699-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": "b85b129e-9d43-4ef1-abf9-6a078af89a72", "Section": { "FormTypeSectionId": "36c9a8f0-323e-449b-8c8d-a819fbfa6e21", "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": "14f28f01-423c-47fa-8b0a-61d2518de2ab", "Name": "sample string 1" }, "Unit": { "UnitId": "ceaf9cc1-06b9-41b9-a24c-a94fb42c5958", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "39f63322-4368-4d0a-b55c-7a8881df04a4", "CreateDate": "2025-06-26T20:30:43.7350699-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T20:30:43.7350699-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": "53248663-778c-4518-92ae-78e721779e76", "CreateDate": "2025-06-26T20:30:43.7350699-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T20:30:43.7350699-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-06-26T20:30:43.7350699-07:00", "Location": "sample string 1", "TaskId": "b6334ec1-debc-4535-bb19-69f2ab4be88b", "Values": [ { "FormFieldValueId": "1130c2ce-d73d-4f26-b260-aabb0f0a92c2", "FormTypeField": { "FormTypeFieldId": "b85b129e-9d43-4ef1-abf9-6a078af89a72", "Section": { "FormTypeSectionId": "36c9a8f0-323e-449b-8c8d-a819fbfa6e21", "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": "14f28f01-423c-47fa-8b0a-61d2518de2ab", "Name": "sample string 1" }, "Unit": { "UnitId": "ceaf9cc1-06b9-41b9-a24c-a94fb42c5958", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "39f63322-4368-4d0a-b55c-7a8881df04a4", "CreateDate": "2025-06-26T20:30:43.7350699-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T20:30:43.7350699-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": "1130c2ce-d73d-4f26-b260-aabb0f0a92c2", "FormTypeField": { "FormTypeFieldId": "b85b129e-9d43-4ef1-abf9-6a078af89a72", "Section": { "FormTypeSectionId": "36c9a8f0-323e-449b-8c8d-a819fbfa6e21", "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": "14f28f01-423c-47fa-8b0a-61d2518de2ab", "Name": "sample string 1" }, "Unit": { "UnitId": "ceaf9cc1-06b9-41b9-a24c-a94fb42c5958", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "39f63322-4368-4d0a-b55c-7a8881df04a4", "CreateDate": "2025-06-26T20:30:43.7350699-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T20:30:43.7350699-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": "745f1e0f-046c-4ea4-b757-da3d06d7566d", "CreateDate": "2025-06-26T20:30:43.7350699-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-26T20:30:43.7350699-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }