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": "eac9e7d8-b899-4989-baed-3246670631e8", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "f728790b-c846-41a1-9db9-f83d7a142e24", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "54764425-611c-48e9-95f8-5dfcf2eaeb43", "CreateDate": "2025-04-25T12:46:22.3143093-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-25T12:46:22.3143093-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-25T12:46:22.3143093-07:00", "Fields": [ { "FormTypeFieldId": "8dd90f5a-59d6-4bef-8166-e66b9d98a089", "Section": { "FormTypeSectionId": "a5031ae0-4d1d-4270-a47c-a7dc8014d92a", "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": "0bd281bc-96c4-436a-91d1-4a530f0cd450", "Name": "sample string 1" }, "Unit": { "UnitId": "5b1138a3-5c0d-40c3-a6b4-69e9dcbe2756", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "650733c7-4e02-4c59-a8db-5c926d6e2fca", "CreateDate": "2025-04-25T12:46:22.3143093-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T12:46:22.3143093-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": "8dd90f5a-59d6-4bef-8166-e66b9d98a089", "Section": { "FormTypeSectionId": "a5031ae0-4d1d-4270-a47c-a7dc8014d92a", "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": "0bd281bc-96c4-436a-91d1-4a530f0cd450", "Name": "sample string 1" }, "Unit": { "UnitId": "5b1138a3-5c0d-40c3-a6b4-69e9dcbe2756", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "650733c7-4e02-4c59-a8db-5c926d6e2fca", "CreateDate": "2025-04-25T12:46:22.3143093-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T12:46:22.3143093-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": "308a0390-7eac-400e-b81c-88bdd1ab7187", "CreateDate": "2025-04-25T12:46:22.3143093-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T12:46:22.3143093-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": "c7e2fc8d-ae8c-4b05-a2da-d09c350ca837", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "f070bcfb-ebe7-4209-b3db-13f77fd8ffdb", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "029712e1-7575-4353-98ea-e4c66b140cf9", "CreateDate": "2025-04-25T12:46:22.3143093-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-25T12:46:22.3143093-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-25T12:46:22.3143093-07:00", "Fields": [ { "FormTypeFieldId": "d7998457-7396-48a4-ae6c-3b7e6665ef1a", "Section": { "FormTypeSectionId": "8f666275-5855-4789-b72f-b7eb65b316d2", "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": "5076f0d0-e7e5-4842-8823-20fed12a4407", "Name": "sample string 1" }, "Unit": { "UnitId": "ebffc9e8-540a-447b-93b8-f427fca31c20", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "299004de-0e85-483e-8f6f-442e5595f072", "CreateDate": "2025-04-25T12:46:22.3143093-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T12:46:22.3143093-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": "d7998457-7396-48a4-ae6c-3b7e6665ef1a", "Section": { "FormTypeSectionId": "8f666275-5855-4789-b72f-b7eb65b316d2", "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": "5076f0d0-e7e5-4842-8823-20fed12a4407", "Name": "sample string 1" }, "Unit": { "UnitId": "ebffc9e8-540a-447b-93b8-f427fca31c20", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "299004de-0e85-483e-8f6f-442e5595f072", "CreateDate": "2025-04-25T12:46:22.3143093-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T12:46:22.3143093-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": "37159824-d2fa-4ca3-a36d-6fa9826df309", "CreateDate": "2025-04-25T12:46:22.3143093-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-25T12:46:22.3143093-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }