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. |
|
WellKnownText | string |
None. |
|
Values | Collection of FormFieldValue |
None. |
|
SourceSystemId | string |
None. |
|
CompanyId | globally unique identifier |
None. |
|
CreateDate | date |
None. |
|
CreateUser | string |
None. |
|
CreateMachine | string |
None. |
|
LastModifiedDate | date |
None. |
|
LastModifiedUser | string |
None. |
|
LastModifiedMachine | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "FormId": "6b49d882-edd4-491a-8164-827a0cf05319", "Asset": { "AssetId": "a780742e-79df-4286-b201-2d9ea9674a9e", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "fa438150-8cae-4314-ae01-c9e68395faae", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "83f51d14-5950-4b22-a3ed-839f6b8d5b11", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 6", "CreateMachine": "sample string 7", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 8", "LastModifiedMachine": "sample string 9" }, "AssetGroup": { "AssetGroupId": "4bc82e00-32e9-4e6a-a446-ffbe46db85fe", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2021-04-17T07:33:23.3075782-07:00", "MeasurementValueNeededDate": "2021-04-17T07:33:23.3075782-07:00", "SourceSystemId": "sample string 3", "CompanyId": "f06d6d9a-1c9b-43ac-89f8-b2ed0b66707d", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 5", "CreateMachine": "sample string 6", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 7", "LastModifiedMachine": "sample string 8" }, "ParentAsset": null, "WellKnownText": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2021-04-17T07:33:23.3075782-07:00", "MeasurementValueNeededDate": "2021-04-17T07:33:23.3075782-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "3b6f6006-fa6c-4e57-825f-0bc547ff9569", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 7", "CreateMachine": "sample string 8", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 9", "LastModifiedMachine": "sample string 10" }, "FormType": { "FormTypeId": "66e364b4-7d6a-4dcc-95fa-b02500446fcd", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "fa438150-8cae-4314-ae01-c9e68395faae", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "83f51d14-5950-4b22-a3ed-839f6b8d5b11", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 6", "CreateMachine": "sample string 7", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 8", "LastModifiedMachine": "sample string 9" }, "FrequencyNeeded": 1, "ValueNeededDate": "2021-04-17T07:33:23.3075782-07:00", "Fields": [ { "FormTypeFieldId": "43798eb3-c401-4c82-b53d-a4c0e6d82de0", "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "deac2bf3-c6e1-4274-99bb-53a7ddffd249", "Name": "sample string 1" }, "Unit": { "UnitId": "594f9e7b-e1dc-4a88-8f1a-572b23f16bf5", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "753f73f3-8fd8-4236-935b-8b8fe31ba474", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 5", "CreateMachine": "sample string 6", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 7", "LastModifiedMachine": "sample string 8" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "Expression": "sample string 5", "IsRequired": true, "IsAttachment": true, "DefaultValue": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "SourceSystemId": "sample string 11" }, { "FormTypeFieldId": "43798eb3-c401-4c82-b53d-a4c0e6d82de0", "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "deac2bf3-c6e1-4274-99bb-53a7ddffd249", "Name": "sample string 1" }, "Unit": { "UnitId": "594f9e7b-e1dc-4a88-8f1a-572b23f16bf5", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "753f73f3-8fd8-4236-935b-8b8fe31ba474", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 5", "CreateMachine": "sample string 6", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 7", "LastModifiedMachine": "sample string 8" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "Expression": "sample string 5", "IsRequired": true, "IsAttachment": true, "DefaultValue": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "SourceSystemId": "sample string 11" } ], "SourceSystemId": "sample string 3", "CompanyId": "8f241323-440c-41ff-8030-1780f2cb44e0", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 5", "CreateMachine": "sample string 6", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 7", "LastModifiedMachine": "sample string 8" }, "EffectiveDate": "2021-04-17T07:33:23.3075782-07:00", "WellKnownText": "sample string 1", "Values": [ { "FormFieldValueId": "2b13d42a-287e-4110-a988-fd535409538a", "FormTypeField": { "FormTypeFieldId": "43798eb3-c401-4c82-b53d-a4c0e6d82de0", "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "deac2bf3-c6e1-4274-99bb-53a7ddffd249", "Name": "sample string 1" }, "Unit": { "UnitId": "594f9e7b-e1dc-4a88-8f1a-572b23f16bf5", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "753f73f3-8fd8-4236-935b-8b8fe31ba474", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 5", "CreateMachine": "sample string 6", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 7", "LastModifiedMachine": "sample string 8" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "Expression": "sample string 5", "IsRequired": true, "IsAttachment": true, "DefaultValue": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "SourceSystemId": "sample string 11" }, "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": "2b13d42a-287e-4110-a988-fd535409538a", "FormTypeField": { "FormTypeFieldId": "43798eb3-c401-4c82-b53d-a4c0e6d82de0", "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "deac2bf3-c6e1-4274-99bb-53a7ddffd249", "Name": "sample string 1" }, "Unit": { "UnitId": "594f9e7b-e1dc-4a88-8f1a-572b23f16bf5", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "753f73f3-8fd8-4236-935b-8b8fe31ba474", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 5", "CreateMachine": "sample string 6", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 7", "LastModifiedMachine": "sample string 8" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "Expression": "sample string 5", "IsRequired": true, "IsAttachment": true, "DefaultValue": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "SourceSystemId": "sample string 11" }, "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": "5bc78465-5d3e-468d-a46b-3ea7cf8be7ed", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 4", "CreateMachine": "sample string 5", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 6", "LastModifiedMachine": "sample string 7" }
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": "a6158f04-ab7f-431c-b2b8-1b37851c2095", "Asset": { "AssetId": "1d78a371-252e-4cf6-8050-a4f6154e42f3", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "af7af4d1-6a28-42a5-bee3-1dd135f0a6a8", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7d227e60-9ff9-4ea2-b445-61d727d2fd91", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 6", "CreateMachine": "sample string 7", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 8", "LastModifiedMachine": "sample string 9" }, "AssetGroup": { "AssetGroupId": "b7c1eaef-c22e-4f5d-b1d2-659160d872f9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2021-04-17T07:33:23.3075782-07:00", "MeasurementValueNeededDate": "2021-04-17T07:33:23.3075782-07:00", "SourceSystemId": "sample string 3", "CompanyId": "02dc4131-bb32-4e0e-86db-f87890cb2483", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 5", "CreateMachine": "sample string 6", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 7", "LastModifiedMachine": "sample string 8" }, "ParentAsset": null, "WellKnownText": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2021-04-17T07:33:23.3075782-07:00", "MeasurementValueNeededDate": "2021-04-17T07:33:23.3075782-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "06a1f1b2-2082-44ca-8915-d1887b5c57f1", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 7", "CreateMachine": "sample string 8", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 9", "LastModifiedMachine": "sample string 10" }, "FormType": { "FormTypeId": "65af0921-17e0-4ba4-8a6a-3806a14d53b0", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "af7af4d1-6a28-42a5-bee3-1dd135f0a6a8", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "7d227e60-9ff9-4ea2-b445-61d727d2fd91", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 6", "CreateMachine": "sample string 7", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 8", "LastModifiedMachine": "sample string 9" }, "FrequencyNeeded": 1, "ValueNeededDate": "2021-04-17T07:33:23.3075782-07:00", "Fields": [ { "FormTypeFieldId": "865462e6-5467-4060-9a1e-6e4f6fa4732b", "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "f8f4e1bf-97f6-4e5d-b509-5212df13c375", "Name": "sample string 1" }, "Unit": { "UnitId": "2996eb8b-890c-4730-a8dc-ecb03733f8ad", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "5dc29082-760e-4505-bcf8-0607f20d564d", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 5", "CreateMachine": "sample string 6", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 7", "LastModifiedMachine": "sample string 8" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "Expression": "sample string 5", "IsRequired": true, "IsAttachment": true, "DefaultValue": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "SourceSystemId": "sample string 11" }, { "FormTypeFieldId": "865462e6-5467-4060-9a1e-6e4f6fa4732b", "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "f8f4e1bf-97f6-4e5d-b509-5212df13c375", "Name": "sample string 1" }, "Unit": { "UnitId": "2996eb8b-890c-4730-a8dc-ecb03733f8ad", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "5dc29082-760e-4505-bcf8-0607f20d564d", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 5", "CreateMachine": "sample string 6", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 7", "LastModifiedMachine": "sample string 8" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "Expression": "sample string 5", "IsRequired": true, "IsAttachment": true, "DefaultValue": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "SourceSystemId": "sample string 11" } ], "SourceSystemId": "sample string 3", "CompanyId": "940b0a7c-660e-4dd9-a895-40caf1be8b02", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 5", "CreateMachine": "sample string 6", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 7", "LastModifiedMachine": "sample string 8" }, "EffectiveDate": "2021-04-17T07:33:23.3075782-07:00", "WellKnownText": "sample string 1", "Values": [ { "FormFieldValueId": "ee695fc9-8e72-4e8b-b1f3-eaf37fda31b5", "FormTypeField": { "FormTypeFieldId": "865462e6-5467-4060-9a1e-6e4f6fa4732b", "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "f8f4e1bf-97f6-4e5d-b509-5212df13c375", "Name": "sample string 1" }, "Unit": { "UnitId": "2996eb8b-890c-4730-a8dc-ecb03733f8ad", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "5dc29082-760e-4505-bcf8-0607f20d564d", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 5", "CreateMachine": "sample string 6", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 7", "LastModifiedMachine": "sample string 8" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "Expression": "sample string 5", "IsRequired": true, "IsAttachment": true, "DefaultValue": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "SourceSystemId": "sample string 11" }, "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": "ee695fc9-8e72-4e8b-b1f3-eaf37fda31b5", "FormTypeField": { "FormTypeFieldId": "865462e6-5467-4060-9a1e-6e4f6fa4732b", "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "f8f4e1bf-97f6-4e5d-b509-5212df13c375", "Name": "sample string 1" }, "Unit": { "UnitId": "2996eb8b-890c-4730-a8dc-ecb03733f8ad", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "5dc29082-760e-4505-bcf8-0607f20d564d", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 5", "CreateMachine": "sample string 6", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 7", "LastModifiedMachine": "sample string 8" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "Expression": "sample string 5", "IsRequired": true, "IsAttachment": true, "DefaultValue": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "SourceSystemId": "sample string 11" }, "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": "82a496a2-7396-450c-8299-5a0f44f1a706", "CreateDate": "2021-04-17T07:33:23.3075782-07:00", "CreateUser": "sample string 4", "CreateMachine": "sample string 5", "LastModifiedDate": "2021-04-17T07:33:23.3075782-07:00", "LastModifiedUser": "sample string 6", "LastModifiedMachine": "sample string 7" }, "Total": 1, "Message": "sample string 1" }