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": "6efab00e-fd30-4461-ba2b-c589167429fc", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "d191c9f3-29b3-4a6e-b83f-e924973155d0", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "108e2461-6c34-433c-b077-b1c4247023ad", "CreateDate": "2024-04-25T14:17:56.345052-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-25T14:17:56.345052-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-25T14:17:56.345052-07:00", "Fields": [ { "FormTypeFieldId": "9a0ce9d9-8907-487b-abf6-eb4714d7e5fa", "Section": { "FormTypeSectionId": "1fab068a-9836-4ec8-b2f7-911bb92d3df1", "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": "c2c86d64-a721-47ca-a0c3-c34c4026a591", "Name": "sample string 1" }, "Unit": { "UnitId": "96de4f3b-f0f2-420d-9272-6e91409e9df8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "47316509-8c2e-4664-90ad-1e4acd51a8ca", "CreateDate": "2024-04-25T14:17:56.345052-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T14:17:56.345052-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": "9a0ce9d9-8907-487b-abf6-eb4714d7e5fa", "Section": { "FormTypeSectionId": "1fab068a-9836-4ec8-b2f7-911bb92d3df1", "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": "c2c86d64-a721-47ca-a0c3-c34c4026a591", "Name": "sample string 1" }, "Unit": { "UnitId": "96de4f3b-f0f2-420d-9272-6e91409e9df8", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "47316509-8c2e-4664-90ad-1e4acd51a8ca", "CreateDate": "2024-04-25T14:17:56.345052-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T14:17:56.345052-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": "3cb6ea6e-58e2-4f1c-b754-7fa76db43b3d", "CreateDate": "2024-04-25T14:17:56.345052-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T14:17:56.345052-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": "7f7a64e9-cc32-49ec-aacf-39c563beafb7", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "dbd672e2-0509-4125-b9d2-438b20ff0b66", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "b5934af5-a5a3-4dbd-9de3-35f30d6b5e05", "CreateDate": "2024-04-25T14:17:56.345052-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-25T14:17:56.345052-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-04-25T14:17:56.345052-07:00", "Fields": [ { "FormTypeFieldId": "d94d4302-7464-4a0f-a49c-8a57ee0c44a7", "Section": { "FormTypeSectionId": "f91121de-b8f4-4eca-9b34-8f1662720717", "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": "97bdff7b-7cc5-420f-abca-14fc39717f93", "Name": "sample string 1" }, "Unit": { "UnitId": "f5a70bbd-aeb7-4dd6-a53a-9e4be3043d5e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "4630cf42-a004-4ccb-aae4-35460fc813eb", "CreateDate": "2024-04-25T14:17:56.345052-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T14:17:56.345052-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": "d94d4302-7464-4a0f-a49c-8a57ee0c44a7", "Section": { "FormTypeSectionId": "f91121de-b8f4-4eca-9b34-8f1662720717", "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": "97bdff7b-7cc5-420f-abca-14fc39717f93", "Name": "sample string 1" }, "Unit": { "UnitId": "f5a70bbd-aeb7-4dd6-a53a-9e4be3043d5e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "4630cf42-a004-4ccb-aae4-35460fc813eb", "CreateDate": "2024-04-25T14:17:56.345052-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T14:17:56.345052-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": "d374eae9-f933-4f59-8ae7-8d952fceeee5", "CreateDate": "2024-04-25T14:17:56.345052-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-25T14:17:56.345052-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }