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": "8d7a0086-ba73-4cc8-ad28-2b06e32b1ed3", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "2247b0f4-5d6d-435b-9dd8-d8a8b8541194", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "47529887-cae7-4e58-9857-69d623b6d5f4", "CreateDate": "2024-12-21T14:36:15.6463402-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-12-21T14:36:15.6463402-08:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-12-21T14:36:15.6463402-08:00", "Fields": [ { "FormTypeFieldId": "eb6f1d73-a569-49b2-a709-f4bc222676c0", "Section": { "FormTypeSectionId": "6afdb64a-2cbe-4cf3-b595-d8b56e70f353", "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": "ab90ba13-63e7-4826-8169-ae2e11326600", "Name": "sample string 1" }, "Unit": { "UnitId": "0c42815c-ad9b-449a-9a71-afbe0b4813e1", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "259cf43e-6657-40b6-960d-34c86aa6b496", "CreateDate": "2024-12-21T14:36:15.6463402-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T14:36:15.6463402-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ad2b8265-8a84-44e6-86ee-1f7bc5bca02a", "FieldId": "f55e630f-3bf4-4493-8c46-ef56a101de01", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ad2b8265-8a84-44e6-86ee-1f7bc5bca02a", "FieldId": "f55e630f-3bf4-4493-8c46-ef56a101de01", "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": "eb6f1d73-a569-49b2-a709-f4bc222676c0", "Section": { "FormTypeSectionId": "6afdb64a-2cbe-4cf3-b595-d8b56e70f353", "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": "ab90ba13-63e7-4826-8169-ae2e11326600", "Name": "sample string 1" }, "Unit": { "UnitId": "0c42815c-ad9b-449a-9a71-afbe0b4813e1", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "259cf43e-6657-40b6-960d-34c86aa6b496", "CreateDate": "2024-12-21T14:36:15.6463402-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T14:36:15.6463402-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ad2b8265-8a84-44e6-86ee-1f7bc5bca02a", "FieldId": "f55e630f-3bf4-4493-8c46-ef56a101de01", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ad2b8265-8a84-44e6-86ee-1f7bc5bca02a", "FieldId": "f55e630f-3bf4-4493-8c46-ef56a101de01", "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": "1955c3a2-2d5e-43a3-b677-43c751477e43", "CreateDate": "2024-12-21T14:36:15.6463402-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T14:36:15.6463402-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": "43810cb7-a5a4-4c1a-9448-6a58ea84bedd", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "c4dd745c-cdb4-4465-80c0-7173c2aa8aa1", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "6719d431-05ac-43d8-b422-8cab72b97434", "CreateDate": "2024-12-21T14:36:15.6463402-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-12-21T14:36:15.6463402-08:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-12-21T14:36:15.6463402-08:00", "Fields": [ { "FormTypeFieldId": "a29b0083-838b-407e-a721-b238e28e0bf4", "Section": { "FormTypeSectionId": "f63c839e-7ca2-470d-9c0b-0164bae00202", "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": "ababbdc5-3d8b-4df3-8784-678706fff0c5", "Name": "sample string 1" }, "Unit": { "UnitId": "a9e5fce9-d8fe-4063-9dad-d16825e06d0d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "28170149-76f6-4df3-8efc-f7c17036ad24", "CreateDate": "2024-12-21T14:36:15.6463402-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T14:36:15.6463402-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ce88a354-668f-4adf-87cd-73be659699f8", "FieldId": "e2b73302-a947-404b-bcf7-e86d85f108c0", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ce88a354-668f-4adf-87cd-73be659699f8", "FieldId": "e2b73302-a947-404b-bcf7-e86d85f108c0", "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": "a29b0083-838b-407e-a721-b238e28e0bf4", "Section": { "FormTypeSectionId": "f63c839e-7ca2-470d-9c0b-0164bae00202", "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": "ababbdc5-3d8b-4df3-8784-678706fff0c5", "Name": "sample string 1" }, "Unit": { "UnitId": "a9e5fce9-d8fe-4063-9dad-d16825e06d0d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "28170149-76f6-4df3-8efc-f7c17036ad24", "CreateDate": "2024-12-21T14:36:15.6463402-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T14:36:15.6463402-08:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "ce88a354-668f-4adf-87cd-73be659699f8", "FieldId": "e2b73302-a947-404b-bcf7-e86d85f108c0", "FieldName": "sample string 1", "FieldLable": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "ce88a354-668f-4adf-87cd-73be659699f8", "FieldId": "e2b73302-a947-404b-bcf7-e86d85f108c0", "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": "4003235d-9bcd-4cf0-a1b1-47e93b5e4ab2", "CreateDate": "2024-12-21T14:36:15.6463402-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T14:36:15.6463402-08:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }