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": "9898d8e6-b9c0-46c4-9c37-fbcccecc6c5d", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "65ae04b0-c574-48fe-b53b-c47489d7e3dc", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "ca827a25-f1ba-43f1-bd4d-663951650f07", "CreateDate": "2025-06-25T05:56:59.9270188-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-25T05:56:59.9270188-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-25T05:56:59.9270188-07:00", "Fields": [ { "FormTypeFieldId": "623aa88f-a577-4595-b310-d45ccd8f0308", "Section": { "FormTypeSectionId": "41c9d329-50a4-44c1-8cf6-7d285668693f", "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": "d6f0aabc-593e-4775-b4f9-d2d84e7fb6f7", "Name": "sample string 1" }, "Unit": { "UnitId": "7f6577c6-eb56-4256-91ce-b00763d27ff6", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "45a0d0b7-fddf-4a44-9b71-8fd0d70b6cd8", "CreateDate": "2025-06-25T05:56:59.9270188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T05:56:59.9270188-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": "623aa88f-a577-4595-b310-d45ccd8f0308", "Section": { "FormTypeSectionId": "41c9d329-50a4-44c1-8cf6-7d285668693f", "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": "d6f0aabc-593e-4775-b4f9-d2d84e7fb6f7", "Name": "sample string 1" }, "Unit": { "UnitId": "7f6577c6-eb56-4256-91ce-b00763d27ff6", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "45a0d0b7-fddf-4a44-9b71-8fd0d70b6cd8", "CreateDate": "2025-06-25T05:56:59.9270188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T05:56:59.9270188-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": "a864ea8f-a623-4d69-9ff0-e838b69b19d4", "CreateDate": "2025-06-25T05:56:59.9270188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T05:56:59.9270188-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": "86be8452-3f56-4b65-b1b9-5197caa86ceb", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "9c589658-3931-47a4-a225-be6225375220", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5e1c5379-0c72-4df1-bfee-1bb69ce7bebb", "CreateDate": "2025-06-25T05:56:59.9270188-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-25T05:56:59.9270188-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-25T05:56:59.9270188-07:00", "Fields": [ { "FormTypeFieldId": "f9c63494-fd2a-4365-bc5d-bbd4f61922d2", "Section": { "FormTypeSectionId": "21df1b83-a1ca-4e6c-afaa-413f8ba8005f", "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": "37fc6299-421a-4033-9cb5-bda4407899b9", "Name": "sample string 1" }, "Unit": { "UnitId": "bd2c7a31-7476-49db-abf2-ac64484cc668", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9931938c-d0a8-4936-94c9-363ed2a76010", "CreateDate": "2025-06-25T05:56:59.9270188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T05:56:59.9270188-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": "f9c63494-fd2a-4365-bc5d-bbd4f61922d2", "Section": { "FormTypeSectionId": "21df1b83-a1ca-4e6c-afaa-413f8ba8005f", "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": "37fc6299-421a-4033-9cb5-bda4407899b9", "Name": "sample string 1" }, "Unit": { "UnitId": "bd2c7a31-7476-49db-abf2-ac64484cc668", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9931938c-d0a8-4936-94c9-363ed2a76010", "CreateDate": "2025-06-25T05:56:59.9270188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T05:56:59.9270188-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": "f61e158c-03b7-49ce-9dd9-4dc01c50061c", "CreateDate": "2025-06-25T05:56:59.9270188-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T05:56:59.9270188-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }