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": "8af5fa5d-2969-434d-a79d-01ff813be175", "Asset": { "AssetId": "90b85c92-374c-4d59-85e0-1b1f598953ee", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "2b57d0e7-9666-490d-bf03-517fcae6c18c", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "257fbfb8-df0d-4e93-95de-400e48af8c2a", "CreateDate": "2025-09-16T01:54:17.4824307-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-16T01:54:17.4824307-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "320c18e5-03a1-4a2b-87a9-f977a1a8b0ad", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-16T01:54:17.4824307-07:00", "MeasurementValueNeededDate": "2025-09-16T01:54:17.4824307-07:00", "SourceSystemId": "sample string 3", "CompanyId": "128dc0ac-2349-45fe-a989-ce9f7a2d6f9b", "CreateDate": "2025-09-16T01:54:17.4824307-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:54:17.4824307-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-09-16T01:54:17.4824307-07:00", "MeasurementValueNeededDate": "2025-09-16T01:54:17.4824307-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e276ba36-c63e-4264-ba2d-820cf69d060e", "CreateDate": "2025-09-16T01:54:17.4824307-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-16T01:54:17.4824307-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "1ff4aac0-5d0a-4845-9091-efe48f81b7b7", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "2b57d0e7-9666-490d-bf03-517fcae6c18c", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "257fbfb8-df0d-4e93-95de-400e48af8c2a", "CreateDate": "2025-09-16T01:54:17.4824307-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-16T01:54:17.4824307-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-16T01:54:17.4824307-07:00", "Fields": [ { "FormTypeFieldId": "307336a0-365c-427c-bb7d-1222737beada", "Section": { "FormTypeSectionId": "57ef535c-88fc-446c-8a40-bbbb495f84f3", "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": "dcf164b9-7485-424d-930b-e2fcddc201e5", "Name": "sample string 1" }, "Unit": { "UnitId": "18b3a015-3a4a-422a-9b22-a101bc53ce1a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "41701586-3988-4ee5-9097-5998ba51b4ad", "CreateDate": "2025-09-16T01:54:17.4824307-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:54:17.4824307-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": "307336a0-365c-427c-bb7d-1222737beada", "Section": { "FormTypeSectionId": "57ef535c-88fc-446c-8a40-bbbb495f84f3", "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": "dcf164b9-7485-424d-930b-e2fcddc201e5", "Name": "sample string 1" }, "Unit": { "UnitId": "18b3a015-3a4a-422a-9b22-a101bc53ce1a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "41701586-3988-4ee5-9097-5998ba51b4ad", "CreateDate": "2025-09-16T01:54:17.4824307-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:54:17.4824307-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": "64e753da-0449-47f6-9afe-08ba4c239890", "CreateDate": "2025-09-16T01:54:17.4824307-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:54:17.4824307-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-09-16T01:54:17.4824307-07:00", "Location": "sample string 1", "TaskId": "9bc60c68-97f4-4944-a5b6-35cef184ddfa", "Values": [ { "FormFieldValueId": "7cce6302-35eb-446a-b536-84276452ebd7", "FormTypeField": { "FormTypeFieldId": "307336a0-365c-427c-bb7d-1222737beada", "Section": { "FormTypeSectionId": "57ef535c-88fc-446c-8a40-bbbb495f84f3", "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": "dcf164b9-7485-424d-930b-e2fcddc201e5", "Name": "sample string 1" }, "Unit": { "UnitId": "18b3a015-3a4a-422a-9b22-a101bc53ce1a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "41701586-3988-4ee5-9097-5998ba51b4ad", "CreateDate": "2025-09-16T01:54:17.4824307-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:54:17.4824307-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": "7cce6302-35eb-446a-b536-84276452ebd7", "FormTypeField": { "FormTypeFieldId": "307336a0-365c-427c-bb7d-1222737beada", "Section": { "FormTypeSectionId": "57ef535c-88fc-446c-8a40-bbbb495f84f3", "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": "dcf164b9-7485-424d-930b-e2fcddc201e5", "Name": "sample string 1" }, "Unit": { "UnitId": "18b3a015-3a4a-422a-9b22-a101bc53ce1a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "41701586-3988-4ee5-9097-5998ba51b4ad", "CreateDate": "2025-09-16T01:54:17.4824307-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:54:17.4824307-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": "a904608b-1179-412c-bd09-6c3277e049e9", "CreateDate": "2025-09-16T01:54:17.4824307-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-16T01:54:17.4824307-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": "bdc793e9-a0e1-4e75-ac4d-c24a4b00e999", "Asset": { "AssetId": "5f85509c-a167-4383-931a-740af9ca54d5", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "c8776bd5-fff0-4c78-acd9-b8deaaa0f45c", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5d6b1461-756a-479c-b1d3-0eb358108e70", "CreateDate": "2025-09-16T01:54:17.498142-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-16T01:54:17.498142-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "d93b3c66-dd6f-4a44-9c02-5feb2a289311", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-09-16T01:54:17.498142-07:00", "MeasurementValueNeededDate": "2025-09-16T01:54:17.498142-07:00", "SourceSystemId": "sample string 3", "CompanyId": "feddb27e-5203-4c37-9b91-52b63b68f842", "CreateDate": "2025-09-16T01:54:17.498142-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:54:17.498142-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-09-16T01:54:17.498142-07:00", "MeasurementValueNeededDate": "2025-09-16T01:54:17.498142-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "93fa959e-07ce-41e4-b416-73b855ff77f5", "CreateDate": "2025-09-16T01:54:17.498142-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-09-16T01:54:17.498142-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "6db68781-283c-4c66-b311-c45238906d98", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "c8776bd5-fff0-4c78-acd9-b8deaaa0f45c", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5d6b1461-756a-479c-b1d3-0eb358108e70", "CreateDate": "2025-09-16T01:54:17.498142-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-09-16T01:54:17.498142-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-09-16T01:54:17.498142-07:00", "Fields": [ { "FormTypeFieldId": "2994c447-a3c0-44c6-b0ab-8503bbe7d64f", "Section": { "FormTypeSectionId": "fb91b851-1257-40e4-ad48-93f17df197a8", "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": "54d3d388-06c2-42ad-806b-9d891960b1d5", "Name": "sample string 1" }, "Unit": { "UnitId": "3c921467-98fc-401c-8486-35b9dcced51d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a64edb12-d887-4ece-a99f-20c3562c0d8a", "CreateDate": "2025-09-16T01:54:17.498142-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:54:17.498142-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": "2994c447-a3c0-44c6-b0ab-8503bbe7d64f", "Section": { "FormTypeSectionId": "fb91b851-1257-40e4-ad48-93f17df197a8", "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": "54d3d388-06c2-42ad-806b-9d891960b1d5", "Name": "sample string 1" }, "Unit": { "UnitId": "3c921467-98fc-401c-8486-35b9dcced51d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a64edb12-d887-4ece-a99f-20c3562c0d8a", "CreateDate": "2025-09-16T01:54:17.498142-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:54:17.498142-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": "23a941c1-c1cd-40fc-a12c-d18af0009f5d", "CreateDate": "2025-09-16T01:54:17.498142-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:54:17.498142-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-09-16T01:54:17.498142-07:00", "Location": "sample string 1", "TaskId": "9369ee60-4cb1-4dae-a63d-c818bb41e9e7", "Values": [ { "FormFieldValueId": "d1b4ffcb-c108-4f72-aced-be13e40e414f", "FormTypeField": { "FormTypeFieldId": "2994c447-a3c0-44c6-b0ab-8503bbe7d64f", "Section": { "FormTypeSectionId": "fb91b851-1257-40e4-ad48-93f17df197a8", "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": "54d3d388-06c2-42ad-806b-9d891960b1d5", "Name": "sample string 1" }, "Unit": { "UnitId": "3c921467-98fc-401c-8486-35b9dcced51d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a64edb12-d887-4ece-a99f-20c3562c0d8a", "CreateDate": "2025-09-16T01:54:17.498142-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:54:17.498142-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": "d1b4ffcb-c108-4f72-aced-be13e40e414f", "FormTypeField": { "FormTypeFieldId": "2994c447-a3c0-44c6-b0ab-8503bbe7d64f", "Section": { "FormTypeSectionId": "fb91b851-1257-40e4-ad48-93f17df197a8", "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": "54d3d388-06c2-42ad-806b-9d891960b1d5", "Name": "sample string 1" }, "Unit": { "UnitId": "3c921467-98fc-401c-8486-35b9dcced51d", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a64edb12-d887-4ece-a99f-20c3562c0d8a", "CreateDate": "2025-09-16T01:54:17.498142-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-09-16T01:54:17.498142-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": "f898ae1f-9229-42d1-9e7c-97c6a6eaca8c", "CreateDate": "2025-09-16T01:54:17.498142-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-09-16T01:54:17.498142-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }