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": "0a66ec94-6953-46d9-9413-cc3ec1e245b3", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "c3348d5f-faeb-4d32-b4f1-af7cdb6e3260", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "be850d2a-c73f-4212-bd31-0471dacd9bc1", "CreateDate": "2025-07-09T09:42:43.8341129-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-09T09:42:43.8341129-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-09T09:42:43.8341129-07:00", "Fields": [ { "FormTypeFieldId": "da4ce1db-5b6c-4ec4-8178-8ece9861eaa9", "Section": { "FormTypeSectionId": "cd804998-ecd0-42bc-9835-10caa02bef6d", "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": "5c7803ea-f6ad-4daf-bec4-d64bad434ed1", "Name": "sample string 1" }, "Unit": { "UnitId": "e46d0b8c-ed25-46be-862b-45d836aa13e2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3b0a9f4d-1339-4656-8d3a-231bc2d24055", "CreateDate": "2025-07-09T09:42:43.8341129-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-09T09:42:43.8341129-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "58f82c05-9a2e-434d-8839-0b9b44e18878", "FieldId": "5f376ef1-eda8-47e3-b10b-f36044378d21", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "58f82c05-9a2e-434d-8839-0b9b44e18878", "FieldId": "5f376ef1-eda8-47e3-b10b-f36044378d21", "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": "da4ce1db-5b6c-4ec4-8178-8ece9861eaa9", "Section": { "FormTypeSectionId": "cd804998-ecd0-42bc-9835-10caa02bef6d", "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": "5c7803ea-f6ad-4daf-bec4-d64bad434ed1", "Name": "sample string 1" }, "Unit": { "UnitId": "e46d0b8c-ed25-46be-862b-45d836aa13e2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3b0a9f4d-1339-4656-8d3a-231bc2d24055", "CreateDate": "2025-07-09T09:42:43.8341129-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-09T09:42:43.8341129-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "58f82c05-9a2e-434d-8839-0b9b44e18878", "FieldId": "5f376ef1-eda8-47e3-b10b-f36044378d21", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "58f82c05-9a2e-434d-8839-0b9b44e18878", "FieldId": "5f376ef1-eda8-47e3-b10b-f36044378d21", "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": "a0083508-eacb-4009-8be9-7f19d21b0d8a", "CreateDate": "2025-07-09T09:42:43.8341129-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-09T09:42:43.8341129-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": "755abfdb-b4eb-4132-b836-f0fdc7d1dedb", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "b46bd4c7-bac7-4d06-b7ff-651338268b4d", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "bc653149-2588-4068-9819-16272aba71e1", "CreateDate": "2025-07-09T09:42:43.8341129-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-09T09:42:43.8341129-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-09T09:42:43.8341129-07:00", "Fields": [ { "FormTypeFieldId": "4c407c7c-180f-4e44-8900-2e1c004b892d", "Section": { "FormTypeSectionId": "34a05751-eef9-4b43-aacb-39259ec497e5", "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": "8fac4959-0dfa-485a-9011-58d2bf2b23e1", "Name": "sample string 1" }, "Unit": { "UnitId": "a706ecd6-45a7-4784-8b99-2ca47053f77a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "09605626-7c30-4bdc-83a7-89bee1d997cc", "CreateDate": "2025-07-09T09:42:43.8341129-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-09T09:42:43.8341129-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c4003bf5-3b1b-4532-9156-0aad6d43718b", "FieldId": "b461dce3-2f05-42f7-ba63-480db63898e7", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c4003bf5-3b1b-4532-9156-0aad6d43718b", "FieldId": "b461dce3-2f05-42f7-ba63-480db63898e7", "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": "4c407c7c-180f-4e44-8900-2e1c004b892d", "Section": { "FormTypeSectionId": "34a05751-eef9-4b43-aacb-39259ec497e5", "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": "8fac4959-0dfa-485a-9011-58d2bf2b23e1", "Name": "sample string 1" }, "Unit": { "UnitId": "a706ecd6-45a7-4784-8b99-2ca47053f77a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "09605626-7c30-4bdc-83a7-89bee1d997cc", "CreateDate": "2025-07-09T09:42:43.8341129-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-09T09:42:43.8341129-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "c4003bf5-3b1b-4532-9156-0aad6d43718b", "FieldId": "b461dce3-2f05-42f7-ba63-480db63898e7", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "c4003bf5-3b1b-4532-9156-0aad6d43718b", "FieldId": "b461dce3-2f05-42f7-ba63-480db63898e7", "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": "f5d498c9-da6e-4d3f-ba0b-4cdb43cd9614", "CreateDate": "2025-07-09T09:42:43.8341129-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-09T09:42:43.8341129-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }