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": "f9a14934-12fa-41fc-a16a-3ad1614f81fb", "Asset": { "AssetId": "8f0b5ade-f766-489a-af25-a885b3b3ab9d", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "53c79283-0c17-47b5-aace-87212f676190", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "8dc05368-b791-404a-bc36-fb444ebc040d", "CreateDate": "2025-05-08T13:36:18.3055153-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-08T13:36:18.3055153-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "30d54b36-a8a1-4487-b971-1c4bc7a2fbfb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-08T13:36:18.3055153-07:00", "MeasurementValueNeededDate": "2025-05-08T13:36:18.3055153-07:00", "SourceSystemId": "sample string 3", "CompanyId": "dea51ff0-51ef-492a-99ce-1b7aa7cd84c7", "CreateDate": "2025-05-08T13:36:18.3055153-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T13:36:18.3055153-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-08T13:36:18.3055153-07:00", "MeasurementValueNeededDate": "2025-05-08T13:36:18.3055153-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "28df0b88-a098-4d87-98aa-5443364b14e0", "CreateDate": "2025-05-08T13:36:18.3055153-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-08T13:36:18.3055153-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "977865ff-c51b-4a08-b2c7-c6d4a5aaa0a8", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "53c79283-0c17-47b5-aace-87212f676190", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "8dc05368-b791-404a-bc36-fb444ebc040d", "CreateDate": "2025-05-08T13:36:18.3055153-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-08T13:36:18.3055153-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-08T13:36:18.3055153-07:00", "Fields": [ { "FormTypeFieldId": "5b6ab0cb-afc2-487c-adcb-495b37c247f1", "Section": { "FormTypeSectionId": "c899b135-ac07-473f-8886-2a103d58bc93", "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": "a5147f7f-0b24-4cc3-9566-039dafbaad8c", "Name": "sample string 1" }, "Unit": { "UnitId": "6c681551-d2e1-4598-89a0-85dc00aa3628", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9c31d95d-8c7a-4e86-ae96-6db37b1f9d8f", "CreateDate": "2025-05-08T13:36:18.3055153-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T13:36:18.3055153-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": "5b6ab0cb-afc2-487c-adcb-495b37c247f1", "Section": { "FormTypeSectionId": "c899b135-ac07-473f-8886-2a103d58bc93", "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": "a5147f7f-0b24-4cc3-9566-039dafbaad8c", "Name": "sample string 1" }, "Unit": { "UnitId": "6c681551-d2e1-4598-89a0-85dc00aa3628", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9c31d95d-8c7a-4e86-ae96-6db37b1f9d8f", "CreateDate": "2025-05-08T13:36:18.3055153-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T13:36:18.3055153-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": "565e6fb4-b742-4470-bf10-275a98a65d2d", "CreateDate": "2025-05-08T13:36:18.3055153-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T13:36:18.3055153-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-05-08T13:36:18.3055153-07:00", "Location": "sample string 1", "TaskId": "fde0b39e-9e31-43df-92c7-f2d78cc34c84", "Values": [ { "FormFieldValueId": "9bfafd57-6c4c-44f5-b289-deb7123ed0f7", "FormTypeField": { "FormTypeFieldId": "5b6ab0cb-afc2-487c-adcb-495b37c247f1", "Section": { "FormTypeSectionId": "c899b135-ac07-473f-8886-2a103d58bc93", "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": "a5147f7f-0b24-4cc3-9566-039dafbaad8c", "Name": "sample string 1" }, "Unit": { "UnitId": "6c681551-d2e1-4598-89a0-85dc00aa3628", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9c31d95d-8c7a-4e86-ae96-6db37b1f9d8f", "CreateDate": "2025-05-08T13:36:18.3055153-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T13:36:18.3055153-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": "9bfafd57-6c4c-44f5-b289-deb7123ed0f7", "FormTypeField": { "FormTypeFieldId": "5b6ab0cb-afc2-487c-adcb-495b37c247f1", "Section": { "FormTypeSectionId": "c899b135-ac07-473f-8886-2a103d58bc93", "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": "a5147f7f-0b24-4cc3-9566-039dafbaad8c", "Name": "sample string 1" }, "Unit": { "UnitId": "6c681551-d2e1-4598-89a0-85dc00aa3628", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9c31d95d-8c7a-4e86-ae96-6db37b1f9d8f", "CreateDate": "2025-05-08T13:36:18.3055153-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T13:36:18.3055153-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": "ae7fb282-2a1a-4c50-8594-bb837aa8d9fd", "CreateDate": "2025-05-08T13:36:18.3055153-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-08T13:36:18.3055153-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": "9c7bf968-f8e0-4b43-a64b-e45cc3a00e26", "Asset": { "AssetId": "876c813f-061a-4059-9cfd-1226801c7e1b", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "34289214-5655-4906-9507-2015e8e87a3f", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a9eb6ba8-05d4-45f3-a375-c5dc7e252125", "CreateDate": "2025-05-08T13:36:18.6648747-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-08T13:36:18.6648747-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "62652472-d8f0-4b27-813e-9e776888450b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-08T13:36:18.6648747-07:00", "MeasurementValueNeededDate": "2025-05-08T13:36:18.6648747-07:00", "SourceSystemId": "sample string 3", "CompanyId": "8159d9bb-e2db-44b5-ad5b-b3d7798c5160", "CreateDate": "2025-05-08T13:36:18.6648747-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T13:36:18.6648747-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-08T13:36:18.6648747-07:00", "MeasurementValueNeededDate": "2025-05-08T13:36:18.6648747-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "2d63ad5b-f204-45e7-9fb2-9e373d42335e", "CreateDate": "2025-05-08T13:36:18.6648747-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-08T13:36:18.6648747-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "48840567-623c-4f3f-91a4-bd8896819e85", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "34289214-5655-4906-9507-2015e8e87a3f", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a9eb6ba8-05d4-45f3-a375-c5dc7e252125", "CreateDate": "2025-05-08T13:36:18.6648747-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-08T13:36:18.6648747-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-08T13:36:18.6648747-07:00", "Fields": [ { "FormTypeFieldId": "33d966b0-95e3-4e2e-a757-a06f4cdbcbbd", "Section": { "FormTypeSectionId": "421d5026-00f5-4bfd-95f7-47b2e80fc0a2", "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": "899b1685-f552-499d-bd55-c818e3ca56be", "Name": "sample string 1" }, "Unit": { "UnitId": "86fb0917-2668-4c5d-877b-b72d6b5a6495", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "39f21c4c-6f00-4e1c-af36-d691ed6e232c", "CreateDate": "2025-05-08T13:36:18.6648747-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T13:36:18.6648747-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": "33d966b0-95e3-4e2e-a757-a06f4cdbcbbd", "Section": { "FormTypeSectionId": "421d5026-00f5-4bfd-95f7-47b2e80fc0a2", "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": "899b1685-f552-499d-bd55-c818e3ca56be", "Name": "sample string 1" }, "Unit": { "UnitId": "86fb0917-2668-4c5d-877b-b72d6b5a6495", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "39f21c4c-6f00-4e1c-af36-d691ed6e232c", "CreateDate": "2025-05-08T13:36:18.6648747-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T13:36:18.6648747-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": "a96616a5-dff5-4966-975b-ea75d0921845", "CreateDate": "2025-05-08T13:36:18.6648747-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T13:36:18.6648747-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-05-08T13:36:18.6648747-07:00", "Location": "sample string 1", "TaskId": "195a0a17-7b51-49c4-859c-7013600e4608", "Values": [ { "FormFieldValueId": "299c04d6-2fc7-4a7d-bc14-ce9f904782b4", "FormTypeField": { "FormTypeFieldId": "33d966b0-95e3-4e2e-a757-a06f4cdbcbbd", "Section": { "FormTypeSectionId": "421d5026-00f5-4bfd-95f7-47b2e80fc0a2", "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": "899b1685-f552-499d-bd55-c818e3ca56be", "Name": "sample string 1" }, "Unit": { "UnitId": "86fb0917-2668-4c5d-877b-b72d6b5a6495", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "39f21c4c-6f00-4e1c-af36-d691ed6e232c", "CreateDate": "2025-05-08T13:36:18.6648747-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T13:36:18.6648747-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": "299c04d6-2fc7-4a7d-bc14-ce9f904782b4", "FormTypeField": { "FormTypeFieldId": "33d966b0-95e3-4e2e-a757-a06f4cdbcbbd", "Section": { "FormTypeSectionId": "421d5026-00f5-4bfd-95f7-47b2e80fc0a2", "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": "899b1685-f552-499d-bd55-c818e3ca56be", "Name": "sample string 1" }, "Unit": { "UnitId": "86fb0917-2668-4c5d-877b-b72d6b5a6495", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "39f21c4c-6f00-4e1c-af36-d691ed6e232c", "CreateDate": "2025-05-08T13:36:18.6648747-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T13:36:18.6648747-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": "55844024-15c6-4de8-a851-67b1b2a5b312", "CreateDate": "2025-05-08T13:36:18.6648747-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-08T13:36:18.6648747-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }