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": "eda9e7b5-3254-4e36-8a9d-e81546091a6a", "Asset": { "AssetId": "95445ddc-04ab-41e4-b3d6-69880d485bd1", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "5b7f3dce-ac2b-4c8e-bcf7-3e38a39a269b", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "55d6509a-8aae-486d-8ad8-138363521523", "CreateDate": "2024-04-26T16:13:09.7777572-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-26T16:13:09.7777572-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "d80a8b34-422e-451b-b54c-032180416b3e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-26T16:13:09.7777572-07:00", "MeasurementValueNeededDate": "2024-04-26T16:13:09.7777572-07:00", "SourceSystemId": "sample string 3", "CompanyId": "c197bffb-f80e-420a-8ba5-2536698b020b", "CreateDate": "2024-04-26T16:13:09.7777572-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T16:13:09.7777572-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-04-26T16:13:09.7777572-07:00", "MeasurementValueNeededDate": "2024-04-26T16:13:09.7777572-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "9adc9940-2f80-4ef8-8925-45daee1db236", "CreateDate": "2024-04-26T16:13:09.7777572-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T16:13:09.7777572-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "7e65095e-601a-41b9-ba78-346275e56388", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "5b7f3dce-ac2b-4c8e-bcf7-3e38a39a269b", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "55d6509a-8aae-486d-8ad8-138363521523", "CreateDate": "2024-04-26T16:13:09.7777572-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-26T16:13:09.7777572-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-26T16:13:09.7777572-07:00", "Fields": [ { "FormTypeFieldId": "07d10112-3365-48bb-b9fb-bc86b8c59783", "Section": { "FormTypeSectionId": "ddd2ea41-5ec4-4e04-8839-cc839b1bd2cd", "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": "d7737a74-1742-47ef-a236-188bff4318e3", "Name": "sample string 1" }, "Unit": { "UnitId": "3d12e124-fe53-462d-9b21-13403ac86a7c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2ee14aee-70aa-4b61-aa9c-6c9bd32fadb7", "CreateDate": "2024-04-26T16:13:09.7933285-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T16:13:09.7933285-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": "07d10112-3365-48bb-b9fb-bc86b8c59783", "Section": { "FormTypeSectionId": "ddd2ea41-5ec4-4e04-8839-cc839b1bd2cd", "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": "d7737a74-1742-47ef-a236-188bff4318e3", "Name": "sample string 1" }, "Unit": { "UnitId": "3d12e124-fe53-462d-9b21-13403ac86a7c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2ee14aee-70aa-4b61-aa9c-6c9bd32fadb7", "CreateDate": "2024-04-26T16:13:09.7933285-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T16:13:09.7933285-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": "e048c0e9-35be-472c-9127-5a3fde22d1bb", "CreateDate": "2024-04-26T16:13:09.7933285-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T16:13:09.7933285-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-04-26T16:13:09.7933285-07:00", "Location": "sample string 1", "TaskId": "f686648e-f38f-4fb5-8b3a-55752acef475", "Values": [ { "FormFieldValueId": "34564588-f910-45fe-a5c6-f449af7606a1", "FormTypeField": { "FormTypeFieldId": "07d10112-3365-48bb-b9fb-bc86b8c59783", "Section": { "FormTypeSectionId": "ddd2ea41-5ec4-4e04-8839-cc839b1bd2cd", "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": "d7737a74-1742-47ef-a236-188bff4318e3", "Name": "sample string 1" }, "Unit": { "UnitId": "3d12e124-fe53-462d-9b21-13403ac86a7c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2ee14aee-70aa-4b61-aa9c-6c9bd32fadb7", "CreateDate": "2024-04-26T16:13:09.7933285-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T16:13:09.7933285-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": "34564588-f910-45fe-a5c6-f449af7606a1", "FormTypeField": { "FormTypeFieldId": "07d10112-3365-48bb-b9fb-bc86b8c59783", "Section": { "FormTypeSectionId": "ddd2ea41-5ec4-4e04-8839-cc839b1bd2cd", "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": "d7737a74-1742-47ef-a236-188bff4318e3", "Name": "sample string 1" }, "Unit": { "UnitId": "3d12e124-fe53-462d-9b21-13403ac86a7c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2ee14aee-70aa-4b61-aa9c-6c9bd32fadb7", "CreateDate": "2024-04-26T16:13:09.7933285-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T16:13:09.7933285-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": "3dd8f991-81e9-45bf-81ad-df4e2be88020", "CreateDate": "2024-04-26T16:13:09.7933285-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-26T16:13:09.7933285-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": "dc7b7628-c6ac-4c97-a105-5144a86c4baa", "Asset": { "AssetId": "1474794d-cc83-4d64-83af-68a9d89ec6fc", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "da814601-43bd-4cd6-9317-eaa23bfe878b", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "60f8328a-ddcd-41d9-881e-31247f2c9d01", "CreateDate": "2024-04-26T16:13:09.840207-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-26T16:13:09.840207-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "49b678ae-27da-41f3-be1a-626d5a586094", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-26T16:13:09.840207-07:00", "MeasurementValueNeededDate": "2024-04-26T16:13:09.840207-07:00", "SourceSystemId": "sample string 3", "CompanyId": "8330b15f-c36a-48d9-b3de-b1acf0fda040", "CreateDate": "2024-04-26T16:13:09.840207-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T16:13:09.840207-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-04-26T16:13:09.840207-07:00", "MeasurementValueNeededDate": "2024-04-26T16:13:09.840207-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "b325e5ee-8dbb-4cb5-a1d9-174aa74c4d49", "CreateDate": "2024-04-26T16:13:09.840207-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T16:13:09.840207-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "4aa12343-4fe6-4d58-b469-ba0ef9af9cbb", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "da814601-43bd-4cd6-9317-eaa23bfe878b", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "60f8328a-ddcd-41d9-881e-31247f2c9d01", "CreateDate": "2024-04-26T16:13:09.840207-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-26T16:13:09.840207-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-26T16:13:09.840207-07:00", "Fields": [ { "FormTypeFieldId": "b82c53a1-e1df-407c-bf19-f91974aaba3f", "Section": { "FormTypeSectionId": "4515807c-0ad2-4c81-a44c-0de20d60c5e6", "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": "eb946ec1-11a1-4b6d-ae84-22bdc26267ad", "Name": "sample string 1" }, "Unit": { "UnitId": "ee3354cf-4f0f-4801-ab0a-018b75f4eb09", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1eb7c546-7dd3-44c3-a4b8-06b521e27352", "CreateDate": "2024-04-26T16:13:09.840207-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T16:13:09.840207-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": "b82c53a1-e1df-407c-bf19-f91974aaba3f", "Section": { "FormTypeSectionId": "4515807c-0ad2-4c81-a44c-0de20d60c5e6", "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": "eb946ec1-11a1-4b6d-ae84-22bdc26267ad", "Name": "sample string 1" }, "Unit": { "UnitId": "ee3354cf-4f0f-4801-ab0a-018b75f4eb09", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1eb7c546-7dd3-44c3-a4b8-06b521e27352", "CreateDate": "2024-04-26T16:13:09.840207-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T16:13:09.840207-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": "8be1d724-56b0-4d3a-bc28-157279f491fc", "CreateDate": "2024-04-26T16:13:09.840207-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T16:13:09.840207-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-04-26T16:13:09.840207-07:00", "Location": "sample string 1", "TaskId": "56d4d616-5753-468c-a52a-08094cb39680", "Values": [ { "FormFieldValueId": "34a21eea-d7dc-41ff-96d3-3b97dd2efd17", "FormTypeField": { "FormTypeFieldId": "b82c53a1-e1df-407c-bf19-f91974aaba3f", "Section": { "FormTypeSectionId": "4515807c-0ad2-4c81-a44c-0de20d60c5e6", "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": "eb946ec1-11a1-4b6d-ae84-22bdc26267ad", "Name": "sample string 1" }, "Unit": { "UnitId": "ee3354cf-4f0f-4801-ab0a-018b75f4eb09", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1eb7c546-7dd3-44c3-a4b8-06b521e27352", "CreateDate": "2024-04-26T16:13:09.840207-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T16:13:09.840207-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": "34a21eea-d7dc-41ff-96d3-3b97dd2efd17", "FormTypeField": { "FormTypeFieldId": "b82c53a1-e1df-407c-bf19-f91974aaba3f", "Section": { "FormTypeSectionId": "4515807c-0ad2-4c81-a44c-0de20d60c5e6", "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": "eb946ec1-11a1-4b6d-ae84-22bdc26267ad", "Name": "sample string 1" }, "Unit": { "UnitId": "ee3354cf-4f0f-4801-ab0a-018b75f4eb09", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1eb7c546-7dd3-44c3-a4b8-06b521e27352", "CreateDate": "2024-04-26T16:13:09.840207-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T16:13:09.840207-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": "05fe5e82-df3f-444e-bc6f-5ba4977587a2", "CreateDate": "2024-04-26T16:13:09.840207-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-26T16:13:09.840207-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }