PUT FormTypes
Updates the given form type.
Request Information
URI Parameters
None.
Body Parameters
Form type to update
FormTypeName | Description | Type | Additional information |
---|---|---|---|
FormTypeId | globally unique identifier |
None. |
|
Name | string |
None. |
|
Description | string |
None. |
|
AssetType | AssetType |
None. |
|
FrequencyNeeded | integer |
None. |
|
ValueNeededDate | date |
None. |
|
Fields | Collection of FormTypeField |
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:
{ "FormTypeId": "1fa2b86a-bcd6-4ada-8f7c-31a4dd5049cf", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "0390558b-3511-4a96-9f28-d17639054941", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "d5f0a7e5-61b1-4b03-8a58-d565d466df8f", "CreateDate": "2024-03-27T20:24:03.6741437-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-27T20:24:03.6741437-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-03-27T20:24:03.6741437-07:00", "Fields": [ { "FormTypeFieldId": "0d539676-03f3-4d10-86ee-d6777fd8153d", "Section": { "FormTypeSectionId": "a54ea161-1e7f-4f4d-a3be-224ecaf2a403", "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": "8aa5a5f9-0d90-4c90-8ce4-c97999bf8132", "Name": "sample string 1" }, "Unit": { "UnitId": "758de777-2d2c-4891-81e4-e28439a9c944", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0cc406f8-e159-4a86-aece-25388ef1c932", "CreateDate": "2024-03-27T20:24:03.6741437-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-27T20:24:03.6741437-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": "0d539676-03f3-4d10-86ee-d6777fd8153d", "Section": { "FormTypeSectionId": "a54ea161-1e7f-4f4d-a3be-224ecaf2a403", "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": "8aa5a5f9-0d90-4c90-8ce4-c97999bf8132", "Name": "sample string 1" }, "Unit": { "UnitId": "758de777-2d2c-4891-81e4-e28439a9c944", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0cc406f8-e159-4a86-aece-25388ef1c932", "CreateDate": "2024-03-27T20:24:03.6741437-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-27T20:24:03.6741437-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": "166df70e-6e7f-431a-bf20-ede39cd058bc", "CreateDate": "2024-03-27T20:24:03.6741437-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-27T20:24:03.6741437-07:00", "LastModifiedUser": "sample string 6" }
Response Information
Resource Description
On success, the updated form type.
Name | Description | Type | Additional information |
---|---|---|---|
Data | FormType |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "FormTypeId": "86998606-b9cf-4035-9cfc-3229ea02105a", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "9d925c98-72fd-40cf-99ad-c4a9d5ad0a39", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "054882e8-4dc2-4bb7-8b20-2aedb5082408", "CreateDate": "2024-03-27T20:24:03.6741437-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-27T20:24:03.6741437-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-03-27T20:24:03.6741437-07:00", "Fields": [ { "FormTypeFieldId": "b8c0b778-cd72-429a-89d7-9d76f206143a", "Section": { "FormTypeSectionId": "495dc954-a970-45d2-a38e-9ac4115e00df", "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": "8fe504fe-3607-4a9b-af1f-c568448a6ac6", "Name": "sample string 1" }, "Unit": { "UnitId": "841c8fbc-191f-4792-908d-aabd9fc9fdaf", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c2515152-2ca2-491d-b055-ef18811a0107", "CreateDate": "2024-03-27T20:24:03.6741437-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-27T20:24:03.6741437-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": "b8c0b778-cd72-429a-89d7-9d76f206143a", "Section": { "FormTypeSectionId": "495dc954-a970-45d2-a38e-9ac4115e00df", "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": "8fe504fe-3607-4a9b-af1f-c568448a6ac6", "Name": "sample string 1" }, "Unit": { "UnitId": "841c8fbc-191f-4792-908d-aabd9fc9fdaf", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "c2515152-2ca2-491d-b055-ef18811a0107", "CreateDate": "2024-03-27T20:24:03.6741437-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-27T20:24:03.6741437-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": "9df2b81b-3d27-4fc2-9952-a6274854a359", "CreateDate": "2024-03-27T20:24:03.6741437-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-27T20:24:03.6741437-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }