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": "6599ce66-79a7-4f03-b575-ee25d9e27b38", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "d3e17240-0bff-4af1-9275-1377d56ee18b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "54f51936-4a13-4394-9e68-2197c5197e10", "CreateDate": "2025-10-13T15:17:44.1359219-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:17:44.1359219-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-13T15:17:44.1359219-07:00", "Fields": [ { "FormTypeFieldId": "9ffeab8f-2877-49fe-b106-ef7ee86a5d42", "Section": { "FormTypeSectionId": "130b21a6-c52a-4ac2-927a-34d95eb8abdc", "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": "447f46a9-b82d-4b3a-b904-2a831db2b6f7", "Name": "sample string 1" }, "Unit": { "UnitId": "31211d03-b1c4-4368-be1b-4c21d6bcfa48", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "91ae9383-bf1a-4327-be2b-558aeb6d35bb", "CreateDate": "2025-10-13T15:17:44.1359219-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:17:44.1359219-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "cf8d0fed-7577-471f-a591-524110a91db4", "FieldId": "31ae9a55-ebcf-4736-8dfd-8053b19107bb", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "cf8d0fed-7577-471f-a591-524110a91db4", "FieldId": "31ae9a55-ebcf-4736-8dfd-8053b19107bb", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "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": "9ffeab8f-2877-49fe-b106-ef7ee86a5d42", "Section": { "FormTypeSectionId": "130b21a6-c52a-4ac2-927a-34d95eb8abdc", "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": "447f46a9-b82d-4b3a-b904-2a831db2b6f7", "Name": "sample string 1" }, "Unit": { "UnitId": "31211d03-b1c4-4368-be1b-4c21d6bcfa48", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "91ae9383-bf1a-4327-be2b-558aeb6d35bb", "CreateDate": "2025-10-13T15:17:44.1359219-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:17:44.1359219-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "cf8d0fed-7577-471f-a591-524110a91db4", "FieldId": "31ae9a55-ebcf-4736-8dfd-8053b19107bb", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "cf8d0fed-7577-471f-a591-524110a91db4", "FieldId": "31ae9a55-ebcf-4736-8dfd-8053b19107bb", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "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": "7d1078b9-2c89-4179-8d9e-9b00a1e55bf2", "CreateDate": "2025-10-13T15:17:44.1359219-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:17:44.1359219-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": "91cd8cc4-2c1d-4227-a9ef-0fb4636b04e3", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "704ec9d8-0e86-41e9-bc53-e4163d97703f", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "d65290aa-b338-446d-ae3d-0b58c6c246be", "CreateDate": "2025-10-13T15:17:44.1359219-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:17:44.1359219-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-13T15:17:44.1359219-07:00", "Fields": [ { "FormTypeFieldId": "bc9d1d12-3753-440d-80a4-2688bb53f320", "Section": { "FormTypeSectionId": "27d458b5-2fda-4954-af48-1f149b89c069", "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": "bf538d43-e0c4-4cef-b08f-d00d8c72acb1", "Name": "sample string 1" }, "Unit": { "UnitId": "f168bcf9-c78a-41ee-99c5-0374a7bf9070", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "7360f831-dce2-4bea-8398-efada77f1a7e", "CreateDate": "2025-10-13T15:17:44.1359219-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:17:44.1359219-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "3353daac-efb1-4d0e-b7d0-2b26a0b1b0ea", "FieldId": "f0c99ab8-aa46-432d-988c-49e065a2d82c", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "3353daac-efb1-4d0e-b7d0-2b26a0b1b0ea", "FieldId": "f0c99ab8-aa46-432d-988c-49e065a2d82c", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "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": "bc9d1d12-3753-440d-80a4-2688bb53f320", "Section": { "FormTypeSectionId": "27d458b5-2fda-4954-af48-1f149b89c069", "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": "bf538d43-e0c4-4cef-b08f-d00d8c72acb1", "Name": "sample string 1" }, "Unit": { "UnitId": "f168bcf9-c78a-41ee-99c5-0374a7bf9070", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "7360f831-dce2-4bea-8398-efada77f1a7e", "CreateDate": "2025-10-13T15:17:44.1359219-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:17:44.1359219-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "3353daac-efb1-4d0e-b7d0-2b26a0b1b0ea", "FieldId": "f0c99ab8-aa46-432d-988c-49e065a2d82c", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "3353daac-efb1-4d0e-b7d0-2b26a0b1b0ea", "FieldId": "f0c99ab8-aa46-432d-988c-49e065a2d82c", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "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": "7a847acf-ce7b-4a46-ad25-aa2216460143", "CreateDate": "2025-10-13T15:17:44.1359219-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:17:44.1359219-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }