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": "ac9d075a-8984-485e-89d2-574b75722fd3", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "e075c456-84ba-455f-905b-195db598228e", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "75b9964d-6037-4652-a2ee-463b826cb77e", "CreateDate": "2025-07-06T15:13:02.281185-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-06T15:13:02.281185-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-06T15:13:02.281185-07:00", "Fields": [ { "FormTypeFieldId": "aa46a146-e76b-4785-81b9-a9cafd5b4e6b", "Section": { "FormTypeSectionId": "8274b731-6151-435f-bdd7-e170d63ae467", "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": "452bdd1d-4992-48f6-ac69-e2735cf21571", "Name": "sample string 1" }, "Unit": { "UnitId": "5be16e38-708e-4d3a-b01c-3617fcdf71e3", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "289b3198-9bc7-4807-ac66-bb026aba6ddd", "CreateDate": "2025-07-06T15:13:02.281185-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T15:13:02.281185-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "51a8b2be-1c6d-4ce8-8595-66434b22decb", "FieldId": "b868f199-a368-4045-8d92-d713bad76a2a", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "51a8b2be-1c6d-4ce8-8595-66434b22decb", "FieldId": "b868f199-a368-4045-8d92-d713bad76a2a", "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": "aa46a146-e76b-4785-81b9-a9cafd5b4e6b", "Section": { "FormTypeSectionId": "8274b731-6151-435f-bdd7-e170d63ae467", "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": "452bdd1d-4992-48f6-ac69-e2735cf21571", "Name": "sample string 1" }, "Unit": { "UnitId": "5be16e38-708e-4d3a-b01c-3617fcdf71e3", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "289b3198-9bc7-4807-ac66-bb026aba6ddd", "CreateDate": "2025-07-06T15:13:02.281185-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T15:13:02.281185-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "51a8b2be-1c6d-4ce8-8595-66434b22decb", "FieldId": "b868f199-a368-4045-8d92-d713bad76a2a", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "51a8b2be-1c6d-4ce8-8595-66434b22decb", "FieldId": "b868f199-a368-4045-8d92-d713bad76a2a", "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": "ecb5c95a-fdb3-4fdd-b865-160a1cca6c31", "CreateDate": "2025-07-06T15:13:02.281185-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T15:13:02.281185-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": "042d9bd9-b0ac-48f9-9197-50016007bb06", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "02285038-383b-4ea8-96cf-334ed985ee5b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "2df22ed1-ad15-4774-a946-c1f9a6e39b90", "CreateDate": "2025-07-06T15:13:02.281185-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-06T15:13:02.281185-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-06T15:13:02.281185-07:00", "Fields": [ { "FormTypeFieldId": "9898e1d8-efe8-4be0-9bc1-388d5127268e", "Section": { "FormTypeSectionId": "e8dd79ea-3a1e-4f1d-89c8-d46d97f7c34e", "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": "6e48a0c9-70bf-4cba-ad75-07d86c94ec23", "Name": "sample string 1" }, "Unit": { "UnitId": "25dce479-1aaa-4909-bdfe-182254ae1c7d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2cd398db-b39b-4989-a197-a7d5822c656a", "CreateDate": "2025-07-06T15:13:02.281185-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T15:13:02.281185-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "926ab88f-c0b0-48fd-a961-47656dc9e14f", "FieldId": "08628197-6b8f-4291-afa6-1b3749eda3c2", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "926ab88f-c0b0-48fd-a961-47656dc9e14f", "FieldId": "08628197-6b8f-4291-afa6-1b3749eda3c2", "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": "9898e1d8-efe8-4be0-9bc1-388d5127268e", "Section": { "FormTypeSectionId": "e8dd79ea-3a1e-4f1d-89c8-d46d97f7c34e", "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": "6e48a0c9-70bf-4cba-ad75-07d86c94ec23", "Name": "sample string 1" }, "Unit": { "UnitId": "25dce479-1aaa-4909-bdfe-182254ae1c7d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2cd398db-b39b-4989-a197-a7d5822c656a", "CreateDate": "2025-07-06T15:13:02.281185-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T15:13:02.281185-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "926ab88f-c0b0-48fd-a961-47656dc9e14f", "FieldId": "08628197-6b8f-4291-afa6-1b3749eda3c2", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "926ab88f-c0b0-48fd-a961-47656dc9e14f", "FieldId": "08628197-6b8f-4291-afa6-1b3749eda3c2", "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": "b6be14b6-c6a0-4b2d-aa59-18e9dbf4a01f", "CreateDate": "2025-07-06T15:13:02.281185-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-06T15:13:02.281185-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }