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": "0e5a7575-c681-4f9f-8662-57c2bcda6f17", "Asset": { "AssetId": "85d69b28-5aa5-454f-9eeb-76909fe02875", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d39ae48a-e284-415a-9158-8407a61ab808", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bc6bd2cd-d123-4c47-b02f-23e048c11248", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-16T01:55:19.5437468-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "5ed9ee76-d05f-4736-97be-735128b26aa0", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-16T01:55:19.5437468-07:00", "MeasurementValueNeededDate": "2025-09-16T01:55:19.5437468-07:00", "SourceSystemId": "sample string 3", "CompanyId": "bf6ed9e8-9056-44c8-8a80-659bbaaae4f8", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:55:19.5437468-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-09-16T01:55:19.5437468-07:00", "MeasurementValueNeededDate": "2025-09-16T01:55:19.5437468-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "19b7e670-6830-4f18-bb61-1d360b2d75b3", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-16T01:55:19.5437468-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "7c80d562-ec1c-4f3c-9dbc-1f74e598fbc2", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "d39ae48a-e284-415a-9158-8407a61ab808", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bc6bd2cd-d123-4c47-b02f-23e048c11248", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-16T01:55:19.5437468-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-16T01:55:19.5437468-07:00", "Fields": [ { "FormTypeFieldId": "0e2c29e0-1679-4d47-86f6-064ebc36e325", "Section": { "FormTypeSectionId": "f6911a03-bcbf-4b29-86a1-f5459126792c", "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": "2dec91b9-d64e-4759-888c-337e6ebc36f4", "Name": "sample string 1" }, "Unit": { "UnitId": "5ec162dc-1b19-4e03-87d1-b06fd52688be", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "7f278169-c582-4861-9733-021f3c43003c", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:55:19.5437468-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": "0e2c29e0-1679-4d47-86f6-064ebc36e325", "Section": { "FormTypeSectionId": "f6911a03-bcbf-4b29-86a1-f5459126792c", "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": "2dec91b9-d64e-4759-888c-337e6ebc36f4", "Name": "sample string 1" }, "Unit": { "UnitId": "5ec162dc-1b19-4e03-87d1-b06fd52688be", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "7f278169-c582-4861-9733-021f3c43003c", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:55:19.5437468-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": "e21ceea9-9476-4449-b0cc-3c0b1880e4e1", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:55:19.5437468-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-09-16T01:55:19.5437468-07:00", "Location": "sample string 1", "TaskId": "0221f8e4-b6af-4b57-be43-41d77a4d1ec2", "Values": [ { "FormFieldValueId": "7b7353a1-dd0c-4f7a-a8e9-4e21de9100f1", "FormTypeField": { "FormTypeFieldId": "0e2c29e0-1679-4d47-86f6-064ebc36e325", "Section": { "FormTypeSectionId": "f6911a03-bcbf-4b29-86a1-f5459126792c", "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": "2dec91b9-d64e-4759-888c-337e6ebc36f4", "Name": "sample string 1" }, "Unit": { "UnitId": "5ec162dc-1b19-4e03-87d1-b06fd52688be", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "7f278169-c582-4861-9733-021f3c43003c", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:55:19.5437468-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": "7b7353a1-dd0c-4f7a-a8e9-4e21de9100f1", "FormTypeField": { "FormTypeFieldId": "0e2c29e0-1679-4d47-86f6-064ebc36e325", "Section": { "FormTypeSectionId": "f6911a03-bcbf-4b29-86a1-f5459126792c", "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": "2dec91b9-d64e-4759-888c-337e6ebc36f4", "Name": "sample string 1" }, "Unit": { "UnitId": "5ec162dc-1b19-4e03-87d1-b06fd52688be", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "7f278169-c582-4861-9733-021f3c43003c", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:55:19.5437468-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": "ea802a9a-ddd7-4e68-a3ec-e679d1ec8fe5", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-16T01:55:19.5437468-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": "5ec31ee1-cb6d-48c9-ab97-f24869e421e8", "Asset": { "AssetId": "2f196e8d-318b-45a2-add9-930fda023dc9", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "0263a2ea-5a8b-45d5-8e27-3266e88b3602", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5ff8c4f4-3a9a-4085-8bed-bf83ae99db65", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-16T01:55:19.5437468-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "98885709-11c5-4a42-9497-2b2f3d96d10a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-16T01:55:19.5437468-07:00", "MeasurementValueNeededDate": "2025-09-16T01:55:19.5437468-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b19062a4-1d4f-45a7-aa33-98560de9892b", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:55:19.5437468-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-09-16T01:55:19.5437468-07:00", "MeasurementValueNeededDate": "2025-09-16T01:55:19.5437468-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "7d5c93db-0873-4f9c-b517-8a5cc04efb51", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-16T01:55:19.5437468-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "1238ee37-317c-4897-b0fb-083aa39a9ba5", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "0263a2ea-5a8b-45d5-8e27-3266e88b3602", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5ff8c4f4-3a9a-4085-8bed-bf83ae99db65", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-16T01:55:19.5437468-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-16T01:55:19.5437468-07:00", "Fields": [ { "FormTypeFieldId": "0e6419df-0d00-4322-90aa-1ff256a0293a", "Section": { "FormTypeSectionId": "2b179cf0-acbc-4edd-bb53-f1906251e105", "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": "cb648295-cffc-46aa-9352-45452ba6dbed", "Name": "sample string 1" }, "Unit": { "UnitId": "cfec4b4e-c792-471f-b770-e6d22859f42a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9facc0b9-1e28-4d2d-926f-16f53bdd5715", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:55:19.5437468-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": "0e6419df-0d00-4322-90aa-1ff256a0293a", "Section": { "FormTypeSectionId": "2b179cf0-acbc-4edd-bb53-f1906251e105", "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": "cb648295-cffc-46aa-9352-45452ba6dbed", "Name": "sample string 1" }, "Unit": { "UnitId": "cfec4b4e-c792-471f-b770-e6d22859f42a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9facc0b9-1e28-4d2d-926f-16f53bdd5715", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:55:19.5437468-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": "a631484d-c765-496d-baac-f78d1c1e64df", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:55:19.5437468-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-09-16T01:55:19.5437468-07:00", "Location": "sample string 1", "TaskId": "c20193b7-60b4-48e7-8bcd-d0d669cf86bd", "Values": [ { "FormFieldValueId": "fef5e6e7-8e10-46de-9f63-923131cbe9ec", "FormTypeField": { "FormTypeFieldId": "0e6419df-0d00-4322-90aa-1ff256a0293a", "Section": { "FormTypeSectionId": "2b179cf0-acbc-4edd-bb53-f1906251e105", "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": "cb648295-cffc-46aa-9352-45452ba6dbed", "Name": "sample string 1" }, "Unit": { "UnitId": "cfec4b4e-c792-471f-b770-e6d22859f42a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9facc0b9-1e28-4d2d-926f-16f53bdd5715", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:55:19.5437468-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": "fef5e6e7-8e10-46de-9f63-923131cbe9ec", "FormTypeField": { "FormTypeFieldId": "0e6419df-0d00-4322-90aa-1ff256a0293a", "Section": { "FormTypeSectionId": "2b179cf0-acbc-4edd-bb53-f1906251e105", "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": "cb648295-cffc-46aa-9352-45452ba6dbed", "Name": "sample string 1" }, "Unit": { "UnitId": "cfec4b4e-c792-471f-b770-e6d22859f42a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9facc0b9-1e28-4d2d-926f-16f53bdd5715", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:55:19.5437468-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": "c2492189-e714-4b6f-b2c9-d3a82fba5629", "CreateDate": "2025-09-16T01:55:19.5437468-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-16T01:55:19.5437468-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }