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": "32bb45ff-64ac-422c-a8b8-36e110ba59ec", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "0123466e-27a9-4ea6-ba14-af71a468375f", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "31f4f7d2-f3c1-4a05-981b-8248a7e494b3", "CreateDate": "2025-04-24T13:33:57.51982-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-24T13:33:57.51982-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-24T13:33:57.51982-07:00", "Fields": [ { "FormTypeFieldId": "a0d44d0f-d041-400f-99f3-e9064d9fb86f", "Section": { "FormTypeSectionId": "a4539708-1c43-49e9-ad3b-91a813024983", "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": "7848fe94-a4a6-4ab0-b292-1334c818c013", "Name": "sample string 1" }, "Unit": { "UnitId": "f2af28e3-0e58-41ce-a00f-e4158093e680", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "36375554-aa6f-4af9-b39b-cc524ac9865b", "CreateDate": "2025-04-24T13:33:57.51982-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:33:57.51982-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "62a1cf5b-404e-4206-a4b8-60bd3b86f812", "FieldId": "16ea3fa8-40b3-4456-a2e0-43b5aa7f12fe", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "62a1cf5b-404e-4206-a4b8-60bd3b86f812", "FieldId": "16ea3fa8-40b3-4456-a2e0-43b5aa7f12fe", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "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": "a0d44d0f-d041-400f-99f3-e9064d9fb86f", "Section": { "FormTypeSectionId": "a4539708-1c43-49e9-ad3b-91a813024983", "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": "7848fe94-a4a6-4ab0-b292-1334c818c013", "Name": "sample string 1" }, "Unit": { "UnitId": "f2af28e3-0e58-41ce-a00f-e4158093e680", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "36375554-aa6f-4af9-b39b-cc524ac9865b", "CreateDate": "2025-04-24T13:33:57.51982-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:33:57.51982-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "62a1cf5b-404e-4206-a4b8-60bd3b86f812", "FieldId": "16ea3fa8-40b3-4456-a2e0-43b5aa7f12fe", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "62a1cf5b-404e-4206-a4b8-60bd3b86f812", "FieldId": "16ea3fa8-40b3-4456-a2e0-43b5aa7f12fe", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "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": "1f6ff7ed-84d7-4cd9-8e4e-d732b562b836", "CreateDate": "2025-04-24T13:33:57.51982-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:33:57.51982-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": "66ef135d-a54e-49e6-9009-b5cf932fa453", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "0c8be002-d322-41f2-af52-08cad8c6a7d1", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "aa671a4d-829e-44e6-b6bb-15078841f6c7", "CreateDate": "2025-04-24T13:33:57.51982-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-04-24T13:33:57.51982-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-04-24T13:33:57.51982-07:00", "Fields": [ { "FormTypeFieldId": "6bd2c4a7-08a7-476e-8b40-4e09f7e95bf3", "Section": { "FormTypeSectionId": "ccd1d452-6883-40aa-9207-dec2822f1b87", "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": "238a5886-6b90-4c60-b274-021cf61ab950", "Name": "sample string 1" }, "Unit": { "UnitId": "c6d0685e-a591-4206-bed5-9044b8c99034", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ce6b4acd-44e9-49ae-b8f1-a1676bee7db0", "CreateDate": "2025-04-24T13:33:57.51982-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:33:57.51982-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "dfa05673-7a68-4014-8ded-fe571a4c1709", "FieldId": "b0905858-5013-4e41-807e-5be32990abac", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "dfa05673-7a68-4014-8ded-fe571a4c1709", "FieldId": "b0905858-5013-4e41-807e-5be32990abac", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "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": "6bd2c4a7-08a7-476e-8b40-4e09f7e95bf3", "Section": { "FormTypeSectionId": "ccd1d452-6883-40aa-9207-dec2822f1b87", "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": "238a5886-6b90-4c60-b274-021cf61ab950", "Name": "sample string 1" }, "Unit": { "UnitId": "c6d0685e-a591-4206-bed5-9044b8c99034", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "ce6b4acd-44e9-49ae-b8f1-a1676bee7db0", "CreateDate": "2025-04-24T13:33:57.51982-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:33:57.51982-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ { "ValidValueId": "dfa05673-7a68-4014-8ded-fe571a4c1709", "FieldId": "b0905858-5013-4e41-807e-5be32990abac", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" }, { "ValidValueId": "dfa05673-7a68-4014-8ded-fe571a4c1709", "FieldId": "b0905858-5013-4e41-807e-5be32990abac", "FieldName": "sample string 1", "FieldLabel": "sample string 2", "ValueText": "sample string 3", "LabelText": "sample string 4" } ], "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": "3bd64340-efe7-47f3-841f-4ba98e2d808b", "CreateDate": "2025-04-24T13:33:57.51982-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-04-24T13:33:57.51982-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }