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. |
|
CreateMachine | string |
None. |
|
LastModifiedDate | date |
None. |
|
LastModifiedUser | string |
None. |
|
LastModifiedMachine | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "FormTypeId": "3fcd101d-49cb-4cc6-9f01-dc783e8d5562", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "61d82ddf-93f9-4d47-ba81-132d03599bda", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "dc3f94cf-22aa-465a-acee-b9fbd4579f82", "CreateDate": "2021-04-17T08:43:05.8713217-07:00", "CreateUser": "sample string 6", "CreateMachine": "sample string 7", "LastModifiedDate": "2021-04-17T08:43:05.8713217-07:00", "LastModifiedUser": "sample string 8", "LastModifiedMachine": "sample string 9" }, "FrequencyNeeded": 1, "ValueNeededDate": "2021-04-17T08:43:05.8713217-07:00", "Fields": [ { "FormTypeFieldId": "ebe27d95-54d9-4842-9cf7-61cdc664e7d9", "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "3a47dde0-af5f-4ce1-82aa-f3d2ae670108", "Name": "sample string 1" }, "Unit": { "UnitId": "04140974-1dd5-42ff-ae97-626051b38571", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "6a2567ad-2a12-4ed7-b43e-5d3dce2085a0", "CreateDate": "2021-04-17T08:43:05.8713217-07:00", "CreateUser": "sample string 5", "CreateMachine": "sample string 6", "LastModifiedDate": "2021-04-17T08:43:05.8713217-07:00", "LastModifiedUser": "sample string 7", "LastModifiedMachine": "sample string 8" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "Expression": "sample string 5", "IsRequired": true, "IsAttachment": true, "DefaultValue": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "SourceSystemId": "sample string 11" }, { "FormTypeFieldId": "ebe27d95-54d9-4842-9cf7-61cdc664e7d9", "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "3a47dde0-af5f-4ce1-82aa-f3d2ae670108", "Name": "sample string 1" }, "Unit": { "UnitId": "04140974-1dd5-42ff-ae97-626051b38571", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "6a2567ad-2a12-4ed7-b43e-5d3dce2085a0", "CreateDate": "2021-04-17T08:43:05.8713217-07:00", "CreateUser": "sample string 5", "CreateMachine": "sample string 6", "LastModifiedDate": "2021-04-17T08:43:05.8713217-07:00", "LastModifiedUser": "sample string 7", "LastModifiedMachine": "sample string 8" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "Expression": "sample string 5", "IsRequired": true, "IsAttachment": true, "DefaultValue": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "SourceSystemId": "sample string 11" } ], "SourceSystemId": "sample string 3", "CompanyId": "ac28d8c6-78d9-475d-b2c6-2215d04e0bae", "CreateDate": "2021-04-17T08:43:05.8713217-07:00", "CreateUser": "sample string 5", "CreateMachine": "sample string 6", "LastModifiedDate": "2021-04-17T08:43:05.8713217-07:00", "LastModifiedUser": "sample string 7", "LastModifiedMachine": "sample string 8" }
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": "e9a19cf2-f59b-43c6-853a-cb8bd4fe0a2d", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "8a4e9263-cead-4b9b-8634-091556fdc8f7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "9ddd6ade-0eca-42ad-be26-a2fb6e59bb64", "CreateDate": "2021-04-17T08:43:05.8713217-07:00", "CreateUser": "sample string 6", "CreateMachine": "sample string 7", "LastModifiedDate": "2021-04-17T08:43:05.8713217-07:00", "LastModifiedUser": "sample string 8", "LastModifiedMachine": "sample string 9" }, "FrequencyNeeded": 1, "ValueNeededDate": "2021-04-17T08:43:05.8713217-07:00", "Fields": [ { "FormTypeFieldId": "3c3178e3-1beb-4fa4-8f79-f0cbb73f799b", "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "cfb62d3e-fc6d-4e7f-aa31-d9dd422efd17", "Name": "sample string 1" }, "Unit": { "UnitId": "1cd669d9-5cec-4ba5-8594-298c73d91f27", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2bd4817e-52fc-4d06-8dc6-90e505ed5b7b", "CreateDate": "2021-04-17T08:43:05.8713217-07:00", "CreateUser": "sample string 5", "CreateMachine": "sample string 6", "LastModifiedDate": "2021-04-17T08:43:05.8713217-07:00", "LastModifiedUser": "sample string 7", "LastModifiedMachine": "sample string 8" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "Expression": "sample string 5", "IsRequired": true, "IsAttachment": true, "DefaultValue": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "SourceSystemId": "sample string 11" }, { "FormTypeFieldId": "3c3178e3-1beb-4fa4-8f79-f0cbb73f799b", "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "cfb62d3e-fc6d-4e7f-aa31-d9dd422efd17", "Name": "sample string 1" }, "Unit": { "UnitId": "1cd669d9-5cec-4ba5-8594-298c73d91f27", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2bd4817e-52fc-4d06-8dc6-90e505ed5b7b", "CreateDate": "2021-04-17T08:43:05.8713217-07:00", "CreateUser": "sample string 5", "CreateMachine": "sample string 6", "LastModifiedDate": "2021-04-17T08:43:05.8713217-07:00", "LastModifiedUser": "sample string 7", "LastModifiedMachine": "sample string 8" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "Expression": "sample string 5", "IsRequired": true, "IsAttachment": true, "DefaultValue": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "SourceSystemId": "sample string 11" } ], "SourceSystemId": "sample string 3", "CompanyId": "66e4816a-ae15-4cc4-a49c-e0e12f2870d8", "CreateDate": "2021-04-17T08:43:05.8713217-07:00", "CreateUser": "sample string 5", "CreateMachine": "sample string 6", "LastModifiedDate": "2021-04-17T08:43:05.8713217-07:00", "LastModifiedUser": "sample string 7", "LastModifiedMachine": "sample string 8" }, "Total": 1, "Message": "sample string 1" }