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": "4ec53492-b79f-497b-8ed0-469339527599", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "2eeefbdf-1cd7-4f3d-b405-0ace663ae712", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "939b0e86-acc1-4082-8f42-3819da0dd9af", "CreateDate": "2025-05-08T12:42:27.9307898-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-08T12:42:27.9307898-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-08T12:42:27.9307898-07:00", "Fields": [ { "FormTypeFieldId": "b5c7d67a-01dd-4628-824c-2cb1c95fb7ba", "Section": { "FormTypeSectionId": "d4a4f8ef-0450-443f-b987-602b48121d1a", "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": "bedc5fb0-a303-4ca6-b959-cbadc1b444e4", "Name": "sample string 1" }, "Unit": { "UnitId": "59dd1cc7-ce56-438d-9f4e-3137350ee04c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ee2c4e3c-c728-402a-88a1-ac68b786de9b", "CreateDate": "2025-05-08T12:42:27.9307898-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T12:42:27.9307898-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "5bd3bbfc-b1a5-47ee-857f-3460020a9bda", "FieldId": "2ed015f6-9ed4-4116-a9d0-9f14fa4200f2", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "5bd3bbfc-b1a5-47ee-857f-3460020a9bda", "FieldId": "2ed015f6-9ed4-4116-a9d0-9f14fa4200f2", "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": "b5c7d67a-01dd-4628-824c-2cb1c95fb7ba", "Section": { "FormTypeSectionId": "d4a4f8ef-0450-443f-b987-602b48121d1a", "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": "bedc5fb0-a303-4ca6-b959-cbadc1b444e4", "Name": "sample string 1" }, "Unit": { "UnitId": "59dd1cc7-ce56-438d-9f4e-3137350ee04c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ee2c4e3c-c728-402a-88a1-ac68b786de9b", "CreateDate": "2025-05-08T12:42:27.9307898-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T12:42:27.9307898-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "5bd3bbfc-b1a5-47ee-857f-3460020a9bda", "FieldId": "2ed015f6-9ed4-4116-a9d0-9f14fa4200f2", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "5bd3bbfc-b1a5-47ee-857f-3460020a9bda", "FieldId": "2ed015f6-9ed4-4116-a9d0-9f14fa4200f2", "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": "e6da6272-1712-40fd-8220-d1a8ac3eb6f8", "CreateDate": "2025-05-08T12:42:27.9307898-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T12:42:27.9307898-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": "313820eb-82e3-456e-bc1c-d2ceda2b262d", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "15223eae-b6c0-4047-9850-12474fd13cd2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "55bcbf6f-ee9b-4f58-a665-4eb11253ab9a", "CreateDate": "2025-05-08T12:42:27.9307898-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-08T12:42:27.9307898-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-08T12:42:27.9307898-07:00", "Fields": [ { "FormTypeFieldId": "9904f164-3a90-4b1b-8503-2cb8fb7ef05d", "Section": { "FormTypeSectionId": "f52dd7f1-f544-4413-984d-50484709c978", "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": "3f727891-047c-4e89-b1c6-25c4941af889", "Name": "sample string 1" }, "Unit": { "UnitId": "91d7e750-c354-4b1f-9510-bee6ec16917c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ea37393e-4bb3-4bdf-ba27-ffd12c48fc76", "CreateDate": "2025-05-08T12:42:27.9307898-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T12:42:27.9307898-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "a40c8da5-d7db-49e4-b666-70c9081c90b2", "FieldId": "f11e18b7-04cd-4408-8c93-af22123853d7", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "a40c8da5-d7db-49e4-b666-70c9081c90b2", "FieldId": "f11e18b7-04cd-4408-8c93-af22123853d7", "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": "9904f164-3a90-4b1b-8503-2cb8fb7ef05d", "Section": { "FormTypeSectionId": "f52dd7f1-f544-4413-984d-50484709c978", "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": "3f727891-047c-4e89-b1c6-25c4941af889", "Name": "sample string 1" }, "Unit": { "UnitId": "91d7e750-c354-4b1f-9510-bee6ec16917c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ea37393e-4bb3-4bdf-ba27-ffd12c48fc76", "CreateDate": "2025-05-08T12:42:27.9307898-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T12:42:27.9307898-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "a40c8da5-d7db-49e4-b666-70c9081c90b2", "FieldId": "f11e18b7-04cd-4408-8c93-af22123853d7", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "a40c8da5-d7db-49e4-b666-70c9081c90b2", "FieldId": "f11e18b7-04cd-4408-8c93-af22123853d7", "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": "2ff62663-b2fd-48d6-9447-6730b3cb84cd", "CreateDate": "2025-05-08T12:42:27.9307898-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-08T12:42:27.9307898-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }