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": "e7f85969-ce50-4d28-b055-6a37f6d7bec8", "Asset": { "AssetId": "867c57a1-a394-4bd5-ad1f-d74a96dbc446", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "15ff69ea-dc6c-478c-abe5-217ad9cc3919", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f4bc84c8-0794-4850-8b2d-3150ae7b1147", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-30T12:53:53.2698264-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "b90f5a52-1433-47ff-af6b-a2a0fa50a7d0", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:53:53.2698264-07:00", "MeasurementValueNeededDate": "2025-08-30T12:53:53.2698264-07:00", "SourceSystemId": "sample string 3", "CompanyId": "990bb676-d53d-4df6-8572-42aa09ca0ddb", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2698264-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-08-30T12:53:53.2698264-07:00", "MeasurementValueNeededDate": "2025-08-30T12:53:53.2698264-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "1464e898-277f-45da-aa09-a66ec09ab40e", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-30T12:53:53.2698264-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "54d1849b-160b-45ff-9534-52e01ad6eadb", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "15ff69ea-dc6c-478c-abe5-217ad9cc3919", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f4bc84c8-0794-4850-8b2d-3150ae7b1147", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-30T12:53:53.2698264-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-30T12:53:53.2698264-07:00", "Fields": [ { "FormTypeFieldId": "a0f279cc-1559-4b71-9a06-04c2127430f1", "Section": { "FormTypeSectionId": "6def875a-1e1b-4ce6-8ac8-26a69c19f53c", "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": "4a0c683c-6931-401b-9ac8-a8c785c55a90", "Name": "sample string 1" }, "Unit": { "UnitId": "141ad619-e2f4-499e-b6e5-fa28fef2f404", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a758737c-1e98-4d3a-ba4b-3dee150ea725", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2698264-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": "a0f279cc-1559-4b71-9a06-04c2127430f1", "Section": { "FormTypeSectionId": "6def875a-1e1b-4ce6-8ac8-26a69c19f53c", "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": "4a0c683c-6931-401b-9ac8-a8c785c55a90", "Name": "sample string 1" }, "Unit": { "UnitId": "141ad619-e2f4-499e-b6e5-fa28fef2f404", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a758737c-1e98-4d3a-ba4b-3dee150ea725", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2698264-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": "b0e25278-1033-46b4-83c7-7c04c0cf011c", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2698264-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-08-30T12:53:53.2698264-07:00", "Location": "sample string 1", "TaskId": "3fed1c66-5fd0-4758-95bb-d109a05b57d6", "Values": [ { "FormFieldValueId": "df899a46-7821-4e88-a9e1-3c6de6ddd88f", "FormTypeField": { "FormTypeFieldId": "a0f279cc-1559-4b71-9a06-04c2127430f1", "Section": { "FormTypeSectionId": "6def875a-1e1b-4ce6-8ac8-26a69c19f53c", "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": "4a0c683c-6931-401b-9ac8-a8c785c55a90", "Name": "sample string 1" }, "Unit": { "UnitId": "141ad619-e2f4-499e-b6e5-fa28fef2f404", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a758737c-1e98-4d3a-ba4b-3dee150ea725", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2698264-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": "df899a46-7821-4e88-a9e1-3c6de6ddd88f", "FormTypeField": { "FormTypeFieldId": "a0f279cc-1559-4b71-9a06-04c2127430f1", "Section": { "FormTypeSectionId": "6def875a-1e1b-4ce6-8ac8-26a69c19f53c", "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": "4a0c683c-6931-401b-9ac8-a8c785c55a90", "Name": "sample string 1" }, "Unit": { "UnitId": "141ad619-e2f4-499e-b6e5-fa28fef2f404", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "a758737c-1e98-4d3a-ba4b-3dee150ea725", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2698264-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": "fa6ef49e-781d-41c2-8745-8a5d77a7f91a", "CreateDate": "2025-08-30T12:53:53.2698264-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-08-30T12:53:53.2698264-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": "a894f786-650b-4775-a150-992eefe22f86", "Asset": { "AssetId": "33ca1d1a-13cc-4473-aa29-d5751fa65c72", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "f47eb4f4-52ac-4bf9-952d-50785833e7fe", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bc98b3c9-3856-4dfb-b03a-ff7ae5a47e56", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-30T12:53:53.2854926-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "3eb44e34-9343-4f48-b18f-6c5ac07b1ed7", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-08-30T12:53:53.2854926-07:00", "MeasurementValueNeededDate": "2025-08-30T12:53:53.2854926-07:00", "SourceSystemId": "sample string 3", "CompanyId": "a2cbf2c1-f742-4bec-a0fe-ee17a21cf215", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2854926-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-08-30T12:53:53.2854926-07:00", "MeasurementValueNeededDate": "2025-08-30T12:53:53.2854926-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "a041077a-4f2b-416f-84d5-9a2b2cd11b6b", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-08-30T12:53:53.2854926-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "b57eba92-acf2-4d3d-a651-f7d649a62383", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "f47eb4f4-52ac-4bf9-952d-50785833e7fe", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "bc98b3c9-3856-4dfb-b03a-ff7ae5a47e56", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-08-30T12:53:53.2854926-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-08-30T12:53:53.2854926-07:00", "Fields": [ { "FormTypeFieldId": "447ce21c-f456-4b81-9bc4-807d064bee22", "Section": { "FormTypeSectionId": "ad7d2904-a22f-4f7e-b5fe-05dd506746fc", "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": "f8e2f375-f1c7-4a77-ad11-12290b54eda4", "Name": "sample string 1" }, "Unit": { "UnitId": "add926e2-f120-4914-8399-0a48dc777c3e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fde57900-10c3-4b28-a817-d31caa3b9ac3", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2854926-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": "447ce21c-f456-4b81-9bc4-807d064bee22", "Section": { "FormTypeSectionId": "ad7d2904-a22f-4f7e-b5fe-05dd506746fc", "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": "f8e2f375-f1c7-4a77-ad11-12290b54eda4", "Name": "sample string 1" }, "Unit": { "UnitId": "add926e2-f120-4914-8399-0a48dc777c3e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fde57900-10c3-4b28-a817-d31caa3b9ac3", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2854926-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": "9419d358-9682-4ca2-a428-b9c4b94d35fd", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2854926-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-08-30T12:53:53.2854926-07:00", "Location": "sample string 1", "TaskId": "4a8e3e2c-07c4-48c3-898f-d761255443f7", "Values": [ { "FormFieldValueId": "45432c71-b6fd-434a-abbb-324177f96f21", "FormTypeField": { "FormTypeFieldId": "447ce21c-f456-4b81-9bc4-807d064bee22", "Section": { "FormTypeSectionId": "ad7d2904-a22f-4f7e-b5fe-05dd506746fc", "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": "f8e2f375-f1c7-4a77-ad11-12290b54eda4", "Name": "sample string 1" }, "Unit": { "UnitId": "add926e2-f120-4914-8399-0a48dc777c3e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fde57900-10c3-4b28-a817-d31caa3b9ac3", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2854926-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": "45432c71-b6fd-434a-abbb-324177f96f21", "FormTypeField": { "FormTypeFieldId": "447ce21c-f456-4b81-9bc4-807d064bee22", "Section": { "FormTypeSectionId": "ad7d2904-a22f-4f7e-b5fe-05dd506746fc", "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": "f8e2f375-f1c7-4a77-ad11-12290b54eda4", "Name": "sample string 1" }, "Unit": { "UnitId": "add926e2-f120-4914-8399-0a48dc777c3e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "fde57900-10c3-4b28-a817-d31caa3b9ac3", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-08-30T12:53:53.2854926-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": "d06c6db6-b6cf-4099-be5a-80a59750e1d7", "CreateDate": "2025-08-30T12:53:53.2854926-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-08-30T12:53:53.2854926-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }