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.
FormType| Name | 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": "422b8b86-2694-4254-aa7f-926293f82d5e",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "8e07122c-8080-47a2-afb5-4ef1574dd7e5",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "0da88230-cf5b-45b7-8678-3a138bdcd141",
"CreateDate": "2026-11-21T11:57:05.2499737-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:05.2499737-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-21T11:57:05.2499737-08:00",
"Fields": [
{
"FormTypeFieldId": "95fb3e90-ec81-4355-8382-2cd46fe3b0e5",
"Section": {
"FormTypeSectionId": "6669063f-8717-4300-b8c9-797ab7b5e1fc",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "be42bf7d-6e3b-4f2c-ae81-c397d505cb30",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9dd41a06-6049-4bb7-bee2-d9f3707b30c0",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2c444889-6564-447c-a595-1882d9268dd5",
"CreateDate": "2026-11-21T11:57:05.2499737-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:05.2499737-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "8f71f57f-818b-4337-a569-6754c29828de",
"FieldId": "76398564-f67b-4f9b-a5ee-6cd49771aa49",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "8f71f57f-818b-4337-a569-6754c29828de",
"FieldId": "76398564-f67b-4f9b-a5ee-6cd49771aa49",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
},
{
"FormTypeFieldId": "95fb3e90-ec81-4355-8382-2cd46fe3b0e5",
"Section": {
"FormTypeSectionId": "6669063f-8717-4300-b8c9-797ab7b5e1fc",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "be42bf7d-6e3b-4f2c-ae81-c397d505cb30",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "9dd41a06-6049-4bb7-bee2-d9f3707b30c0",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2c444889-6564-447c-a595-1882d9268dd5",
"CreateDate": "2026-11-21T11:57:05.2499737-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:05.2499737-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "8f71f57f-818b-4337-a569-6754c29828de",
"FieldId": "76398564-f67b-4f9b-a5ee-6cd49771aa49",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "8f71f57f-818b-4337-a569-6754c29828de",
"FieldId": "76398564-f67b-4f9b-a5ee-6cd49771aa49",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "486f1421-0fc2-40a6-a552-fc6cc9df0221",
"CreateDate": "2026-11-21T11:57:05.2499737-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:05.2499737-08: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": "630afe45-1391-48a6-a9ae-e189037a812c",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "5ee86d4f-e6dc-453d-8d82-752122ba1088",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "ea6da1f9-b53e-40da-8a84-30d2b4750379",
"CreateDate": "2026-11-21T11:57:05.2499737-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-21T11:57:05.2499737-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-21T11:57:05.2499737-08:00",
"Fields": [
{
"FormTypeFieldId": "9dfaa5de-4d64-4ec7-aae9-747d4c340d7f",
"Section": {
"FormTypeSectionId": "2e9101f6-97fb-43f4-8977-53e643680591",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "b5453651-46ed-4612-a4e7-d70399785332",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4a1e6b2c-80ad-485c-8c44-39ce6f6b05bf",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "45e16183-d6ff-451c-a25c-66d98e231512",
"CreateDate": "2026-11-21T11:57:05.2499737-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:05.2499737-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d95d6598-221e-4c9a-9528-1eb094062b8b",
"FieldId": "ea0cbfad-b334-46c0-aa03-39645bee72b6",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d95d6598-221e-4c9a-9528-1eb094062b8b",
"FieldId": "ea0cbfad-b334-46c0-aa03-39645bee72b6",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
},
{
"FormTypeFieldId": "9dfaa5de-4d64-4ec7-aae9-747d4c340d7f",
"Section": {
"FormTypeSectionId": "2e9101f6-97fb-43f4-8977-53e643680591",
"Name": "sample string 1",
"Label": "sample string 2",
"DisplayOrder": 1,
"IsRepeatable": true,
"VisibleExpression": "sample string 4",
"EnabledExpression": "sample string 5",
"SourceSystemId": "sample string 6"
},
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "b5453651-46ed-4612-a4e7-d70399785332",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "4a1e6b2c-80ad-485c-8c44-39ce6f6b05bf",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "45e16183-d6ff-451c-a25c-66d98e231512",
"CreateDate": "2026-11-21T11:57:05.2499737-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:05.2499737-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "d95d6598-221e-4c9a-9528-1eb094062b8b",
"FieldId": "ea0cbfad-b334-46c0-aa03-39645bee72b6",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "d95d6598-221e-4c9a-9528-1eb094062b8b",
"FieldId": "ea0cbfad-b334-46c0-aa03-39645bee72b6",
"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",
"EnabledExpression": "sample string 13",
"SourceSystemId": "sample string 14"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "7f827b61-2a0f-41da-b0dc-41466abf68db",
"CreateDate": "2026-11-21T11:57:05.2499737-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-21T11:57:05.2499737-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}