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": "55967baa-3fbd-4515-9197-71d24c331db6", "Asset": { "AssetId": "ff824789-33e6-4bfd-8541-18bf0aae65d1", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "4358d872-8176-436e-86ba-6a9d2d2a84f6", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "b0910ac4-0e66-4bac-82d6-ead0ba001ee2", "CreateDate": "2025-10-13T14:48:53.2774211-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T14:48:53.2774211-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "8a5f2205-ab48-4281-a6b6-a35bd0a6c75c", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T14:48:53.2774211-07:00", "MeasurementValueNeededDate": "2025-10-13T14:48:53.2774211-07:00", "SourceSystemId": "sample string 3", "CompanyId": "90e9fe34-d2e8-43f6-9848-c7fb8b373205", "CreateDate": "2025-10-13T14:48:53.2774211-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T14:48:53.2774211-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-10-13T14:48:53.2774211-07:00", "MeasurementValueNeededDate": "2025-10-13T14:48:53.2774211-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "661d9925-7847-421c-87e8-acb5e8b6a931", "CreateDate": "2025-10-13T14:48:53.2774211-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T14:48:53.2774211-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "f8975cff-56fc-4260-9d91-36b3ab48d77e", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "4358d872-8176-436e-86ba-6a9d2d2a84f6", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "b0910ac4-0e66-4bac-82d6-ead0ba001ee2", "CreateDate": "2025-10-13T14:48:53.2774211-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T14:48:53.2774211-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-13T14:48:53.2774211-07:00", "Fields": [ { "FormTypeFieldId": "925e1671-358e-46ca-aadd-b773f133186f", "Section": { "FormTypeSectionId": "360818e4-0dc2-43ee-9044-b1db1b3449e5", "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": "27dbb4d3-2c28-4c6e-9ed6-77a736d46784", "Name": "sample string 1" }, "Unit": { "UnitId": "eecf1fb1-28e0-41c9-88a5-dba5fc95dd3f", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3ac22700-83c7-423b-8738-34f986178425", "CreateDate": "2025-10-13T14:48:53.2774211-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T14:48:53.2774211-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": "925e1671-358e-46ca-aadd-b773f133186f", "Section": { "FormTypeSectionId": "360818e4-0dc2-43ee-9044-b1db1b3449e5", "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": "27dbb4d3-2c28-4c6e-9ed6-77a736d46784", "Name": "sample string 1" }, "Unit": { "UnitId": "eecf1fb1-28e0-41c9-88a5-dba5fc95dd3f", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3ac22700-83c7-423b-8738-34f986178425", "CreateDate": "2025-10-13T14:48:53.2774211-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T14:48:53.2774211-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": "a82191e0-c253-4bc1-a610-e7bc5cec3284", "CreateDate": "2025-10-13T14:48:53.2774211-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T14:48:53.2774211-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-10-13T14:48:53.2774211-07:00", "Location": "sample string 1", "TaskId": "5ffd3b24-7c05-48e9-b484-8ff1cd66a058", "Values": [ { "FormFieldValueId": "50931649-1909-4baa-8abd-17bdfc6c56b3", "FormTypeField": { "FormTypeFieldId": "925e1671-358e-46ca-aadd-b773f133186f", "Section": { "FormTypeSectionId": "360818e4-0dc2-43ee-9044-b1db1b3449e5", "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": "27dbb4d3-2c28-4c6e-9ed6-77a736d46784", "Name": "sample string 1" }, "Unit": { "UnitId": "eecf1fb1-28e0-41c9-88a5-dba5fc95dd3f", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3ac22700-83c7-423b-8738-34f986178425", "CreateDate": "2025-10-13T14:48:53.2774211-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T14:48:53.2774211-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": "50931649-1909-4baa-8abd-17bdfc6c56b3", "FormTypeField": { "FormTypeFieldId": "925e1671-358e-46ca-aadd-b773f133186f", "Section": { "FormTypeSectionId": "360818e4-0dc2-43ee-9044-b1db1b3449e5", "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": "27dbb4d3-2c28-4c6e-9ed6-77a736d46784", "Name": "sample string 1" }, "Unit": { "UnitId": "eecf1fb1-28e0-41c9-88a5-dba5fc95dd3f", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3ac22700-83c7-423b-8738-34f986178425", "CreateDate": "2025-10-13T14:48:53.2774211-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T14:48:53.2774211-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": "21b2dc3e-fe2a-432f-b121-56f7b71bdba1", "CreateDate": "2025-10-13T14:48:53.2774211-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-10-13T14:48:53.2774211-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": "2feb42bf-d84b-4bf4-84a9-617b95ff81fd", "Asset": { "AssetId": "5ca6ae32-e990-4b70-8fde-d4fdc242e9e2", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "8c209c5e-cfaa-42fd-8143-9307ce78451f", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "ecf5a6b2-b85b-4c4f-8be2-2c9bad3377a6", "CreateDate": "2025-10-13T14:48:53.3086939-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T14:48:53.3086939-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "c704f79f-f662-4f6c-9252-0c339d452287", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T14:48:53.3086939-07:00", "MeasurementValueNeededDate": "2025-10-13T14:48:53.3086939-07:00", "SourceSystemId": "sample string 3", "CompanyId": "50cdee63-53fd-4a9e-b9ef-c3c5e2e5922e", "CreateDate": "2025-10-13T14:48:53.3086939-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T14:48:53.3086939-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-10-13T14:48:53.3086939-07:00", "MeasurementValueNeededDate": "2025-10-13T14:48:53.3086939-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "acba3dc0-ac1a-421d-af96-3f8254d8e226", "CreateDate": "2025-10-13T14:48:53.3086939-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T14:48:53.3086939-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "215e6970-8e0e-433d-80c9-b5caa5a87a48", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "8c209c5e-cfaa-42fd-8143-9307ce78451f", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "ecf5a6b2-b85b-4c4f-8be2-2c9bad3377a6", "CreateDate": "2025-10-13T14:48:53.3086939-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T14:48:53.3086939-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-13T14:48:53.3086939-07:00", "Fields": [ { "FormTypeFieldId": "a1c7aafd-662f-4c56-965d-bb9d5f5acfc7", "Section": { "FormTypeSectionId": "58ac839e-2347-4f21-b1a8-e6d483750394", "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": "ecdf850b-f5fd-4689-b676-fff82b127e79", "Name": "sample string 1" }, "Unit": { "UnitId": "33608766-6c73-457f-a178-523a1f9a5332", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "626b5c3f-a795-4b07-8bc6-9788580daf3b", "CreateDate": "2025-10-13T14:48:53.3086939-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T14:48:53.3086939-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": "a1c7aafd-662f-4c56-965d-bb9d5f5acfc7", "Section": { "FormTypeSectionId": "58ac839e-2347-4f21-b1a8-e6d483750394", "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": "ecdf850b-f5fd-4689-b676-fff82b127e79", "Name": "sample string 1" }, "Unit": { "UnitId": "33608766-6c73-457f-a178-523a1f9a5332", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "626b5c3f-a795-4b07-8bc6-9788580daf3b", "CreateDate": "2025-10-13T14:48:53.3086939-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T14:48:53.3086939-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": "96fda06f-c9c9-45b3-a67a-a0d8caeba0bb", "CreateDate": "2025-10-13T14:48:53.3086939-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T14:48:53.3086939-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-10-13T14:48:53.3086939-07:00", "Location": "sample string 1", "TaskId": "7c782c1a-6016-4b9a-b732-5fc1a92f2b73", "Values": [ { "FormFieldValueId": "8a3293e3-72fa-44b5-97b6-a0db164e861e", "FormTypeField": { "FormTypeFieldId": "a1c7aafd-662f-4c56-965d-bb9d5f5acfc7", "Section": { "FormTypeSectionId": "58ac839e-2347-4f21-b1a8-e6d483750394", "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": "ecdf850b-f5fd-4689-b676-fff82b127e79", "Name": "sample string 1" }, "Unit": { "UnitId": "33608766-6c73-457f-a178-523a1f9a5332", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "626b5c3f-a795-4b07-8bc6-9788580daf3b", "CreateDate": "2025-10-13T14:48:53.3086939-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T14:48:53.3086939-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": "8a3293e3-72fa-44b5-97b6-a0db164e861e", "FormTypeField": { "FormTypeFieldId": "a1c7aafd-662f-4c56-965d-bb9d5f5acfc7", "Section": { "FormTypeSectionId": "58ac839e-2347-4f21-b1a8-e6d483750394", "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": "ecdf850b-f5fd-4689-b676-fff82b127e79", "Name": "sample string 1" }, "Unit": { "UnitId": "33608766-6c73-457f-a178-523a1f9a5332", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "626b5c3f-a795-4b07-8bc6-9788580daf3b", "CreateDate": "2025-10-13T14:48:53.3086939-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T14:48:53.3086939-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": "31ec1446-39ca-476e-b4e0-09526db371ba", "CreateDate": "2025-10-13T14:48:53.3086939-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-10-13T14:48:53.3086939-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }