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": "8a1f113b-eecd-456e-b88a-8121c7f29f57", "Asset": { "AssetId": "f91a4c9e-846c-4fd0-9fe9-7687f9fac5cd", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "690aa231-1683-42a6-9f30-1c803854d4e5", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "1c4c0a09-a7f4-4d2e-97b4-c195ed54da4e", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-25T06:10:19.4998011-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "48fc5335-cb36-4dcc-84ec-a032e6ce4622", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:10:19.4998011-07:00", "MeasurementValueNeededDate": "2025-06-25T06:10:19.4998011-07:00", "SourceSystemId": "sample string 3", "CompanyId": "8d044b16-28a9-457e-899c-27a6d9ab48f0", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:10:19.4998011-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-25T06:10:19.4998011-07:00", "MeasurementValueNeededDate": "2025-06-25T06:10:19.4998011-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "ec79d9a0-5394-4a0e-9698-27bfb06101e1", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-25T06:10:19.4998011-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "36c054fe-458e-4211-9bdf-436d71367036", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "690aa231-1683-42a6-9f30-1c803854d4e5", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "1c4c0a09-a7f4-4d2e-97b4-c195ed54da4e", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-25T06:10:19.4998011-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-25T06:10:19.4998011-07:00", "Fields": [ { "FormTypeFieldId": "8485184b-7c17-4dfc-b2f4-2876d5467fe3", "Section": { "FormTypeSectionId": "c2a1ee08-71dc-47c3-9ae2-59ff08d0532c", "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": "6e692df0-66c7-4958-8a00-b813910750dc", "Name": "sample string 1" }, "Unit": { "UnitId": "a2644c74-68d4-4a56-897a-40a50de99745", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "bbf0b497-ceba-48c5-b7ca-58d905a160ad", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:10:19.4998011-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": "8485184b-7c17-4dfc-b2f4-2876d5467fe3", "Section": { "FormTypeSectionId": "c2a1ee08-71dc-47c3-9ae2-59ff08d0532c", "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": "6e692df0-66c7-4958-8a00-b813910750dc", "Name": "sample string 1" }, "Unit": { "UnitId": "a2644c74-68d4-4a56-897a-40a50de99745", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "bbf0b497-ceba-48c5-b7ca-58d905a160ad", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:10:19.4998011-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": "299fac0d-18cb-4ae4-91d3-22955a3de80a", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:10:19.4998011-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-06-25T06:10:19.4998011-07:00", "Location": "sample string 1", "TaskId": "cd66e030-bd00-4133-8f9a-e855e53e24c5", "Values": [ { "FormFieldValueId": "89426303-e248-4233-a0bb-c6757ea765f2", "FormTypeField": { "FormTypeFieldId": "8485184b-7c17-4dfc-b2f4-2876d5467fe3", "Section": { "FormTypeSectionId": "c2a1ee08-71dc-47c3-9ae2-59ff08d0532c", "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": "6e692df0-66c7-4958-8a00-b813910750dc", "Name": "sample string 1" }, "Unit": { "UnitId": "a2644c74-68d4-4a56-897a-40a50de99745", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "bbf0b497-ceba-48c5-b7ca-58d905a160ad", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:10:19.4998011-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": "89426303-e248-4233-a0bb-c6757ea765f2", "FormTypeField": { "FormTypeFieldId": "8485184b-7c17-4dfc-b2f4-2876d5467fe3", "Section": { "FormTypeSectionId": "c2a1ee08-71dc-47c3-9ae2-59ff08d0532c", "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": "6e692df0-66c7-4958-8a00-b813910750dc", "Name": "sample string 1" }, "Unit": { "UnitId": "a2644c74-68d4-4a56-897a-40a50de99745", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "bbf0b497-ceba-48c5-b7ca-58d905a160ad", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:10:19.4998011-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": "a675337d-8c37-4ec7-a537-b1a67fff11e5", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-25T06:10:19.4998011-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": "2b241509-4a21-41e4-b0c3-d27c9a48168c", "Asset": { "AssetId": "34f8846a-aa5a-447a-93b6-5624c14e630d", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "840a256f-d053-4bdd-bbbf-49396d62fa64", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "52f4efa1-b2ea-44d3-bf34-12dad56d77b7", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-25T06:10:19.4998011-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "3fa62a53-fe38-40f1-8a4b-ac110fe8ed1d", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-25T06:10:19.4998011-07:00", "MeasurementValueNeededDate": "2025-06-25T06:10:19.4998011-07:00", "SourceSystemId": "sample string 3", "CompanyId": "0b0624e1-0e5b-4c7c-8642-591c378573cb", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:10:19.4998011-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-25T06:10:19.4998011-07:00", "MeasurementValueNeededDate": "2025-06-25T06:10:19.4998011-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "47e63992-9e4d-4bbc-9a6a-b3ba6c2f62bb", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-25T06:10:19.4998011-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "01245d4f-05a7-4b05-b06f-70933848801e", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "840a256f-d053-4bdd-bbbf-49396d62fa64", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "52f4efa1-b2ea-44d3-bf34-12dad56d77b7", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-25T06:10:19.4998011-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-25T06:10:19.4998011-07:00", "Fields": [ { "FormTypeFieldId": "e1584385-ea54-4e36-b987-966f4a4bebc3", "Section": { "FormTypeSectionId": "1ed507c4-4a3a-4f5a-aa20-206522f50661", "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": "8facb667-fdf3-43c5-b357-9db50c2349d8", "Name": "sample string 1" }, "Unit": { "UnitId": "c6922835-46b7-45f6-8ba6-398cf170bcb6", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9d833370-3d86-4e72-bc7c-2e25be6a3e37", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:10:19.4998011-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": "e1584385-ea54-4e36-b987-966f4a4bebc3", "Section": { "FormTypeSectionId": "1ed507c4-4a3a-4f5a-aa20-206522f50661", "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": "8facb667-fdf3-43c5-b357-9db50c2349d8", "Name": "sample string 1" }, "Unit": { "UnitId": "c6922835-46b7-45f6-8ba6-398cf170bcb6", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9d833370-3d86-4e72-bc7c-2e25be6a3e37", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:10:19.4998011-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": "e033af90-ffdb-449b-9cd2-d156a8479a5a", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:10:19.4998011-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-06-25T06:10:19.4998011-07:00", "Location": "sample string 1", "TaskId": "61844e64-33f5-4f75-91b5-2c23757d0ea5", "Values": [ { "FormFieldValueId": "b080a321-e452-46fc-9110-b15d6a612133", "FormTypeField": { "FormTypeFieldId": "e1584385-ea54-4e36-b987-966f4a4bebc3", "Section": { "FormTypeSectionId": "1ed507c4-4a3a-4f5a-aa20-206522f50661", "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": "8facb667-fdf3-43c5-b357-9db50c2349d8", "Name": "sample string 1" }, "Unit": { "UnitId": "c6922835-46b7-45f6-8ba6-398cf170bcb6", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9d833370-3d86-4e72-bc7c-2e25be6a3e37", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:10:19.4998011-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": "b080a321-e452-46fc-9110-b15d6a612133", "FormTypeField": { "FormTypeFieldId": "e1584385-ea54-4e36-b987-966f4a4bebc3", "Section": { "FormTypeSectionId": "1ed507c4-4a3a-4f5a-aa20-206522f50661", "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": "8facb667-fdf3-43c5-b357-9db50c2349d8", "Name": "sample string 1" }, "Unit": { "UnitId": "c6922835-46b7-45f6-8ba6-398cf170bcb6", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9d833370-3d86-4e72-bc7c-2e25be6a3e37", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-25T06:10:19.4998011-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": "72b3d579-d48d-4d48-bf83-31caae4b5185", "CreateDate": "2025-06-25T06:10:19.4998011-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-25T06:10:19.4998011-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }