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": "5c164746-f706-4eb3-83dc-43ac9340f744", "Asset": { "AssetId": "b9aa3dc0-c445-4cf4-99dd-18dd2a2774e3", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7763b8e5-cf34-499e-9594-1316cbb586e3", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "09101add-35c9-46ed-a3fb-1b6381471d4a", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-25T06:11:21.9290643-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "6a8ae928-5bf4-49b2-a629-f293c9ff6197", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:11:21.9290643-07:00", "MeasurementValueNeededDate": "2025-06-25T06:11:21.9290643-07:00", "SourceSystemId": "sample string 3", "CompanyId": "3be320df-11e1-4917-b624-eaf5bad57b1b", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:11:21.9290643-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-25T06:11:21.9290643-07:00", "MeasurementValueNeededDate": "2025-06-25T06:11:21.9290643-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "02db4953-5880-49b0-9907-71c04b710dbf", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-25T06:11:21.9290643-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "b5b463c0-350e-49d0-8560-c08e841d5ace", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7763b8e5-cf34-499e-9594-1316cbb586e3", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "09101add-35c9-46ed-a3fb-1b6381471d4a", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-25T06:11:21.9290643-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-25T06:11:21.9290643-07:00", "Fields": [ { "FormTypeFieldId": "0469add2-a040-4c29-a47b-af430782a313", "Section": { "FormTypeSectionId": "9c4800fb-a1e7-4773-a255-c9c3888c4348", "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": "5a8bb142-4455-4d17-85f6-c758ca643c45", "Name": "sample string 1" }, "Unit": { "UnitId": "40265491-5c49-46d3-8dc2-b1947f934ffb", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f20a529b-8f25-494c-8a3a-95614285ca0c", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:11:21.9290643-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": "0469add2-a040-4c29-a47b-af430782a313", "Section": { "FormTypeSectionId": "9c4800fb-a1e7-4773-a255-c9c3888c4348", "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": "5a8bb142-4455-4d17-85f6-c758ca643c45", "Name": "sample string 1" }, "Unit": { "UnitId": "40265491-5c49-46d3-8dc2-b1947f934ffb", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f20a529b-8f25-494c-8a3a-95614285ca0c", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:11:21.9290643-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": "8008e299-e252-474a-8dbf-ff27771582e6", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:11:21.9290643-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-06-25T06:11:21.9290643-07:00", "Location": "sample string 1", "TaskId": "695c093c-3ba6-4d19-9a1a-19baf8036f49", "Values": [ { "FormFieldValueId": "aa7c7cc7-f13c-48df-83f6-98af76adc4e8", "FormTypeField": { "FormTypeFieldId": "0469add2-a040-4c29-a47b-af430782a313", "Section": { "FormTypeSectionId": "9c4800fb-a1e7-4773-a255-c9c3888c4348", "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": "5a8bb142-4455-4d17-85f6-c758ca643c45", "Name": "sample string 1" }, "Unit": { "UnitId": "40265491-5c49-46d3-8dc2-b1947f934ffb", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f20a529b-8f25-494c-8a3a-95614285ca0c", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:11:21.9290643-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": "aa7c7cc7-f13c-48df-83f6-98af76adc4e8", "FormTypeField": { "FormTypeFieldId": "0469add2-a040-4c29-a47b-af430782a313", "Section": { "FormTypeSectionId": "9c4800fb-a1e7-4773-a255-c9c3888c4348", "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": "5a8bb142-4455-4d17-85f6-c758ca643c45", "Name": "sample string 1" }, "Unit": { "UnitId": "40265491-5c49-46d3-8dc2-b1947f934ffb", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f20a529b-8f25-494c-8a3a-95614285ca0c", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:11:21.9290643-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": "e8444c4a-b4b6-4945-a80e-7186753bd7c3", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-25T06:11:21.9290643-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": "35ee968c-4455-4882-89a0-0fae8b0210eb", "Asset": { "AssetId": "1d0811a8-2d5d-4a28-9667-0430c0453a14", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "928c9fa0-eb50-454b-b370-3d777b895088", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "d4579b19-0979-42ca-a394-1699e415b5da", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-25T06:11:21.9290643-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "a953db08-7c44-46ec-b2eb-d0a9025dfca9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:11:21.9290643-07:00", "MeasurementValueNeededDate": "2025-06-25T06:11:21.9290643-07:00", "SourceSystemId": "sample string 3", "CompanyId": "956538a7-a50e-43c0-a33c-3ec8ddb5f49e", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:11:21.9290643-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-25T06:11:21.9290643-07:00", "MeasurementValueNeededDate": "2025-06-25T06:11:21.9290643-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e2336d67-a881-43ba-ba62-ec7ab852dd70", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-25T06:11:21.9290643-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "2ae1d420-0812-41d0-a350-a1b740a852f9", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "928c9fa0-eb50-454b-b370-3d777b895088", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "d4579b19-0979-42ca-a394-1699e415b5da", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-25T06:11:21.9290643-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-25T06:11:21.9290643-07:00", "Fields": [ { "FormTypeFieldId": "f0bc333a-fd7b-443e-a4a9-cc084d293354", "Section": { "FormTypeSectionId": "9825eaac-b771-421f-8cb5-7afcfc7d78f8", "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": "cf879883-09fd-4dc5-b02d-122f70eac545", "Name": "sample string 1" }, "Unit": { "UnitId": "fae42f6b-d43f-4d6a-980e-2de6ea216e3c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "90ae1d15-f1ac-4050-bb8b-ae56a0691223", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:11:21.9290643-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": "f0bc333a-fd7b-443e-a4a9-cc084d293354", "Section": { "FormTypeSectionId": "9825eaac-b771-421f-8cb5-7afcfc7d78f8", "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": "cf879883-09fd-4dc5-b02d-122f70eac545", "Name": "sample string 1" }, "Unit": { "UnitId": "fae42f6b-d43f-4d6a-980e-2de6ea216e3c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "90ae1d15-f1ac-4050-bb8b-ae56a0691223", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:11:21.9290643-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": "c581fb92-a0cd-47f2-bb71-1ee1a7a9723f", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:11:21.9290643-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-06-25T06:11:21.9290643-07:00", "Location": "sample string 1", "TaskId": "aabb13ea-eadf-4e6f-a1ca-880979c5e04e", "Values": [ { "FormFieldValueId": "0ba13932-0e21-4e52-aaf5-dd656961c594", "FormTypeField": { "FormTypeFieldId": "f0bc333a-fd7b-443e-a4a9-cc084d293354", "Section": { "FormTypeSectionId": "9825eaac-b771-421f-8cb5-7afcfc7d78f8", "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": "cf879883-09fd-4dc5-b02d-122f70eac545", "Name": "sample string 1" }, "Unit": { "UnitId": "fae42f6b-d43f-4d6a-980e-2de6ea216e3c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "90ae1d15-f1ac-4050-bb8b-ae56a0691223", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:11:21.9290643-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": "0ba13932-0e21-4e52-aaf5-dd656961c594", "FormTypeField": { "FormTypeFieldId": "f0bc333a-fd7b-443e-a4a9-cc084d293354", "Section": { "FormTypeSectionId": "9825eaac-b771-421f-8cb5-7afcfc7d78f8", "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": "cf879883-09fd-4dc5-b02d-122f70eac545", "Name": "sample string 1" }, "Unit": { "UnitId": "fae42f6b-d43f-4d6a-980e-2de6ea216e3c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "90ae1d15-f1ac-4050-bb8b-ae56a0691223", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:11:21.9290643-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": "bb3bd0b7-1b9f-4278-9733-c5d6b915d98b", "CreateDate": "2025-06-25T06:11:21.9290643-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-25T06:11:21.9290643-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }