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": "28f9be05-e5ce-4c94-8c68-70f3097230c3", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "0f26f158-4fd1-4200-8400-186a721bbd11", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "cd7a2b72-6090-43dc-a797-baab038d8223", "CreateDate": "2024-04-28T18:28:42.1572116-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T18:28:42.1572116-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-28T18:28:42.1572116-07:00", "Fields": [ { "FormTypeFieldId": "5f9d3e79-cef1-4773-9ec0-435904bdef6f", "Section": { "FormTypeSectionId": "b7693663-43a5-4e8e-ac60-65493efdd199", "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": "16b6bee2-3f08-443d-be35-661cebfc920e", "Name": "sample string 1" }, "Unit": { "UnitId": "5afdd815-1567-42d3-a706-5d6bb6fb52a4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "014935b4-999a-4dea-9321-93e6a83f7e8f", "CreateDate": "2024-04-28T18:28:42.1572116-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T18:28:42.1572116-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "5f9d3e79-cef1-4773-9ec0-435904bdef6f", "Section": { "FormTypeSectionId": "b7693663-43a5-4e8e-ac60-65493efdd199", "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": "16b6bee2-3f08-443d-be35-661cebfc920e", "Name": "sample string 1" }, "Unit": { "UnitId": "5afdd815-1567-42d3-a706-5d6bb6fb52a4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "014935b4-999a-4dea-9321-93e6a83f7e8f", "CreateDate": "2024-04-28T18:28:42.1572116-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T18:28:42.1572116-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "77c96fc7-9976-4019-8188-31c619437eab", "CreateDate": "2024-04-28T18:28:42.1572116-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T18:28:42.1572116-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": "c41bccac-5d85-4d9a-a81e-aa4872dafb2d", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "9da98462-8956-48af-b595-4765474a7aef", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b68e3175-4b7e-465b-94f3-294b81a11e08", "CreateDate": "2024-04-28T18:28:42.1572116-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T18:28:42.1572116-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-28T18:28:42.1572116-07:00", "Fields": [ { "FormTypeFieldId": "048fce02-0f4e-499d-9cad-c2ecec569cc5", "Section": { "FormTypeSectionId": "48166b7f-55a8-48bd-9b9c-9df702d42201", "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": "382a4e56-812f-4330-ba2e-95dc9b8295a1", "Name": "sample string 1" }, "Unit": { "UnitId": "fce578c4-ef0d-4696-9e5b-5211cdd04e59", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a6b456d7-12d8-455d-a017-52b206fb7556", "CreateDate": "2024-04-28T18:28:42.1572116-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T18:28:42.1572116-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "048fce02-0f4e-499d-9cad-c2ecec569cc5", "Section": { "FormTypeSectionId": "48166b7f-55a8-48bd-9b9c-9df702d42201", "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": "382a4e56-812f-4330-ba2e-95dc9b8295a1", "Name": "sample string 1" }, "Unit": { "UnitId": "fce578c4-ef0d-4696-9e5b-5211cdd04e59", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a6b456d7-12d8-455d-a017-52b206fb7556", "CreateDate": "2024-04-28T18:28:42.1572116-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T18:28:42.1572116-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "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": "46f1664d-b6d7-45a7-81ca-fd0ca469fae6", "CreateDate": "2024-04-28T18:28:42.1572116-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T18:28:42.1572116-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }