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": "e2207f07-77c6-451f-8f68-571b4a5b18b4", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "44ff5e06-a6b0-43bd-80eb-f329ea5d4244", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "b29b96f2-af4b-44cf-96f8-c9fe604f6e5b", "CreateDate": "2023-09-22T12:24:22.0633988-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-09-22T12:24:22.0633988-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2023-09-22T12:24:22.0633988-07:00", "Fields": [ { "FormTypeFieldId": "5e518265-b27d-4392-8a86-ca1e4df28d4e", "Section": { "FormTypeSectionId": "3b9839fe-6600-430b-8424-621e4105009b", "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": "ba5e8f85-6934-4b8a-a375-759caff0bc92", "Name": "sample string 1" }, "Unit": { "UnitId": "ed51d5ac-698a-4297-8e00-acdfe7983ac9", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1d8611f9-a890-431e-adee-5babb403d998", "CreateDate": "2023-09-22T12:24:22.0633988-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-09-22T12:24:22.0633988-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": "5e518265-b27d-4392-8a86-ca1e4df28d4e", "Section": { "FormTypeSectionId": "3b9839fe-6600-430b-8424-621e4105009b", "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": "ba5e8f85-6934-4b8a-a375-759caff0bc92", "Name": "sample string 1" }, "Unit": { "UnitId": "ed51d5ac-698a-4297-8e00-acdfe7983ac9", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "1d8611f9-a890-431e-adee-5babb403d998", "CreateDate": "2023-09-22T12:24:22.0633988-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-09-22T12:24:22.0633988-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": "8c728dfd-b308-48b9-af75-a6855c714a5a", "CreateDate": "2023-09-22T12:24:22.0633988-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-09-22T12:24:22.0633988-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": "46766d69-fc9d-45a3-8c68-30e127043ef3", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "09f9f670-0bff-41b7-bb79-eac1d03a5482", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f05d19a4-c467-468f-9f6a-4f4eff03c6ef", "CreateDate": "2023-09-22T12:24:22.0633988-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2023-09-22T12:24:22.0633988-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2023-09-22T12:24:22.0633988-07:00", "Fields": [ { "FormTypeFieldId": "467bedef-2e8d-4769-aa6f-593a3be5df08", "Section": { "FormTypeSectionId": "ac3a16b6-0281-4b90-ab38-4374d61e1c05", "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": "d7fdb557-81f2-48b8-9748-a7f47750c1d2", "Name": "sample string 1" }, "Unit": { "UnitId": "2fa14065-876a-4c89-aba4-55961f53da0e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "84646d50-a9a0-43b0-9a09-bafaf3a0f865", "CreateDate": "2023-09-22T12:24:22.0633988-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-09-22T12:24:22.0633988-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": "467bedef-2e8d-4769-aa6f-593a3be5df08", "Section": { "FormTypeSectionId": "ac3a16b6-0281-4b90-ab38-4374d61e1c05", "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": "d7fdb557-81f2-48b8-9748-a7f47750c1d2", "Name": "sample string 1" }, "Unit": { "UnitId": "2fa14065-876a-4c89-aba4-55961f53da0e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "84646d50-a9a0-43b0-9a09-bafaf3a0f865", "CreateDate": "2023-09-22T12:24:22.0633988-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-09-22T12:24:22.0633988-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": "44e9eea0-7a0a-479f-8ccd-f3af28c8e33b", "CreateDate": "2023-09-22T12:24:22.0633988-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2023-09-22T12:24:22.0633988-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }