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": "abef14e3-35b8-4721-87d1-b3b85f08386c", "Asset": { "AssetId": "f092f713-c5f1-4900-a862-071a4110a67c", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "ed135942-9ca8-499e-9097-cf5b801340d9", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7fddb909-1708-40f6-813f-4e469b3ea883", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-21T16:11:54.6596692-08:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "fdde6fcb-d169-48fd-8032-903f01521963", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-21T16:11:54.6596692-08:00", "MeasurementValueNeededDate": "2024-12-21T16:11:54.6596692-08:00", "SourceSystemId": "sample string 3", "CompanyId": "619e2a3f-7854-4446-97e0-f86b6f771922", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T16:11:54.6596692-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-12-21T16:11:54.6596692-08:00", "MeasurementValueNeededDate": "2024-12-21T16:11:54.6596692-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "4f25474a-6ac2-4139-b0df-4277481214e8", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-12-21T16:11:54.6596692-08:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "5605754c-33db-4a92-bfda-4030e6fd7853", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "ed135942-9ca8-499e-9097-cf5b801340d9", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7fddb909-1708-40f6-813f-4e469b3ea883", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-21T16:11:54.6596692-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-12-21T16:11:54.6596692-08:00", "Fields": [ { "FormTypeFieldId": "862b2cba-3f33-4819-bc0b-274c8b9d8eed", "Section": { "FormTypeSectionId": "794523c0-0e37-4eff-a625-dd627a12c649", "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": "9905cd65-29b2-4442-bef1-7dc2a5a70a2d", "Name": "sample string 1" }, "Unit": { "UnitId": "6121dfc1-cc5c-4d1d-8b58-b60a4780fe0a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "01f54ea3-cbc4-43d9-af82-ffd7c438fa4a", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T16:11:54.6596692-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": "862b2cba-3f33-4819-bc0b-274c8b9d8eed", "Section": { "FormTypeSectionId": "794523c0-0e37-4eff-a625-dd627a12c649", "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": "9905cd65-29b2-4442-bef1-7dc2a5a70a2d", "Name": "sample string 1" }, "Unit": { "UnitId": "6121dfc1-cc5c-4d1d-8b58-b60a4780fe0a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "01f54ea3-cbc4-43d9-af82-ffd7c438fa4a", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T16:11:54.6596692-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": "a8a4dee2-31a8-4933-b353-e838e39e3d83", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T16:11:54.6596692-08:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-12-21T16:11:54.6596692-08:00", "Location": "sample string 1", "TaskId": "35d46a98-bce4-4f6b-b234-8e2f8962f364", "Values": [ { "FormFieldValueId": "94373a9c-8f4d-4da0-898c-d0230350e26a", "FormTypeField": { "FormTypeFieldId": "862b2cba-3f33-4819-bc0b-274c8b9d8eed", "Section": { "FormTypeSectionId": "794523c0-0e37-4eff-a625-dd627a12c649", "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": "9905cd65-29b2-4442-bef1-7dc2a5a70a2d", "Name": "sample string 1" }, "Unit": { "UnitId": "6121dfc1-cc5c-4d1d-8b58-b60a4780fe0a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "01f54ea3-cbc4-43d9-af82-ffd7c438fa4a", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T16:11:54.6596692-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": "94373a9c-8f4d-4da0-898c-d0230350e26a", "FormTypeField": { "FormTypeFieldId": "862b2cba-3f33-4819-bc0b-274c8b9d8eed", "Section": { "FormTypeSectionId": "794523c0-0e37-4eff-a625-dd627a12c649", "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": "9905cd65-29b2-4442-bef1-7dc2a5a70a2d", "Name": "sample string 1" }, "Unit": { "UnitId": "6121dfc1-cc5c-4d1d-8b58-b60a4780fe0a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "01f54ea3-cbc4-43d9-af82-ffd7c438fa4a", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T16:11:54.6596692-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": "7b6a4ca3-d971-4aed-8ea0-a092c3d2a00d", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-12-21T16:11:54.6596692-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": "37e1026b-3d95-44ce-b912-a1961122d7fa", "Asset": { "AssetId": "132f32d7-0720-44d6-8a3e-c12711146b0a", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "7d08a33c-d461-4bed-8146-9c6d9966fb40", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "12161bf4-8751-4865-ad2a-9a14513fae8c", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-21T16:11:54.6596692-08:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "310dbbf7-464e-4555-b535-91d237d52876", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-12-21T16:11:54.6596692-08:00", "MeasurementValueNeededDate": "2024-12-21T16:11:54.6596692-08:00", "SourceSystemId": "sample string 3", "CompanyId": "ab02bb28-01ab-4a5c-bcef-dd8d43eeed7a", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T16:11:54.6596692-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-12-21T16:11:54.6596692-08:00", "MeasurementValueNeededDate": "2024-12-21T16:11:54.6596692-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "1c440df2-b586-428b-b518-b18355b7a635", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-12-21T16:11:54.6596692-08:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "9f0540d7-056d-4b87-b267-23dfa10d1bab", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "7d08a33c-d461-4bed-8146-9c6d9966fb40", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "12161bf4-8751-4865-ad2a-9a14513fae8c", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-21T16:11:54.6596692-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-12-21T16:11:54.6596692-08:00", "Fields": [ { "FormTypeFieldId": "98c379ad-58b4-49a4-b809-18b2965dd48d", "Section": { "FormTypeSectionId": "cfe5a4e0-7775-4824-a2df-b0e49e796393", "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": "85db497a-b97a-4870-97fd-e0cb46b1acf0", "Name": "sample string 1" }, "Unit": { "UnitId": "86035c0f-2fdc-4f90-8e08-b4783de58157", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "bffd657b-8707-43ae-947e-73e4ee0fa595", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T16:11:54.6596692-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": "98c379ad-58b4-49a4-b809-18b2965dd48d", "Section": { "FormTypeSectionId": "cfe5a4e0-7775-4824-a2df-b0e49e796393", "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": "85db497a-b97a-4870-97fd-e0cb46b1acf0", "Name": "sample string 1" }, "Unit": { "UnitId": "86035c0f-2fdc-4f90-8e08-b4783de58157", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "bffd657b-8707-43ae-947e-73e4ee0fa595", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T16:11:54.6596692-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": "3eeac853-dc08-4961-acac-7bbc69959798", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T16:11:54.6596692-08:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-12-21T16:11:54.6596692-08:00", "Location": "sample string 1", "TaskId": "e00b478f-3e17-4984-b7cb-d491cfa5d779", "Values": [ { "FormFieldValueId": "f2399c10-63c3-42c1-adf8-eb92400f5583", "FormTypeField": { "FormTypeFieldId": "98c379ad-58b4-49a4-b809-18b2965dd48d", "Section": { "FormTypeSectionId": "cfe5a4e0-7775-4824-a2df-b0e49e796393", "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": "85db497a-b97a-4870-97fd-e0cb46b1acf0", "Name": "sample string 1" }, "Unit": { "UnitId": "86035c0f-2fdc-4f90-8e08-b4783de58157", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "bffd657b-8707-43ae-947e-73e4ee0fa595", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T16:11:54.6596692-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": "f2399c10-63c3-42c1-adf8-eb92400f5583", "FormTypeField": { "FormTypeFieldId": "98c379ad-58b4-49a4-b809-18b2965dd48d", "Section": { "FormTypeSectionId": "cfe5a4e0-7775-4824-a2df-b0e49e796393", "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": "85db497a-b97a-4870-97fd-e0cb46b1acf0", "Name": "sample string 1" }, "Unit": { "UnitId": "86035c0f-2fdc-4f90-8e08-b4783de58157", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "bffd657b-8707-43ae-947e-73e4ee0fa595", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T16:11:54.6596692-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": "8bb9b6fd-b0af-4f18-9eab-5ed2279f3d79", "CreateDate": "2024-12-21T16:11:54.6596692-08:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-12-21T16:11:54.6596692-08:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }