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": "57a6372b-2e31-404c-96bd-180626c780c3", "Asset": { "AssetId": "cd55e76c-a49a-4ba1-9dc9-5c9ce7399b49", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "3d32b21d-1def-45bd-b8b7-6e50566e8c78", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "8acac144-c98b-4f5d-a26f-57a557468571", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T13:19:23.6220633-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "d41a4742-902c-4782-bf8b-24dc4ae22c44", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T13:19:23.6220633-07:00", "MeasurementValueNeededDate": "2025-06-30T13:19:23.6220633-07:00", "SourceSystemId": "sample string 3", "CompanyId": "dcc86d31-3e43-4a79-b40d-bd49a2980529", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:19:23.6220633-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-30T13:19:23.6220633-07:00", "MeasurementValueNeededDate": "2025-06-30T13:19:23.6220633-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d423264f-2a10-4e51-bdf5-78c94bdf2896", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-30T13:19:23.6220633-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "a3f248eb-c3c0-4702-a4ce-37fd49e6dc8f", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "3d32b21d-1def-45bd-b8b7-6e50566e8c78", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "8acac144-c98b-4f5d-a26f-57a557468571", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T13:19:23.6220633-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-30T13:19:23.6220633-07:00", "Fields": [ { "FormTypeFieldId": "95c6ad96-1997-4adf-90dc-caf22c013446", "Section": { "FormTypeSectionId": "b62cbb4f-6a97-4401-93c3-0c7a29c57d79", "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": "f9e59e88-b9d7-4907-a7ce-6c19b3da185f", "Name": "sample string 1" }, "Unit": { "UnitId": "d367f50a-7373-4a39-964d-6f11db47b7c2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "eae614cb-52a7-4cc2-a380-0dd908b28a70", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:19:23.6220633-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": "95c6ad96-1997-4adf-90dc-caf22c013446", "Section": { "FormTypeSectionId": "b62cbb4f-6a97-4401-93c3-0c7a29c57d79", "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": "f9e59e88-b9d7-4907-a7ce-6c19b3da185f", "Name": "sample string 1" }, "Unit": { "UnitId": "d367f50a-7373-4a39-964d-6f11db47b7c2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "eae614cb-52a7-4cc2-a380-0dd908b28a70", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:19:23.6220633-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": "43408a13-0148-4777-a82e-4574fa235489", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:19:23.6220633-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-06-30T13:19:23.6220633-07:00", "Location": "sample string 1", "TaskId": "b4f88bcf-f7df-42fd-b9be-ffd830d5e05e", "Values": [ { "FormFieldValueId": "a43aef58-10ec-4b25-b955-2c805a8f79cb", "FormTypeField": { "FormTypeFieldId": "95c6ad96-1997-4adf-90dc-caf22c013446", "Section": { "FormTypeSectionId": "b62cbb4f-6a97-4401-93c3-0c7a29c57d79", "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": "f9e59e88-b9d7-4907-a7ce-6c19b3da185f", "Name": "sample string 1" }, "Unit": { "UnitId": "d367f50a-7373-4a39-964d-6f11db47b7c2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "eae614cb-52a7-4cc2-a380-0dd908b28a70", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:19:23.6220633-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": "a43aef58-10ec-4b25-b955-2c805a8f79cb", "FormTypeField": { "FormTypeFieldId": "95c6ad96-1997-4adf-90dc-caf22c013446", "Section": { "FormTypeSectionId": "b62cbb4f-6a97-4401-93c3-0c7a29c57d79", "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": "f9e59e88-b9d7-4907-a7ce-6c19b3da185f", "Name": "sample string 1" }, "Unit": { "UnitId": "d367f50a-7373-4a39-964d-6f11db47b7c2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "eae614cb-52a7-4cc2-a380-0dd908b28a70", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:19:23.6220633-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": "9bee9fa3-f683-485f-a2a5-3c23d40aac33", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-30T13:19:23.6220633-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": "6a9ea915-d401-4515-bdd4-2e9abc3b0cfb", "Asset": { "AssetId": "1890113e-bd31-4cad-9f31-3c843fdb731f", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "5a7112fe-375b-4634-b73c-c5ef858f74ce", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a104b021-cff4-4e81-9f40-ed274fdba986", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T13:19:23.6220633-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "43f3e512-72be-424f-b241-dcdd5a32b378", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-30T13:19:23.6220633-07:00", "MeasurementValueNeededDate": "2025-06-30T13:19:23.6220633-07:00", "SourceSystemId": "sample string 3", "CompanyId": "e394e4bd-cbc6-4079-8ccd-2ffeede74262", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:19:23.6220633-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-30T13:19:23.6220633-07:00", "MeasurementValueNeededDate": "2025-06-30T13:19:23.6220633-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "a9c45f72-d7b4-4e47-8849-242d5ac22541", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-30T13:19:23.6220633-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "fe06cae5-92bb-4abf-9a5f-09dba029bf70", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "5a7112fe-375b-4634-b73c-c5ef858f74ce", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a104b021-cff4-4e81-9f40-ed274fdba986", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-30T13:19:23.6220633-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-30T13:19:23.6220633-07:00", "Fields": [ { "FormTypeFieldId": "e2603c6e-af75-432d-8239-c93079617fb7", "Section": { "FormTypeSectionId": "162c2964-bac2-4bfc-9b6f-2fd645e7a9c3", "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": "e2da34fd-5ebf-4caf-ac8e-0bffae8358f5", "Name": "sample string 1" }, "Unit": { "UnitId": "77c1edad-cf77-49cd-9756-5349659f1805", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "143ba35d-27db-4936-b169-2639a3c6d512", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:19:23.6220633-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": "e2603c6e-af75-432d-8239-c93079617fb7", "Section": { "FormTypeSectionId": "162c2964-bac2-4bfc-9b6f-2fd645e7a9c3", "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": "e2da34fd-5ebf-4caf-ac8e-0bffae8358f5", "Name": "sample string 1" }, "Unit": { "UnitId": "77c1edad-cf77-49cd-9756-5349659f1805", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "143ba35d-27db-4936-b169-2639a3c6d512", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:19:23.6220633-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": "21e912ef-1cdd-4cd8-abdc-d92938ea9ebb", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:19:23.6220633-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-06-30T13:19:23.6220633-07:00", "Location": "sample string 1", "TaskId": "8c02297e-ebca-496d-b027-30fbf4aa0199", "Values": [ { "FormFieldValueId": "170df1c3-b830-4557-be25-146efeca2d85", "FormTypeField": { "FormTypeFieldId": "e2603c6e-af75-432d-8239-c93079617fb7", "Section": { "FormTypeSectionId": "162c2964-bac2-4bfc-9b6f-2fd645e7a9c3", "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": "e2da34fd-5ebf-4caf-ac8e-0bffae8358f5", "Name": "sample string 1" }, "Unit": { "UnitId": "77c1edad-cf77-49cd-9756-5349659f1805", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "143ba35d-27db-4936-b169-2639a3c6d512", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:19:23.6220633-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": "170df1c3-b830-4557-be25-146efeca2d85", "FormTypeField": { "FormTypeFieldId": "e2603c6e-af75-432d-8239-c93079617fb7", "Section": { "FormTypeSectionId": "162c2964-bac2-4bfc-9b6f-2fd645e7a9c3", "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": "e2da34fd-5ebf-4caf-ac8e-0bffae8358f5", "Name": "sample string 1" }, "Unit": { "UnitId": "77c1edad-cf77-49cd-9756-5349659f1805", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "143ba35d-27db-4936-b169-2639a3c6d512", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-30T13:19:23.6220633-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": "a6c7d031-bd6a-4be8-ad09-8279a7b49732", "CreateDate": "2025-06-30T13:19:23.6220633-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-30T13:19:23.6220633-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }