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": "591556ed-da95-46f3-9097-7d76d30bfed8", "Asset": { "AssetId": "e93784d2-190a-4e78-8771-5d9c14b0eb69", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "4605127d-054e-4118-91ac-a0e567e0a042", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "349539c2-11ec-4478-9710-d0bee2d25525", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-26T13:34:17.7018214-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "1948a09b-fa22-462c-a203-7b3e3027c35a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-26T13:34:17.7018214-07:00", "MeasurementValueNeededDate": "2024-04-26T13:34:17.7018214-07:00", "SourceSystemId": "sample string 3", "CompanyId": "b4a518d9-a719-45b4-b30b-bd58daf3e352", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T13:34:17.7018214-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-04-26T13:34:17.7018214-07:00", "MeasurementValueNeededDate": "2024-04-26T13:34:17.7018214-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "11cfd531-beb5-41f7-a3b4-5394b4029ed0", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T13:34:17.7018214-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "5b8ec851-214b-4c49-9296-eeb1136daacf", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "4605127d-054e-4118-91ac-a0e567e0a042", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "349539c2-11ec-4478-9710-d0bee2d25525", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-26T13:34:17.7018214-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-26T13:34:17.7018214-07:00", "Fields": [ { "FormTypeFieldId": "ac02084d-7f20-4209-8794-d324c71a0b6a", "Section": { "FormTypeSectionId": "760b4fb8-6378-4bd5-9d18-6214922fd501", "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": "dee9f4b6-ad8d-4e22-a069-996a4eba958f", "Name": "sample string 1" }, "Unit": { "UnitId": "5b37bc75-a9e5-45d8-bb0e-2df6b2e3ba20", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "01ad5ddb-4a2f-49b7-a6fd-bcf3ef78d2be", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T13:34:17.7018214-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": "ac02084d-7f20-4209-8794-d324c71a0b6a", "Section": { "FormTypeSectionId": "760b4fb8-6378-4bd5-9d18-6214922fd501", "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": "dee9f4b6-ad8d-4e22-a069-996a4eba958f", "Name": "sample string 1" }, "Unit": { "UnitId": "5b37bc75-a9e5-45d8-bb0e-2df6b2e3ba20", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "01ad5ddb-4a2f-49b7-a6fd-bcf3ef78d2be", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T13:34:17.7018214-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": "29d5ff98-0d0b-4dd4-8030-9a1129108e27", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T13:34:17.7018214-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-04-26T13:34:17.7018214-07:00", "Location": "sample string 1", "TaskId": "13d99267-e729-4840-ac31-f3292c85cdfe", "Values": [ { "FormFieldValueId": "7bd7ad1e-b89a-4cfb-8d0e-3596388d6e39", "FormTypeField": { "FormTypeFieldId": "ac02084d-7f20-4209-8794-d324c71a0b6a", "Section": { "FormTypeSectionId": "760b4fb8-6378-4bd5-9d18-6214922fd501", "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": "dee9f4b6-ad8d-4e22-a069-996a4eba958f", "Name": "sample string 1" }, "Unit": { "UnitId": "5b37bc75-a9e5-45d8-bb0e-2df6b2e3ba20", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "01ad5ddb-4a2f-49b7-a6fd-bcf3ef78d2be", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T13:34:17.7018214-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": "7bd7ad1e-b89a-4cfb-8d0e-3596388d6e39", "FormTypeField": { "FormTypeFieldId": "ac02084d-7f20-4209-8794-d324c71a0b6a", "Section": { "FormTypeSectionId": "760b4fb8-6378-4bd5-9d18-6214922fd501", "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": "dee9f4b6-ad8d-4e22-a069-996a4eba958f", "Name": "sample string 1" }, "Unit": { "UnitId": "5b37bc75-a9e5-45d8-bb0e-2df6b2e3ba20", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "01ad5ddb-4a2f-49b7-a6fd-bcf3ef78d2be", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T13:34:17.7018214-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": "0cf7e6eb-caf9-4a58-9bae-a09c0afc3736", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-26T13:34:17.7018214-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": "cfc666be-5611-498e-b700-fef31af356a7", "Asset": { "AssetId": "5e727b4b-f27e-4a3e-95e5-99886b226529", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "0f42c35a-6c79-4e59-884f-d81c6fe6076a", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "335293cf-0e13-4e1f-aaee-6c6e59248a0c", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-26T13:34:17.7018214-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "a59dd915-a7e2-467e-9b28-892bf4a6174b", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-04-26T13:34:17.7018214-07:00", "MeasurementValueNeededDate": "2024-04-26T13:34:17.7018214-07:00", "SourceSystemId": "sample string 3", "CompanyId": "9945c7ad-cbb3-40d2-9302-77dac043f90b", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T13:34:17.7018214-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-04-26T13:34:17.7018214-07:00", "MeasurementValueNeededDate": "2024-04-26T13:34:17.7018214-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "7188d6a2-97b3-435b-99e1-94f7385ef5db", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-26T13:34:17.7018214-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "4e0a18da-dc8a-4b3d-96b0-ded6d5416722", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "0f42c35a-6c79-4e59-884f-d81c6fe6076a", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "335293cf-0e13-4e1f-aaee-6c6e59248a0c", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-04-26T13:34:17.7018214-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-26T13:34:17.7018214-07:00", "Fields": [ { "FormTypeFieldId": "16fd2325-d374-4673-8a64-4a652077d900", "Section": { "FormTypeSectionId": "dbdb60d6-5b7e-4243-a580-8100ac341e66", "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": "8c61b713-1844-481a-9796-0c3302b6f4ea", "Name": "sample string 1" }, "Unit": { "UnitId": "1a4d48f6-b7f4-455c-aa62-39ed029b5b84", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3f147d78-932c-4e1e-8a22-43ea33d9a943", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T13:34:17.7018214-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": "16fd2325-d374-4673-8a64-4a652077d900", "Section": { "FormTypeSectionId": "dbdb60d6-5b7e-4243-a580-8100ac341e66", "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": "8c61b713-1844-481a-9796-0c3302b6f4ea", "Name": "sample string 1" }, "Unit": { "UnitId": "1a4d48f6-b7f4-455c-aa62-39ed029b5b84", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3f147d78-932c-4e1e-8a22-43ea33d9a943", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T13:34:17.7018214-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": "98c48939-3226-4ddd-b5dc-03c83bb326b1", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T13:34:17.7018214-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-04-26T13:34:17.7018214-07:00", "Location": "sample string 1", "TaskId": "6e7c6592-ac2c-4371-90bc-84c460c015c1", "Values": [ { "FormFieldValueId": "8a23128e-b080-41bc-bc47-64df27bfc0d4", "FormTypeField": { "FormTypeFieldId": "16fd2325-d374-4673-8a64-4a652077d900", "Section": { "FormTypeSectionId": "dbdb60d6-5b7e-4243-a580-8100ac341e66", "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": "8c61b713-1844-481a-9796-0c3302b6f4ea", "Name": "sample string 1" }, "Unit": { "UnitId": "1a4d48f6-b7f4-455c-aa62-39ed029b5b84", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3f147d78-932c-4e1e-8a22-43ea33d9a943", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T13:34:17.7018214-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": "8a23128e-b080-41bc-bc47-64df27bfc0d4", "FormTypeField": { "FormTypeFieldId": "16fd2325-d374-4673-8a64-4a652077d900", "Section": { "FormTypeSectionId": "dbdb60d6-5b7e-4243-a580-8100ac341e66", "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": "8c61b713-1844-481a-9796-0c3302b6f4ea", "Name": "sample string 1" }, "Unit": { "UnitId": "1a4d48f6-b7f4-455c-aa62-39ed029b5b84", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3f147d78-932c-4e1e-8a22-43ea33d9a943", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-26T13:34:17.7018214-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": "2c67ed89-d63a-4cfd-9024-7885c8a15987", "CreateDate": "2024-04-26T13:34:17.7018214-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-04-26T13:34:17.7018214-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }