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": "d6fb8faf-0a8a-46bb-b801-8484a84eaf88", "Asset": { "AssetId": "828cc74f-e42f-46a0-bc1a-95f2c9fa0937", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "afce23fe-f225-4df5-b49a-d9af10bfb6eb", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "fd680c1f-fa2b-4a03-9e89-d80af713dd7c", "CreateDate": "2025-09-18T09:04:43.4107751-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-18T09:04:43.4107751-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "4109883b-2694-45f4-87d4-6700771029b0", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-18T09:04:43.4107751-07:00", "MeasurementValueNeededDate": "2025-09-18T09:04:43.4107751-07:00", "SourceSystemId": "sample string 3", "CompanyId": "7fe076d3-b021-4264-97c7-6d3cf9c571aa", "CreateDate": "2025-09-18T09:04:43.4107751-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-18T09:04:43.4107751-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-09-18T09:04:43.4107751-07:00", "MeasurementValueNeededDate": "2025-09-18T09:04:43.4107751-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "19c38074-6ff7-46bf-9319-0f628ffeffbb", "CreateDate": "2025-09-18T09:04:43.4107751-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-18T09:04:43.4107751-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "cbf23321-a01b-41c7-9edc-82e8d2516b14", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "afce23fe-f225-4df5-b49a-d9af10bfb6eb", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "fd680c1f-fa2b-4a03-9e89-d80af713dd7c", "CreateDate": "2025-09-18T09:04:43.4107751-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-18T09:04:43.4107751-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-18T09:04:43.4107751-07:00", "Fields": [ { "FormTypeFieldId": "ef5df426-3189-45d8-b8fb-09c4820ab007", "Section": { "FormTypeSectionId": "5cff7f30-fa6d-430b-8825-629ef6a2d39a", "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": "ba05d7c0-b5af-443a-91e0-229328407a1c", "Name": "sample string 1" }, "Unit": { "UnitId": "c03682fd-c128-4279-9add-9dffe38efd66", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2400af1c-91e2-44c7-a6cf-2e7c32df1bdf", "CreateDate": "2025-09-18T09:04:43.4107751-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-18T09:04:43.4107751-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": "ef5df426-3189-45d8-b8fb-09c4820ab007", "Section": { "FormTypeSectionId": "5cff7f30-fa6d-430b-8825-629ef6a2d39a", "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": "ba05d7c0-b5af-443a-91e0-229328407a1c", "Name": "sample string 1" }, "Unit": { "UnitId": "c03682fd-c128-4279-9add-9dffe38efd66", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2400af1c-91e2-44c7-a6cf-2e7c32df1bdf", "CreateDate": "2025-09-18T09:04:43.4107751-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-18T09:04:43.4107751-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": "634a1cbe-fead-43f7-81e1-dc674b659f08", "CreateDate": "2025-09-18T09:04:43.4107751-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-18T09:04:43.4107751-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-09-18T09:04:43.4107751-07:00", "Location": "sample string 1", "TaskId": "bf0364c3-339e-4682-8f6a-93692a78a30d", "Values": [ { "FormFieldValueId": "2acf869b-7f3d-462b-b4f6-9de2da868b84", "FormTypeField": { "FormTypeFieldId": "ef5df426-3189-45d8-b8fb-09c4820ab007", "Section": { "FormTypeSectionId": "5cff7f30-fa6d-430b-8825-629ef6a2d39a", "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": "ba05d7c0-b5af-443a-91e0-229328407a1c", "Name": "sample string 1" }, "Unit": { "UnitId": "c03682fd-c128-4279-9add-9dffe38efd66", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2400af1c-91e2-44c7-a6cf-2e7c32df1bdf", "CreateDate": "2025-09-18T09:04:43.4107751-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-18T09:04:43.4107751-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": "2acf869b-7f3d-462b-b4f6-9de2da868b84", "FormTypeField": { "FormTypeFieldId": "ef5df426-3189-45d8-b8fb-09c4820ab007", "Section": { "FormTypeSectionId": "5cff7f30-fa6d-430b-8825-629ef6a2d39a", "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": "ba05d7c0-b5af-443a-91e0-229328407a1c", "Name": "sample string 1" }, "Unit": { "UnitId": "c03682fd-c128-4279-9add-9dffe38efd66", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2400af1c-91e2-44c7-a6cf-2e7c32df1bdf", "CreateDate": "2025-09-18T09:04:43.4107751-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-18T09:04:43.4107751-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": "47809985-9cce-461d-82ef-43393fdef975", "CreateDate": "2025-09-18T09:04:43.4107751-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-18T09:04:43.4107751-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": "d98e3b60-02b2-4a6e-bace-32b3abfeae0d", "Asset": { "AssetId": "ad80c84c-814d-4ca6-abd2-b53652ced02d", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "8539bceb-d636-49f0-a508-30956d565138", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "497d919a-1f94-4f6b-bbb8-5ec3e2bcfc62", "CreateDate": "2025-09-18T09:04:43.4263922-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-18T09:04:43.4263922-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "e2f03bf0-bbef-4ce4-800b-a45f8c8322a9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-18T09:04:43.4263922-07:00", "MeasurementValueNeededDate": "2025-09-18T09:04:43.4263922-07:00", "SourceSystemId": "sample string 3", "CompanyId": "3df8b061-5b1b-4206-9ed0-b272372ec31e", "CreateDate": "2025-09-18T09:04:43.4263922-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-18T09:04:43.4263922-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-09-18T09:04:43.4263922-07:00", "MeasurementValueNeededDate": "2025-09-18T09:04:43.4263922-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "f5b2780f-e870-4811-9a58-e0a9b13f0fd4", "CreateDate": "2025-09-18T09:04:43.4263922-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-18T09:04:43.4263922-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "6803fd07-2578-4220-86ca-cb5e1e4d1539", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "8539bceb-d636-49f0-a508-30956d565138", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "497d919a-1f94-4f6b-bbb8-5ec3e2bcfc62", "CreateDate": "2025-09-18T09:04:43.4263922-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-18T09:04:43.4263922-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-18T09:04:43.4263922-07:00", "Fields": [ { "FormTypeFieldId": "e7a5ec2d-b188-480c-92ae-130b0cdd6344", "Section": { "FormTypeSectionId": "e824c753-1b24-435f-9b21-a0a46c58b1db", "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": "81e31917-1061-4256-9745-2ed24ddec2d7", "Name": "sample string 1" }, "Unit": { "UnitId": "2bd32490-2f2a-4276-aae2-ff0802dd0ebf", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "88e0fbb3-875b-49e0-bd34-a901365b0dbd", "CreateDate": "2025-09-18T09:04:43.4263922-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-18T09:04:43.4263922-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": "e7a5ec2d-b188-480c-92ae-130b0cdd6344", "Section": { "FormTypeSectionId": "e824c753-1b24-435f-9b21-a0a46c58b1db", "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": "81e31917-1061-4256-9745-2ed24ddec2d7", "Name": "sample string 1" }, "Unit": { "UnitId": "2bd32490-2f2a-4276-aae2-ff0802dd0ebf", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "88e0fbb3-875b-49e0-bd34-a901365b0dbd", "CreateDate": "2025-09-18T09:04:43.4263922-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-18T09:04:43.4263922-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": "8a4871e2-0242-4121-af38-b54c7e0a7153", "CreateDate": "2025-09-18T09:04:43.4263922-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-18T09:04:43.4263922-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-09-18T09:04:43.4263922-07:00", "Location": "sample string 1", "TaskId": "f775ba33-e93d-4965-87e9-1271229ff6d7", "Values": [ { "FormFieldValueId": "e84a0cc1-d78d-4946-aece-e93bed5684d9", "FormTypeField": { "FormTypeFieldId": "e7a5ec2d-b188-480c-92ae-130b0cdd6344", "Section": { "FormTypeSectionId": "e824c753-1b24-435f-9b21-a0a46c58b1db", "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": "81e31917-1061-4256-9745-2ed24ddec2d7", "Name": "sample string 1" }, "Unit": { "UnitId": "2bd32490-2f2a-4276-aae2-ff0802dd0ebf", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "88e0fbb3-875b-49e0-bd34-a901365b0dbd", "CreateDate": "2025-09-18T09:04:43.4263922-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-18T09:04:43.4263922-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": "e84a0cc1-d78d-4946-aece-e93bed5684d9", "FormTypeField": { "FormTypeFieldId": "e7a5ec2d-b188-480c-92ae-130b0cdd6344", "Section": { "FormTypeSectionId": "e824c753-1b24-435f-9b21-a0a46c58b1db", "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": "81e31917-1061-4256-9745-2ed24ddec2d7", "Name": "sample string 1" }, "Unit": { "UnitId": "2bd32490-2f2a-4276-aae2-ff0802dd0ebf", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "88e0fbb3-875b-49e0-bd34-a901365b0dbd", "CreateDate": "2025-09-18T09:04:43.4263922-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-18T09:04:43.4263922-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": "7c71a55d-5d30-4ce3-95d9-f2a6b1f9e874", "CreateDate": "2025-09-18T09:04:43.4263922-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-18T09:04:43.4263922-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }