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": "5aea0e70-5a4a-4c25-9e5d-ce9cb0ac30f1", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "122bdf4c-3637-442e-8894-a5db47c25df5", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "19fb0945-8fb8-42d9-830f-a99f68547bc2", "CreateDate": "2024-03-29T05:08:15.8983712-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-29T05:08:15.8983712-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-03-29T05:08:15.8983712-07:00", "Fields": [ { "FormTypeFieldId": "4ab6706f-11ec-49bc-aa08-002c42daccc8", "Section": { "FormTypeSectionId": "06022884-1254-4c0f-895d-b713cf3b364d", "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": "b0dec509-b664-47e1-8bc7-db6ff6eb5095", "Name": "sample string 1" }, "Unit": { "UnitId": "35c00419-505d-4c80-a602-3220c8443f1b", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8467d90e-da6c-49ce-9d2f-90945eb99cf6", "CreateDate": "2024-03-29T05:08:15.8983712-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T05:08:15.8983712-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": "4ab6706f-11ec-49bc-aa08-002c42daccc8", "Section": { "FormTypeSectionId": "06022884-1254-4c0f-895d-b713cf3b364d", "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": "b0dec509-b664-47e1-8bc7-db6ff6eb5095", "Name": "sample string 1" }, "Unit": { "UnitId": "35c00419-505d-4c80-a602-3220c8443f1b", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "8467d90e-da6c-49ce-9d2f-90945eb99cf6", "CreateDate": "2024-03-29T05:08:15.8983712-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T05:08:15.8983712-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": "a1c6c6a8-4877-4d5b-b749-1ffb267842c7", "CreateDate": "2024-03-29T05:08:15.8983712-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T05:08:15.8983712-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": "6d939aad-bc39-46a9-9541-877c5498c583", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "90d4b05d-6f26-44e3-8754-af17ed949009", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "d8db8e7d-dc89-4934-9e92-2711908f57f0", "CreateDate": "2024-03-29T05:08:15.8983712-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-29T05:08:15.8983712-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-03-29T05:08:15.8983712-07:00", "Fields": [ { "FormTypeFieldId": "d7d66941-878e-4137-bd01-c5bc11432642", "Section": { "FormTypeSectionId": "6b9be07b-22c1-4fa0-ba81-924f6166b722", "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": "99a36578-3a27-47d1-a0b9-5281ae75c1f7", "Name": "sample string 1" }, "Unit": { "UnitId": "53b3e65d-656b-4f91-9bf1-29a4ce70c2bc", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "efbe4c82-26c4-4b42-8f05-3ce3cb64ef7b", "CreateDate": "2024-03-29T05:08:15.8983712-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T05:08:15.8983712-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": "d7d66941-878e-4137-bd01-c5bc11432642", "Section": { "FormTypeSectionId": "6b9be07b-22c1-4fa0-ba81-924f6166b722", "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": "99a36578-3a27-47d1-a0b9-5281ae75c1f7", "Name": "sample string 1" }, "Unit": { "UnitId": "53b3e65d-656b-4f91-9bf1-29a4ce70c2bc", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "efbe4c82-26c4-4b42-8f05-3ce3cb64ef7b", "CreateDate": "2024-03-29T05:08:15.8983712-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T05:08:15.8983712-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": "ed38dd83-4ae6-4248-8921-b516ebf3646e", "CreateDate": "2024-03-29T05:08:15.8983712-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T05:08:15.8983712-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }