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": "4b72cfcc-7b16-496f-b667-88e88f491cba",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "2c09c183-a30f-4425-aec9-f31c80d949d4",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "2d2bf3ae-8871-4989-ae7d-e659b738e552",
"CreateDate": "2026-11-22T13:20:51.0748095-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T13:20:51.0748095-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-22T13:20:51.0748095-08:00",
"Fields": [
{
"FormTypeFieldId": "85c8a52e-d9d2-44d7-b0d7-d7ebf3a98fad",
"Section": {
"FormTypeSectionId": "83faf5fc-b104-4eb5-8e16-c0d86e1e689f",
"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": "c35a964f-d3c5-43cb-9c08-feab1372afc1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f3ed4c9a-54c4-4d17-a51f-d08a2bdbda89",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2f93c961-e21f-4de5-9c9c-f060acb250d9",
"CreateDate": "2026-11-22T13:20:51.0748095-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T13:20:51.0748095-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "872f8a21-b37a-44f8-8b69-ab5fea32cdbd",
"FieldId": "2768965b-d2dc-489d-9c2d-dd3731aaacc9",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "872f8a21-b37a-44f8-8b69-ab5fea32cdbd",
"FieldId": "2768965b-d2dc-489d-9c2d-dd3731aaacc9",
"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": "85c8a52e-d9d2-44d7-b0d7-d7ebf3a98fad",
"Section": {
"FormTypeSectionId": "83faf5fc-b104-4eb5-8e16-c0d86e1e689f",
"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": "c35a964f-d3c5-43cb-9c08-feab1372afc1",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "f3ed4c9a-54c4-4d17-a51f-d08a2bdbda89",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "2f93c961-e21f-4de5-9c9c-f060acb250d9",
"CreateDate": "2026-11-22T13:20:51.0748095-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T13:20:51.0748095-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "872f8a21-b37a-44f8-8b69-ab5fea32cdbd",
"FieldId": "2768965b-d2dc-489d-9c2d-dd3731aaacc9",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "872f8a21-b37a-44f8-8b69-ab5fea32cdbd",
"FieldId": "2768965b-d2dc-489d-9c2d-dd3731aaacc9",
"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": "5ee25edf-6559-45e0-a5ee-574bb0e4bf81",
"CreateDate": "2026-11-22T13:20:51.0748095-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T13:20:51.0748095-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": "270984e9-055c-4f31-8b3e-47398f25e5c1",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "29c23edf-cd54-4cb1-9505-5dcbefc1889f",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "cd8c333d-c92b-4567-aad1-f234bb1e411d",
"CreateDate": "2026-11-22T13:20:51.0748095-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2026-11-22T13:20:51.0748095-08:00",
"LastModifiedUser": "sample string 8"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2026-11-22T13:20:51.0748095-08:00",
"Fields": [
{
"FormTypeFieldId": "34daf651-707f-4994-9ba3-abe374af516d",
"Section": {
"FormTypeSectionId": "57cf3ceb-b811-491c-8b4e-db83784144ff",
"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": "27f32cb9-90fa-4880-a6f3-a7cf89e49679",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "df6bbd5c-09a1-4bfb-9434-841e45cfff35",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3be1ff25-0bc2-45f7-820d-1e052418bcac",
"CreateDate": "2026-11-22T13:20:51.0748095-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T13:20:51.0748095-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "76528a7a-1ad0-4ced-bb5e-dba067d5aca3",
"FieldId": "551b6ac1-c269-493a-bc83-94a17d0e07bc",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "76528a7a-1ad0-4ced-bb5e-dba067d5aca3",
"FieldId": "551b6ac1-c269-493a-bc83-94a17d0e07bc",
"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": "34daf651-707f-4994-9ba3-abe374af516d",
"Section": {
"FormTypeSectionId": "57cf3ceb-b811-491c-8b4e-db83784144ff",
"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": "27f32cb9-90fa-4880-a6f3-a7cf89e49679",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "df6bbd5c-09a1-4bfb-9434-841e45cfff35",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "3be1ff25-0bc2-45f7-820d-1e052418bcac",
"CreateDate": "2026-11-22T13:20:51.0748095-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T13:20:51.0748095-08:00",
"LastModifiedUser": "sample string 6"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
{
"ValidValueId": "76528a7a-1ad0-4ced-bb5e-dba067d5aca3",
"FieldId": "551b6ac1-c269-493a-bc83-94a17d0e07bc",
"FieldName": "sample string 1",
"FieldLable": "sample string 2",
"ValueText": "sample string 3",
"LabelText": "sample string 4"
},
{
"ValidValueId": "76528a7a-1ad0-4ced-bb5e-dba067d5aca3",
"FieldId": "551b6ac1-c269-493a-bc83-94a17d0e07bc",
"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": "203272ab-0be8-4483-8441-7083c954691f",
"CreateDate": "2026-11-22T13:20:51.0748095-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2026-11-22T13:20:51.0748095-08:00",
"LastModifiedUser": "sample string 6"
},
"Total": 1,
"Message": "sample string 1"
}