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": "d637c768-ac43-44a5-a733-e58082319c0e", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "5fb59b2f-0175-42a7-adaf-ceda467e5fc2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "adb03784-ca0b-4643-8e0a-f5d1288aeed9", "CreateDate": "2024-04-28T12:05:24.8676657-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T12:05:24.8676657-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-28T12:05:24.8676657-07:00", "Fields": [ { "FormTypeFieldId": "d6b89311-f827-4257-9acb-9ea122c71cd0", "Section": { "FormTypeSectionId": "b277a337-8c0e-4b1d-b566-7f82083a045e", "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": "f86628c5-4f24-438f-ba32-976427b1079b", "Name": "sample string 1" }, "Unit": { "UnitId": "a1f30697-dfac-4282-aa54-26ea0106cdf6", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "13dad24b-b56b-4d57-9242-bd9be8284f99", "CreateDate": "2024-04-28T12:05:24.8676657-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T12:05:24.8676657-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": "d6b89311-f827-4257-9acb-9ea122c71cd0", "Section": { "FormTypeSectionId": "b277a337-8c0e-4b1d-b566-7f82083a045e", "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": "f86628c5-4f24-438f-ba32-976427b1079b", "Name": "sample string 1" }, "Unit": { "UnitId": "a1f30697-dfac-4282-aa54-26ea0106cdf6", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "13dad24b-b56b-4d57-9242-bd9be8284f99", "CreateDate": "2024-04-28T12:05:24.8676657-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T12:05:24.8676657-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": "46f3e25b-dff4-45d4-9ce2-9d03c2eba9c2", "CreateDate": "2024-04-28T12:05:24.8676657-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T12:05:24.8676657-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": "e60e464f-997e-4da0-b8eb-6eab6f0ac764", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "67139c1b-b6a0-4599-90b1-ae32d42017fd", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3b87fa46-2669-43ef-9233-14e84c6c88d5", "CreateDate": "2024-04-28T12:05:24.8676657-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T12:05:24.8676657-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-28T12:05:24.8676657-07:00", "Fields": [ { "FormTypeFieldId": "4e956e0c-26b3-44f9-b9cd-85012d96d28f", "Section": { "FormTypeSectionId": "02d818a2-5801-432d-97d0-632b392cbead", "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": "ebb1b294-317b-4b64-a7d5-47a4e353796d", "Name": "sample string 1" }, "Unit": { "UnitId": "3cfef0c9-b517-487a-8672-ae904e3d5cc8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8444c331-c2a4-4166-8241-c773140a0812", "CreateDate": "2024-04-28T12:05:24.8676657-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T12:05:24.8676657-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": "4e956e0c-26b3-44f9-b9cd-85012d96d28f", "Section": { "FormTypeSectionId": "02d818a2-5801-432d-97d0-632b392cbead", "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": "ebb1b294-317b-4b64-a7d5-47a4e353796d", "Name": "sample string 1" }, "Unit": { "UnitId": "3cfef0c9-b517-487a-8672-ae904e3d5cc8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8444c331-c2a4-4166-8241-c773140a0812", "CreateDate": "2024-04-28T12:05:24.8676657-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T12:05:24.8676657-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": "eac1215b-694b-47d1-9e8e-f3c2b167859c", "CreateDate": "2024-04-28T12:05:24.8676657-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T12:05:24.8676657-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }