POST Forms
Creates a new form.
Request Information
URI Parameters
None.
Body Parameters
The form to create. FormId should not be filled in.
FormName | Description | Type | Additional information |
---|---|---|---|
FormId | globally unique identifier |
None. |
|
Asset | Asset |
None. |
|
FormType | FormType |
None. |
|
EffectiveDate | date |
None. |
|
Location | string |
None. |
|
TaskId | globally unique identifier |
None. |
|
Values | Collection of FormFieldValue |
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:
{ "FormId": "efcae45e-4913-4991-89e2-07eeed42db9f", "Asset": { "AssetId": "6bfa5db6-1e5f-4ddf-ab4c-dd718e13345d", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "e82eeea4-bd04-4fb1-8dbb-55bc60f6e4b7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a7b81773-e464-452b-8260-db459a075195", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T18:06:14.6942357-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "4079a27b-35e2-4e2b-9335-9ee052985bd9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T18:06:14.6942357-07:00", "MeasurementValueNeededDate": "2025-10-13T18:06:14.6942357-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0cf27dd7-81cb-4d14-93c0-74b1e74b8291", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T18:06:14.6942357-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-10-13T18:06:14.6942357-07:00", "MeasurementValueNeededDate": "2025-10-13T18:06:14.6942357-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "dbeb06a6-62b8-49d6-ac4c-a3dc932eb98e", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T18:06:14.6942357-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "2f1d777d-0884-447b-a2ca-7d0f5f42f249", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "e82eeea4-bd04-4fb1-8dbb-55bc60f6e4b7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a7b81773-e464-452b-8260-db459a075195", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T18:06:14.6942357-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-13T18:06:14.6942357-07:00", "Fields": [ { "FormTypeFieldId": "d89835e5-4296-410a-81d9-9539dfb91b11", "Section": { "FormTypeSectionId": "70b44bf8-585e-42bf-be8c-7442ea23977b", "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": "f0dc6a30-0a7f-40bb-b3b7-67ab702feb97", "Name": "sample string 1" }, "Unit": { "UnitId": "e2eb1feb-5d4b-43d5-b7a5-758de33de17c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "e164da15-3de5-4f78-a83d-29842cc29444", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T18:06:14.6942357-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": "d89835e5-4296-410a-81d9-9539dfb91b11", "Section": { "FormTypeSectionId": "70b44bf8-585e-42bf-be8c-7442ea23977b", "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": "f0dc6a30-0a7f-40bb-b3b7-67ab702feb97", "Name": "sample string 1" }, "Unit": { "UnitId": "e2eb1feb-5d4b-43d5-b7a5-758de33de17c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "e164da15-3de5-4f78-a83d-29842cc29444", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T18:06:14.6942357-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": "fc49fad8-a044-4ed6-901d-6a7c8e0f1bcf", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T18:06:14.6942357-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-10-13T18:06:14.6942357-07:00", "Location": "sample string 1", "TaskId": "208021f2-93b7-4060-9077-fe5fccad31eb", "Values": [ { "FormFieldValueId": "6068f6e1-c2ea-4c80-97a6-c256928e5e07", "FormTypeField": { "FormTypeFieldId": "d89835e5-4296-410a-81d9-9539dfb91b11", "Section": { "FormTypeSectionId": "70b44bf8-585e-42bf-be8c-7442ea23977b", "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": "f0dc6a30-0a7f-40bb-b3b7-67ab702feb97", "Name": "sample string 1" }, "Unit": { "UnitId": "e2eb1feb-5d4b-43d5-b7a5-758de33de17c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "e164da15-3de5-4f78-a83d-29842cc29444", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T18:06:14.6942357-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" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" }, { "FormFieldValueId": "6068f6e1-c2ea-4c80-97a6-c256928e5e07", "FormTypeField": { "FormTypeFieldId": "d89835e5-4296-410a-81d9-9539dfb91b11", "Section": { "FormTypeSectionId": "70b44bf8-585e-42bf-be8c-7442ea23977b", "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": "f0dc6a30-0a7f-40bb-b3b7-67ab702feb97", "Name": "sample string 1" }, "Unit": { "UnitId": "e2eb1feb-5d4b-43d5-b7a5-758de33de17c", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "e164da15-3de5-4f78-a83d-29842cc29444", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T18:06:14.6942357-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" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" } ], "SourceSystemId": "sample string 2", "CompanyId": "99a4426b-3098-4401-ac40-6fc7325c244a", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-10-13T18:06:14.6942357-07:00", "LastModifiedUser": "sample string 5" }
Response Information
Resource Description
On success, the created form.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Form |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "FormId": "7e6e4583-79f7-4a90-9449-96b945ddc621", "Asset": { "AssetId": "c10226b1-c09f-4ecd-b720-5f27f5e54d9f", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "303d072e-2da9-47a0-afe1-fa9119736260", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f0a28244-4a8b-4077-888c-32fcfa793144", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T18:06:14.6942357-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "41e3e688-bdf1-41bc-9eaf-6afd03b85391", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-10-13T18:06:14.6942357-07:00", "MeasurementValueNeededDate": "2025-10-13T18:06:14.6942357-07:00", "SourceSystemId": "sample string 3", "CompanyId": "bc2aa1d0-073c-449b-9b28-2ab4cd47b5b7", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T18:06:14.6942357-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-10-13T18:06:14.6942357-07:00", "MeasurementValueNeededDate": "2025-10-13T18:06:14.6942357-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "67de3ebf-5517-4a9b-a545-29bdd9c22ed2", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-10-13T18:06:14.6942357-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "dc7d3b42-c596-4aa5-b8bc-a93c70459e93", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "303d072e-2da9-47a0-afe1-fa9119736260", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f0a28244-4a8b-4077-888c-32fcfa793144", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-10-13T18:06:14.6942357-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-10-13T18:06:14.6942357-07:00", "Fields": [ { "FormTypeFieldId": "5e3b74ff-5746-4216-885a-6b76274eac55", "Section": { "FormTypeSectionId": "0503f1f6-1bd9-4640-a11c-2b3334b218f2", "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": "ebc46583-68a4-47b8-814e-e7781312a7b9", "Name": "sample string 1" }, "Unit": { "UnitId": "0225e7b6-edc9-466a-b481-63966485d3b4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f4b0e031-aa0a-4b89-b495-20ce1ebe2f71", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T18:06:14.6942357-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": "5e3b74ff-5746-4216-885a-6b76274eac55", "Section": { "FormTypeSectionId": "0503f1f6-1bd9-4640-a11c-2b3334b218f2", "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": "ebc46583-68a4-47b8-814e-e7781312a7b9", "Name": "sample string 1" }, "Unit": { "UnitId": "0225e7b6-edc9-466a-b481-63966485d3b4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f4b0e031-aa0a-4b89-b495-20ce1ebe2f71", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T18:06:14.6942357-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": "9e647756-0eca-4d50-96cc-6b640f4de47c", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T18:06:14.6942357-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-10-13T18:06:14.6942357-07:00", "Location": "sample string 1", "TaskId": "b77a2cb5-08e6-4082-89bd-96fb55b10c02", "Values": [ { "FormFieldValueId": "b8e7a7d1-d88c-4e79-8f58-6b7d5f747b1c", "FormTypeField": { "FormTypeFieldId": "5e3b74ff-5746-4216-885a-6b76274eac55", "Section": { "FormTypeSectionId": "0503f1f6-1bd9-4640-a11c-2b3334b218f2", "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": "ebc46583-68a4-47b8-814e-e7781312a7b9", "Name": "sample string 1" }, "Unit": { "UnitId": "0225e7b6-edc9-466a-b481-63966485d3b4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f4b0e031-aa0a-4b89-b495-20ce1ebe2f71", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T18:06:14.6942357-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" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" }, { "FormFieldValueId": "b8e7a7d1-d88c-4e79-8f58-6b7d5f747b1c", "FormTypeField": { "FormTypeFieldId": "5e3b74ff-5746-4216-885a-6b76274eac55", "Section": { "FormTypeSectionId": "0503f1f6-1bd9-4640-a11c-2b3334b218f2", "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": "ebc46583-68a4-47b8-814e-e7781312a7b9", "Name": "sample string 1" }, "Unit": { "UnitId": "0225e7b6-edc9-466a-b481-63966485d3b4", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f4b0e031-aa0a-4b89-b495-20ce1ebe2f71", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-10-13T18:06:14.6942357-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" }, "SectionIndex": 1, "FieldIndex": 1, "FileName": "sample string 1", "FileType": "sample string 2", "FileSize": 1, "FileContent": "QEA=", "ValueText": "sample string 3", "IsValid": true, "IsValidMessage": "sample string 5", "SourceSystemId": "sample string 6" } ], "SourceSystemId": "sample string 2", "CompanyId": "63679a6a-6dd1-4106-8310-7228f0665ae5", "CreateDate": "2025-10-13T18:06:14.6942357-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-10-13T18:06:14.6942357-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }