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": "ac4b1cc5-ddf0-43a9-b45f-99e955063366", "Asset": { "AssetId": "012d1fc9-276c-4162-810c-a8275059cd52", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "1930e699-8e3a-4797-afe1-2bb9c4df2126", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0204482b-39eb-495d-9946-acb83ed91b98", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "138e9f88-9935-480a-b610-3da13dcec6ed", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-02-05T07:52:06.7128467-08:00", "MeasurementValueNeededDate": "2025-02-05T07:52:06.7128467-08:00", "SourceSystemId": "sample string 3", "CompanyId": "96c9955f-8c6b-4e5e-b261-49b2e33fa673", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-02-05T07:52:06.7128467-08:00", "MeasurementValueNeededDate": "2025-02-05T07:52:06.7128467-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "0937bbba-90bf-4a62-912d-0c0ac79d748c", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "ea03cfb8-b793-472c-ba3e-0fdb8d33a2b8", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "1930e699-8e3a-4797-afe1-2bb9c4df2126", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0204482b-39eb-495d-9946-acb83ed91b98", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-02-05T07:52:06.7128467-08:00", "Fields": [ { "FormTypeFieldId": "966e499a-b5c7-4a53-8b44-c5ecaa639797", "Section": { "FormTypeSectionId": "f1ff0cff-055f-4fbb-ac16-cc4f15b5a35b", "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": "be5e1b0e-614b-4589-a5de-d21adf9841a8", "Name": "sample string 1" }, "Unit": { "UnitId": "0984b1da-8a21-42f7-a787-4321902d5741", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "80346df3-535f-44ca-8cb3-c57543ddeae1", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08: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": "966e499a-b5c7-4a53-8b44-c5ecaa639797", "Section": { "FormTypeSectionId": "f1ff0cff-055f-4fbb-ac16-cc4f15b5a35b", "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": "be5e1b0e-614b-4589-a5de-d21adf9841a8", "Name": "sample string 1" }, "Unit": { "UnitId": "0984b1da-8a21-42f7-a787-4321902d5741", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "80346df3-535f-44ca-8cb3-c57543ddeae1", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08: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": "8c52ef74-7a4c-40f7-9f93-16f92a152934", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-02-05T07:52:06.7128467-08:00", "Location": "sample string 1", "TaskId": "16fedadc-03ba-4d01-94f1-8825f30a2190", "Values": [ { "FormFieldValueId": "b6823f80-b191-4b1b-8e36-8b5eb8a7e6d6", "FormTypeField": { "FormTypeFieldId": "966e499a-b5c7-4a53-8b44-c5ecaa639797", "Section": { "FormTypeSectionId": "f1ff0cff-055f-4fbb-ac16-cc4f15b5a35b", "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": "be5e1b0e-614b-4589-a5de-d21adf9841a8", "Name": "sample string 1" }, "Unit": { "UnitId": "0984b1da-8a21-42f7-a787-4321902d5741", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "80346df3-535f-44ca-8cb3-c57543ddeae1", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08: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": "b6823f80-b191-4b1b-8e36-8b5eb8a7e6d6", "FormTypeField": { "FormTypeFieldId": "966e499a-b5c7-4a53-8b44-c5ecaa639797", "Section": { "FormTypeSectionId": "f1ff0cff-055f-4fbb-ac16-cc4f15b5a35b", "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": "be5e1b0e-614b-4589-a5de-d21adf9841a8", "Name": "sample string 1" }, "Unit": { "UnitId": "0984b1da-8a21-42f7-a787-4321902d5741", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "80346df3-535f-44ca-8cb3-c57543ddeae1", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08: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": "858a13b0-7bd2-4b38-9bf0-4616d3165a84", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08: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": "f1a4cbc4-490f-4b3e-a537-7c859ad857ea", "Asset": { "AssetId": "f4301b25-9aff-40e5-ac18-206b5b0e8429", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "8622df60-c360-408d-96f7-bcf630adedc9", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5d64e0cb-464a-41ec-820b-f174c4ad85d5", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "0b0e9fba-4c67-45b7-af2d-423261d3e580", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-02-05T07:52:06.7128467-08:00", "MeasurementValueNeededDate": "2025-02-05T07:52:06.7128467-08:00", "SourceSystemId": "sample string 3", "CompanyId": "384c2c50-af83-4c7d-9578-d1108344cecb", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-02-05T07:52:06.7128467-08:00", "MeasurementValueNeededDate": "2025-02-05T07:52:06.7128467-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "f632d538-564d-4682-a5e4-6c238edd5f5c", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "148cc8f7-911a-4925-aaa0-b2b347db1719", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "8622df60-c360-408d-96f7-bcf630adedc9", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5d64e0cb-464a-41ec-820b-f174c4ad85d5", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-02-05T07:52:06.7128467-08:00", "Fields": [ { "FormTypeFieldId": "80f61f5a-c7cf-465a-b8d4-7ca7f0c9ba36", "Section": { "FormTypeSectionId": "cde8faef-6d79-47e0-bd8b-e2e2fb6b8403", "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": "098103f0-f881-470f-a02c-1cfe06d7de69", "Name": "sample string 1" }, "Unit": { "UnitId": "e49c5a5b-f080-4090-b9ff-34cbcf8f96ba", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fe8e3151-a9b7-42ec-ad40-ad3034c24225", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08: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": "80f61f5a-c7cf-465a-b8d4-7ca7f0c9ba36", "Section": { "FormTypeSectionId": "cde8faef-6d79-47e0-bd8b-e2e2fb6b8403", "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": "098103f0-f881-470f-a02c-1cfe06d7de69", "Name": "sample string 1" }, "Unit": { "UnitId": "e49c5a5b-f080-4090-b9ff-34cbcf8f96ba", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fe8e3151-a9b7-42ec-ad40-ad3034c24225", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08: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": "640961c2-4153-46f8-9a7a-353aa600f6c1", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-02-05T07:52:06.7128467-08:00", "Location": "sample string 1", "TaskId": "8b902912-f9d8-49ea-bf75-6404e92bc0d0", "Values": [ { "FormFieldValueId": "37dd7777-312f-45f2-8618-3fb9bed38aa5", "FormTypeField": { "FormTypeFieldId": "80f61f5a-c7cf-465a-b8d4-7ca7f0c9ba36", "Section": { "FormTypeSectionId": "cde8faef-6d79-47e0-bd8b-e2e2fb6b8403", "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": "098103f0-f881-470f-a02c-1cfe06d7de69", "Name": "sample string 1" }, "Unit": { "UnitId": "e49c5a5b-f080-4090-b9ff-34cbcf8f96ba", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fe8e3151-a9b7-42ec-ad40-ad3034c24225", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08: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": "37dd7777-312f-45f2-8618-3fb9bed38aa5", "FormTypeField": { "FormTypeFieldId": "80f61f5a-c7cf-465a-b8d4-7ca7f0c9ba36", "Section": { "FormTypeSectionId": "cde8faef-6d79-47e0-bd8b-e2e2fb6b8403", "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": "098103f0-f881-470f-a02c-1cfe06d7de69", "Name": "sample string 1" }, "Unit": { "UnitId": "e49c5a5b-f080-4090-b9ff-34cbcf8f96ba", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fe8e3151-a9b7-42ec-ad40-ad3034c24225", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08: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": "2514b643-c07f-4228-aa7c-57fb23b6f8ae", "CreateDate": "2025-02-05T07:52:06.7128467-08:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-02-05T07:52:06.7128467-08:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }