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": "d8402ec5-7317-4949-98d2-7577eab3ce44", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "0198f354-23a1-4e2e-8ceb-1b6ac4df327b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8b8e5353-ad30-495a-9273-89300c462606", "CreateDate": "2025-10-13T15:16:39.0011548-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:16:39.0011548-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-13T15:16:39.0011548-07:00", "Fields": [ { "FormTypeFieldId": "48e382aa-c7e2-462c-904c-3cd87ad2966c", "Section": { "FormTypeSectionId": "30ade52f-eac3-46fd-b75a-b08cdee8d494", "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": "6604cec7-702a-4352-8c58-9cab676a3044", "Name": "sample string 1" }, "Unit": { "UnitId": "e6889ff1-05a8-46d5-a8a0-c140c0995e15", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "b44c972e-ea6f-4462-82c5-15e988f84255", "CreateDate": "2025-10-13T15:16:39.0011548-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:16:39.0011548-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "f48a3f67-3712-434a-9b3f-353a10ab8ff5", "FieldId": "53a16f91-b484-4342-9644-b239cb762da7", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "f48a3f67-3712-434a-9b3f-353a10ab8ff5", "FieldId": "53a16f91-b484-4342-9644-b239cb762da7", "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": "48e382aa-c7e2-462c-904c-3cd87ad2966c", "Section": { "FormTypeSectionId": "30ade52f-eac3-46fd-b75a-b08cdee8d494", "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": "6604cec7-702a-4352-8c58-9cab676a3044", "Name": "sample string 1" }, "Unit": { "UnitId": "e6889ff1-05a8-46d5-a8a0-c140c0995e15", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "b44c972e-ea6f-4462-82c5-15e988f84255", "CreateDate": "2025-10-13T15:16:39.0011548-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:16:39.0011548-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "f48a3f67-3712-434a-9b3f-353a10ab8ff5", "FieldId": "53a16f91-b484-4342-9644-b239cb762da7", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "f48a3f67-3712-434a-9b3f-353a10ab8ff5", "FieldId": "53a16f91-b484-4342-9644-b239cb762da7", "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": "4e332ad3-f463-44ed-86cd-b1bad5b74ec1", "CreateDate": "2025-10-13T15:16:39.0011548-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:16:39.0011548-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": "7617a6e9-b52e-4b2c-864e-ed448015f9c5", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "6939e8fb-859a-4fcc-b6be-33b0a71d713b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "50213e66-f9a2-41ce-88b2-c9b9c2520e71", "CreateDate": "2025-10-13T15:16:39.0011548-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T15:16:39.0011548-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-13T15:16:39.0011548-07:00", "Fields": [ { "FormTypeFieldId": "ea1acdbc-69b5-4020-be43-3bffb26d472c", "Section": { "FormTypeSectionId": "a4fca50b-a229-432d-b44a-fb9f5c74bf38", "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": "588f0ff5-7e22-4f30-a6e7-62d2b873cf28", "Name": "sample string 1" }, "Unit": { "UnitId": "c492745e-31f7-478c-bf0b-b089cbaf4a3d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "5dc037fd-6645-406e-b8c3-51f89829a477", "CreateDate": "2025-10-13T15:16:39.0011548-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:16:39.0011548-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "7c71b973-fe06-49d3-84b2-d16c970d53e6", "FieldId": "00cea5c4-c524-4458-914d-f450583557b4", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "7c71b973-fe06-49d3-84b2-d16c970d53e6", "FieldId": "00cea5c4-c524-4458-914d-f450583557b4", "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": "ea1acdbc-69b5-4020-be43-3bffb26d472c", "Section": { "FormTypeSectionId": "a4fca50b-a229-432d-b44a-fb9f5c74bf38", "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": "588f0ff5-7e22-4f30-a6e7-62d2b873cf28", "Name": "sample string 1" }, "Unit": { "UnitId": "c492745e-31f7-478c-bf0b-b089cbaf4a3d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "5dc037fd-6645-406e-b8c3-51f89829a477", "CreateDate": "2025-10-13T15:16:39.0011548-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:16:39.0011548-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "7c71b973-fe06-49d3-84b2-d16c970d53e6", "FieldId": "00cea5c4-c524-4458-914d-f450583557b4", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "7c71b973-fe06-49d3-84b2-d16c970d53e6", "FieldId": "00cea5c4-c524-4458-914d-f450583557b4", "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": "d2978a35-1313-4f8a-b2aa-2f77bffa7260", "CreateDate": "2025-10-13T15:16:39.0011548-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T15:16:39.0011548-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }