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": "8b946653-9afc-46c3-98c2-48f740aaad50", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "a2024e34-90a6-4d15-b883-be92799695d5", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "fa3ab242-3d3e-42ff-9e8b-57edb6758a9c", "CreateDate": "2024-07-26T19:10:22.9933308-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T19:10:22.9933308-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-07-26T19:10:22.9933308-07:00", "Fields": [ { "FormTypeFieldId": "dd1500a4-d928-48df-895c-573d8441a8a0", "Section": { "FormTypeSectionId": "64702328-56ad-4216-b5a2-fd46c89c56db", "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": "568158e7-cf65-41d5-a248-b6a9c446ade0", "Name": "sample string 1" }, "Unit": { "UnitId": "43fb1620-799e-4147-862e-d8bf9ae38a7b", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "4226544a-bcd8-4d48-b94c-1845cde9f081", "CreateDate": "2024-07-26T19:10:22.9933308-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T19:10:22.9933308-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": "dd1500a4-d928-48df-895c-573d8441a8a0", "Section": { "FormTypeSectionId": "64702328-56ad-4216-b5a2-fd46c89c56db", "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": "568158e7-cf65-41d5-a248-b6a9c446ade0", "Name": "sample string 1" }, "Unit": { "UnitId": "43fb1620-799e-4147-862e-d8bf9ae38a7b", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "4226544a-bcd8-4d48-b94c-1845cde9f081", "CreateDate": "2024-07-26T19:10:22.9933308-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T19:10:22.9933308-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": "8968856f-177b-4ef7-bd0b-5c9d339aa6ec", "CreateDate": "2024-07-26T19:10:22.9933308-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T19:10:22.9933308-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": "3b453916-1ad2-4fef-a533-4d48008ff02f", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "cafd4f2c-d682-4471-8ab2-ff2565af5493", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "1119d7be-920f-4a44-aac5-4359ee509e6e", "CreateDate": "2024-07-26T19:10:22.9933308-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-07-26T19:10:22.9933308-07:00", "LastModifiedUser": "sample string 8" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-07-26T19:10:22.9933308-07:00", "Fields": [ { "FormTypeFieldId": "57d96af8-be91-4515-a931-90f0a5be222f", "Section": { "FormTypeSectionId": "5cad342c-f615-4fa5-8e2f-70fec88967fb", "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": "6ee757bb-db78-434a-b70b-bd51d303dbb3", "Name": "sample string 1" }, "Unit": { "UnitId": "4ab493c3-2acd-45a8-a92c-baaf382c2b1a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ab09e760-b3b8-4587-8bad-4fc3188aa0f4", "CreateDate": "2024-07-26T19:10:22.9933308-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T19:10:22.9933308-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": "57d96af8-be91-4515-a931-90f0a5be222f", "Section": { "FormTypeSectionId": "5cad342c-f615-4fa5-8e2f-70fec88967fb", "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": "6ee757bb-db78-434a-b70b-bd51d303dbb3", "Name": "sample string 1" }, "Unit": { "UnitId": "4ab493c3-2acd-45a8-a92c-baaf382c2b1a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ab09e760-b3b8-4587-8bad-4fc3188aa0f4", "CreateDate": "2024-07-26T19:10:22.9933308-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T19:10:22.9933308-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": "738b45eb-6ecd-4a13-95c5-6ff7b123ee57", "CreateDate": "2024-07-26T19:10:22.9933308-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-07-26T19:10:22.9933308-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }