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": "0a557323-04fa-4eb3-ae17-b24d861b63c6", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "c4b1bcaf-ff76-4005-b4cb-e738c675dab0", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "49625e12-c9d4-48b2-99e9-7caae82da068", "CreateDate": "2024-12-21T19:17:33.0563505-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-21T19:17:33.0563505-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-12-21T19:17:33.0563505-08:00", "Fields": [ { "FormTypeFieldId": "5f361ba4-4e83-4d2a-8122-1c19abd61a5a", "Section": { "FormTypeSectionId": "df3bcbc5-effa-4933-b115-769af205bfcf", "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": "e4963a35-d8d6-4c0d-8dcd-fcbe2f2056e6", "Name": "sample string 1" }, "Unit": { "UnitId": "186ed972-5f91-4e89-9bff-e340ea278660", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1a653367-acef-4f77-bdc1-969180c120b4", "CreateDate": "2024-12-21T19:17:33.0563505-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T19:17:33.0563505-08: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": "5f361ba4-4e83-4d2a-8122-1c19abd61a5a", "Section": { "FormTypeSectionId": "df3bcbc5-effa-4933-b115-769af205bfcf", "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": "e4963a35-d8d6-4c0d-8dcd-fcbe2f2056e6", "Name": "sample string 1" }, "Unit": { "UnitId": "186ed972-5f91-4e89-9bff-e340ea278660", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1a653367-acef-4f77-bdc1-969180c120b4", "CreateDate": "2024-12-21T19:17:33.0563505-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T19:17:33.0563505-08: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": "f3fef04b-2eb3-4b06-a16d-c4f7adb5efba", "CreateDate": "2024-12-21T19:17:33.0563505-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T19:17:33.0563505-08: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": "6ecb72a5-d74c-4b26-a217-a15a2d4064a4", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "e19e501b-b705-4c6d-914e-440029e7f30c", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "241a9063-132b-4561-af05-8f11da85ba05", "CreateDate": "2024-12-21T19:17:33.0719858-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-12-21T19:17:33.0719858-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-12-21T19:17:33.0719858-08:00", "Fields": [ { "FormTypeFieldId": "98b2b926-9bfd-47ef-b110-a7a8b8dcf247", "Section": { "FormTypeSectionId": "0672f41f-a1de-48db-b98c-5905273e3211", "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": "7af6b1f8-4e3d-4884-b743-aaad42b96e63", "Name": "sample string 1" }, "Unit": { "UnitId": "f271e7be-bf8c-47ac-b238-492243d0b506", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d6aefd15-44d7-40f4-9610-a82a8b424aa5", "CreateDate": "2024-12-21T19:17:33.0719858-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T19:17:33.0719858-08: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": "98b2b926-9bfd-47ef-b110-a7a8b8dcf247", "Section": { "FormTypeSectionId": "0672f41f-a1de-48db-b98c-5905273e3211", "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": "7af6b1f8-4e3d-4884-b743-aaad42b96e63", "Name": "sample string 1" }, "Unit": { "UnitId": "f271e7be-bf8c-47ac-b238-492243d0b506", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "d6aefd15-44d7-40f4-9610-a82a8b424aa5", "CreateDate": "2024-12-21T19:17:33.0719858-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T19:17:33.0719858-08: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": "07bc4c67-ca72-4d49-8441-7e9f17741249", "CreateDate": "2024-12-21T19:17:33.0719858-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-12-21T19:17:33.0719858-08:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }