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": "2fcd9e9f-358a-4f22-8a02-1621d304b9c7", "Asset": { "AssetId": "e5a57c26-e340-4069-93c2-39161c767a36", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "11d1b5ae-dc9d-4c95-9a15-35cceaa86c5d", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "52c3dc17-43b6-4fa1-ade4-68d1cfd5d031", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T03:01:44.20959-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "f7a1bfa1-2a6b-4457-bb49-29856495d562", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-10-10T03:01:44.20959-07:00", "MeasurementValueNeededDate": "2024-10-10T03:01:44.20959-07:00", "SourceSystemId": "sample string 3", "CompanyId": "83b295e7-f13f-4061-a415-aa3cda0f4139", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:01:44.20959-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-10-10T03:01:44.20959-07:00", "MeasurementValueNeededDate": "2024-10-10T03:01:44.20959-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "59002c9f-1943-44b7-a0f0-748c72faa8fe", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-10-10T03:01:44.20959-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "c08d048f-0bd6-49d9-9c46-18ad0f20d464", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "11d1b5ae-dc9d-4c95-9a15-35cceaa86c5d", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "52c3dc17-43b6-4fa1-ade4-68d1cfd5d031", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T03:01:44.20959-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-10-10T03:01:44.20959-07:00", "Fields": [ { "FormTypeFieldId": "c7191c92-5490-4d69-9992-80b66d0fb7d0", "Section": { "FormTypeSectionId": "596846cd-da77-492a-b15b-24a4518f4d0c", "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": "6c51d04f-049d-4788-9dfb-f27d9a6ee16d", "Name": "sample string 1" }, "Unit": { "UnitId": "df2a292d-832f-4718-9501-f013bf32753c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "50a5448d-9530-4d6a-90da-a8a8d2428033", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:01:44.20959-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": "c7191c92-5490-4d69-9992-80b66d0fb7d0", "Section": { "FormTypeSectionId": "596846cd-da77-492a-b15b-24a4518f4d0c", "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": "6c51d04f-049d-4788-9dfb-f27d9a6ee16d", "Name": "sample string 1" }, "Unit": { "UnitId": "df2a292d-832f-4718-9501-f013bf32753c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "50a5448d-9530-4d6a-90da-a8a8d2428033", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:01:44.20959-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": "7389fd7a-fdb4-4929-b395-711020c664e3", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:01:44.20959-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-10-10T03:01:44.20959-07:00", "Location": "sample string 1", "TaskId": "9a2e94b8-913e-42a4-b319-c8e0eb955e43", "Values": [ { "FormFieldValueId": "130e4c6e-1dd8-499f-b658-3780d9f66276", "FormTypeField": { "FormTypeFieldId": "c7191c92-5490-4d69-9992-80b66d0fb7d0", "Section": { "FormTypeSectionId": "596846cd-da77-492a-b15b-24a4518f4d0c", "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": "6c51d04f-049d-4788-9dfb-f27d9a6ee16d", "Name": "sample string 1" }, "Unit": { "UnitId": "df2a292d-832f-4718-9501-f013bf32753c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "50a5448d-9530-4d6a-90da-a8a8d2428033", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:01:44.20959-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": "130e4c6e-1dd8-499f-b658-3780d9f66276", "FormTypeField": { "FormTypeFieldId": "c7191c92-5490-4d69-9992-80b66d0fb7d0", "Section": { "FormTypeSectionId": "596846cd-da77-492a-b15b-24a4518f4d0c", "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": "6c51d04f-049d-4788-9dfb-f27d9a6ee16d", "Name": "sample string 1" }, "Unit": { "UnitId": "df2a292d-832f-4718-9501-f013bf32753c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "50a5448d-9530-4d6a-90da-a8a8d2428033", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:01:44.20959-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": "969223ae-7ae3-46a7-9842-8983107d3f10", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-10-10T03:01:44.20959-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": "8177f79e-543d-4983-8451-6220319713f3", "Asset": { "AssetId": "aebd5db6-cca8-4ecc-aec2-1fde60951703", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "0c76e3ce-0f4b-458c-b0c1-7c7f96ce2c78", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f9641cea-b446-4888-9934-6ea594b085df", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T03:01:44.20959-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "c5a69e67-1a16-45c8-ba7f-81e4b9d52e01", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-10-10T03:01:44.20959-07:00", "MeasurementValueNeededDate": "2024-10-10T03:01:44.20959-07:00", "SourceSystemId": "sample string 3", "CompanyId": "f3b96102-3412-4bb3-8d68-12a5e999fa9e", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:01:44.20959-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-10-10T03:01:44.20959-07:00", "MeasurementValueNeededDate": "2024-10-10T03:01:44.20959-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "24b61736-e155-46bf-b3a1-d750a7a1bcb2", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-10-10T03:01:44.20959-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "2e51ac03-55b3-4340-88e5-305b5e468d19", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "0c76e3ce-0f4b-458c-b0c1-7c7f96ce2c78", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f9641cea-b446-4888-9934-6ea594b085df", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T03:01:44.20959-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-10-10T03:01:44.20959-07:00", "Fields": [ { "FormTypeFieldId": "cf1860ce-f99b-4d58-97d4-89e65086d9ec", "Section": { "FormTypeSectionId": "e68c0f2c-c05b-45a8-b059-6940edeb2c05", "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": "1d08b7ac-41dd-4581-8fd7-b42b8937fcd8", "Name": "sample string 1" }, "Unit": { "UnitId": "2473ab05-3b7b-4ceb-b022-0bb562974676", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "03045ae2-5e41-40ac-b851-eb346d5f7894", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:01:44.20959-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": "cf1860ce-f99b-4d58-97d4-89e65086d9ec", "Section": { "FormTypeSectionId": "e68c0f2c-c05b-45a8-b059-6940edeb2c05", "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": "1d08b7ac-41dd-4581-8fd7-b42b8937fcd8", "Name": "sample string 1" }, "Unit": { "UnitId": "2473ab05-3b7b-4ceb-b022-0bb562974676", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "03045ae2-5e41-40ac-b851-eb346d5f7894", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:01:44.20959-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": "8cd5387f-ad9b-44c4-b83c-1382bf3722bd", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:01:44.20959-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-10-10T03:01:44.20959-07:00", "Location": "sample string 1", "TaskId": "9499da20-804e-410d-8cc4-b19c7b3acbee", "Values": [ { "FormFieldValueId": "cbf0b7ea-87af-420e-8569-bcfebf9583c2", "FormTypeField": { "FormTypeFieldId": "cf1860ce-f99b-4d58-97d4-89e65086d9ec", "Section": { "FormTypeSectionId": "e68c0f2c-c05b-45a8-b059-6940edeb2c05", "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": "1d08b7ac-41dd-4581-8fd7-b42b8937fcd8", "Name": "sample string 1" }, "Unit": { "UnitId": "2473ab05-3b7b-4ceb-b022-0bb562974676", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "03045ae2-5e41-40ac-b851-eb346d5f7894", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:01:44.20959-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": "cbf0b7ea-87af-420e-8569-bcfebf9583c2", "FormTypeField": { "FormTypeFieldId": "cf1860ce-f99b-4d58-97d4-89e65086d9ec", "Section": { "FormTypeSectionId": "e68c0f2c-c05b-45a8-b059-6940edeb2c05", "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": "1d08b7ac-41dd-4581-8fd7-b42b8937fcd8", "Name": "sample string 1" }, "Unit": { "UnitId": "2473ab05-3b7b-4ceb-b022-0bb562974676", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "03045ae2-5e41-40ac-b851-eb346d5f7894", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:01:44.20959-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": "33bac502-b9fa-4840-91ea-27ffc2e30e61", "CreateDate": "2024-10-10T03:01:44.20959-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-10-10T03:01:44.20959-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }