POST FormTypes
Creates a new form type.
Request Information
URI Parameters
None.
Body Parameters
The form type to create. FormTypeId should not be filled in.
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": "2d7106d4-23b8-47c2-91ee-cd6a6832f555", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "112ca51a-c337-4e97-9fe0-ebcfd2f6365b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3062b208-af37-48cf-9a90-22d07f53e54f", "CreateDate": "2025-07-18T15:52:27.5143885-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-18T15:52:27.5143885-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-18T15:52:27.5143885-07:00", "Fields": [ { "FormTypeFieldId": "d6abbfc5-71b1-4c52-ba21-ca0063c841bc", "Section": { "FormTypeSectionId": "cc6f3e02-8203-4bb8-a9e7-ab80508a2de8", "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": "6a480482-d1ff-4d85-bc30-a6eebb1b35ce", "Name": "sample string 1" }, "Unit": { "UnitId": "9065ef2d-c4ef-4846-9919-e88af2f9db1c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "44f7f630-03e1-4cd9-a5ac-340180dc3e2b", "CreateDate": "2025-07-18T15:52:27.5143885-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T15:52:27.5143885-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "4bef2d96-1c26-4ace-a93d-d9d39022a514", "FieldId": "a20e74a4-18e3-46f3-857b-8116d0e6b248", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "4bef2d96-1c26-4ace-a93d-d9d39022a514", "FieldId": "a20e74a4-18e3-46f3-857b-8116d0e6b248", "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": "d6abbfc5-71b1-4c52-ba21-ca0063c841bc", "Section": { "FormTypeSectionId": "cc6f3e02-8203-4bb8-a9e7-ab80508a2de8", "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": "6a480482-d1ff-4d85-bc30-a6eebb1b35ce", "Name": "sample string 1" }, "Unit": { "UnitId": "9065ef2d-c4ef-4846-9919-e88af2f9db1c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "44f7f630-03e1-4cd9-a5ac-340180dc3e2b", "CreateDate": "2025-07-18T15:52:27.5143885-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T15:52:27.5143885-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "4bef2d96-1c26-4ace-a93d-d9d39022a514", "FieldId": "a20e74a4-18e3-46f3-857b-8116d0e6b248", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "4bef2d96-1c26-4ace-a93d-d9d39022a514", "FieldId": "a20e74a4-18e3-46f3-857b-8116d0e6b248", "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": "c995d2e2-b349-479b-87fa-d29fbb5b1993", "CreateDate": "2025-07-18T15:52:27.5143885-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T15:52:27.5143885-07:00", "LastModifiedUser": "sample string 6" }
Response Information
Resource Description
On success, the created 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": "601f98d0-7752-4970-9abb-98f088dd858a", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "6188e6a9-ad9e-4561-b655-795c34f3f45c", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b2e96887-6252-4649-91e9-76d48d1c4806", "CreateDate": "2025-07-18T15:52:27.5143885-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-18T15:52:27.5143885-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-18T15:52:27.5143885-07:00", "Fields": [ { "FormTypeFieldId": "e17d7203-e955-4260-ae1b-05e79c28ec02", "Section": { "FormTypeSectionId": "9f951e12-60d7-4ccd-a0d0-196293e0cf83", "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": "acf2a9e7-3a68-4bc7-a374-ed470093661b", "Name": "sample string 1" }, "Unit": { "UnitId": "a41ebfd3-34bf-4c7e-b7bd-9d6b54df9735", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "54ce6e02-0bc3-4701-aa78-ea1e200c33c9", "CreateDate": "2025-07-18T15:52:27.5143885-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T15:52:27.5143885-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c01c3fb7-de72-4e8e-a146-a057fee25689", "FieldId": "319d54e9-138b-4e71-90aa-85ca2edba618", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c01c3fb7-de72-4e8e-a146-a057fee25689", "FieldId": "319d54e9-138b-4e71-90aa-85ca2edba618", "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": "e17d7203-e955-4260-ae1b-05e79c28ec02", "Section": { "FormTypeSectionId": "9f951e12-60d7-4ccd-a0d0-196293e0cf83", "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": "acf2a9e7-3a68-4bc7-a374-ed470093661b", "Name": "sample string 1" }, "Unit": { "UnitId": "a41ebfd3-34bf-4c7e-b7bd-9d6b54df9735", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "54ce6e02-0bc3-4701-aa78-ea1e200c33c9", "CreateDate": "2025-07-18T15:52:27.5143885-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T15:52:27.5143885-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c01c3fb7-de72-4e8e-a146-a057fee25689", "FieldId": "319d54e9-138b-4e71-90aa-85ca2edba618", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c01c3fb7-de72-4e8e-a146-a057fee25689", "FieldId": "319d54e9-138b-4e71-90aa-85ca2edba618", "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": "48b44a9a-a623-44ae-a6be-2285ea945e47", "CreateDate": "2025-07-18T15:52:27.5143885-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-18T15:52:27.5143885-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }