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": "ab69c83e-48fd-43f2-9ea3-9fce306c9490", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "0d80b30d-386f-41d8-acc7-12d1a895c743", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "84ee6e5d-13af-4f82-9dd1-47b987b195bf", "CreateDate": "2024-10-10T15:21:51.927284-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T15:21:51.927284-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-10-10T15:21:51.927284-07:00", "Fields": [ { "FormTypeFieldId": "35b41054-aaea-45bc-9c0e-d3ed9c78e323", "Section": { "FormTypeSectionId": "576d0993-f70b-428a-9ce8-715b008bac0c", "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": "1dcc9ed2-e2c7-4741-a532-a6c7ed557e2d", "Name": "sample string 1" }, "Unit": { "UnitId": "bb59c614-6df2-4a28-9519-98dcd4e79b1e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "153e59bb-a550-4626-a2e6-b7f847cb269a", "CreateDate": "2024-10-10T15:21:51.927284-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T15:21:51.927284-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": "35b41054-aaea-45bc-9c0e-d3ed9c78e323", "Section": { "FormTypeSectionId": "576d0993-f70b-428a-9ce8-715b008bac0c", "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": "1dcc9ed2-e2c7-4741-a532-a6c7ed557e2d", "Name": "sample string 1" }, "Unit": { "UnitId": "bb59c614-6df2-4a28-9519-98dcd4e79b1e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "153e59bb-a550-4626-a2e6-b7f847cb269a", "CreateDate": "2024-10-10T15:21:51.927284-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T15:21:51.927284-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": "d244a257-d246-452a-abd4-8393b0972c97", "CreateDate": "2024-10-10T15:21:51.927284-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T15:21:51.927284-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": "cfa63b66-f61d-407b-a64c-21c543a36ac2", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "51a8e9e5-79d2-42e0-8ed8-d8b7b83a0520", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "c6a59e99-6e65-4176-8033-2b91f1149feb", "CreateDate": "2024-10-10T15:21:51.9429072-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T15:21:51.9429072-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-10-10T15:21:51.9429072-07:00", "Fields": [ { "FormTypeFieldId": "e3e6429b-690f-4e41-99d3-7f9dcb88e316", "Section": { "FormTypeSectionId": "95b24cb8-0e18-43a0-8e9f-86e33f68e143", "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": "ee377554-2f96-46aa-8437-ceefcf1f4476", "Name": "sample string 1" }, "Unit": { "UnitId": "be6bc4cf-93e4-48f3-85c7-5960f18dd400", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1b947ef8-432c-4edf-996c-e8e550dd1311", "CreateDate": "2024-10-10T15:21:51.9429072-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T15:21:51.9429072-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": "e3e6429b-690f-4e41-99d3-7f9dcb88e316", "Section": { "FormTypeSectionId": "95b24cb8-0e18-43a0-8e9f-86e33f68e143", "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": "ee377554-2f96-46aa-8437-ceefcf1f4476", "Name": "sample string 1" }, "Unit": { "UnitId": "be6bc4cf-93e4-48f3-85c7-5960f18dd400", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1b947ef8-432c-4edf-996c-e8e550dd1311", "CreateDate": "2024-10-10T15:21:51.9429072-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T15:21:51.9429072-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": "7cf1f030-5c5d-46f4-8f4f-26bed1e01482", "CreateDate": "2024-10-10T15:21:51.9429072-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T15:21:51.9429072-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }