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": "6b4f5716-49b0-4fa2-91c4-5273d8c1e9ed", "Asset": { "AssetId": "aadfb6d1-ce5e-4ac0-86f0-7f47c4e25e49", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "71a4797f-a9d0-4e74-90b5-286193dd28bb", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5f50c43a-aa19-4c6e-8354-b3f53a496634", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T22:46:14.6597333-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "7700bd1b-924c-4259-83e5-76708d6e9fa8", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T22:46:14.6597333-07:00", "MeasurementValueNeededDate": "2025-07-31T22:46:14.6597333-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1ae2c3ae-a6a5-4003-b61d-a36bc71be4af", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T22:46:14.6597333-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-07-31T22:46:14.6597333-07:00", "MeasurementValueNeededDate": "2025-07-31T22:46:14.6597333-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "9f377533-1188-497b-b595-845e16c82c83", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-31T22:46:14.6597333-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "825a744b-2ecb-4fde-99db-43986f175c32", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "71a4797f-a9d0-4e74-90b5-286193dd28bb", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5f50c43a-aa19-4c6e-8354-b3f53a496634", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T22:46:14.6597333-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-31T22:46:14.6597333-07:00", "Fields": [ { "FormTypeFieldId": "7e8c5a85-d414-4175-819d-af87e1975a6f", "Section": { "FormTypeSectionId": "dee144cf-1b48-418d-bcbb-8bd3e3e27780", "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": "a0e1571d-fbcd-4b4f-af35-57ac9f7efca7", "Name": "sample string 1" }, "Unit": { "UnitId": "9504d202-420d-4f34-a0c3-2dbcc49f59bb", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "02719ace-e913-482c-8a3d-112c449bfe30", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T22:46:14.6597333-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": "7e8c5a85-d414-4175-819d-af87e1975a6f", "Section": { "FormTypeSectionId": "dee144cf-1b48-418d-bcbb-8bd3e3e27780", "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": "a0e1571d-fbcd-4b4f-af35-57ac9f7efca7", "Name": "sample string 1" }, "Unit": { "UnitId": "9504d202-420d-4f34-a0c3-2dbcc49f59bb", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "02719ace-e913-482c-8a3d-112c449bfe30", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T22:46:14.6597333-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": "5ef8dafe-8ac2-4380-b634-2780b417c71e", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T22:46:14.6597333-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-07-31T22:46:14.6597333-07:00", "Location": "sample string 1", "TaskId": "d67b7727-6774-4673-9043-bbe38349aaa1", "Values": [ { "FormFieldValueId": "d177001b-2b83-46b4-8d91-97ae75d028d9", "FormTypeField": { "FormTypeFieldId": "7e8c5a85-d414-4175-819d-af87e1975a6f", "Section": { "FormTypeSectionId": "dee144cf-1b48-418d-bcbb-8bd3e3e27780", "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": "a0e1571d-fbcd-4b4f-af35-57ac9f7efca7", "Name": "sample string 1" }, "Unit": { "UnitId": "9504d202-420d-4f34-a0c3-2dbcc49f59bb", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "02719ace-e913-482c-8a3d-112c449bfe30", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T22:46:14.6597333-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": "d177001b-2b83-46b4-8d91-97ae75d028d9", "FormTypeField": { "FormTypeFieldId": "7e8c5a85-d414-4175-819d-af87e1975a6f", "Section": { "FormTypeSectionId": "dee144cf-1b48-418d-bcbb-8bd3e3e27780", "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": "a0e1571d-fbcd-4b4f-af35-57ac9f7efca7", "Name": "sample string 1" }, "Unit": { "UnitId": "9504d202-420d-4f34-a0c3-2dbcc49f59bb", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "02719ace-e913-482c-8a3d-112c449bfe30", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T22:46:14.6597333-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": "fb5ebe07-e977-49fb-8149-81167ccde8e9", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-31T22:46:14.6597333-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": "580dd7e1-d517-42f2-bdd6-2f07a5cd3722", "Asset": { "AssetId": "d16c6aef-f26f-470f-ba3a-5e68e70507c0", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "f1ca4bd3-4ed8-43eb-ab05-ae04b7cf26f5", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0a40079c-0839-4c6e-a0fe-1130113be859", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T22:46:14.6597333-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "c63a6088-536b-44ab-85ba-a5aaefcdc090", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-31T22:46:14.6597333-07:00", "MeasurementValueNeededDate": "2025-07-31T22:46:14.6597333-07:00", "SourceSystemId": "sample string 3", "CompanyId": "19e74da5-4542-4b9a-957d-fc904689de75", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T22:46:14.6597333-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-07-31T22:46:14.6597333-07:00", "MeasurementValueNeededDate": "2025-07-31T22:46:14.6597333-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "a604c46c-fca7-4764-a460-3ab484d4a086", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-31T22:46:14.6597333-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "e599f9b2-4596-4d41-bb96-84272d66824f", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "f1ca4bd3-4ed8-43eb-ab05-ae04b7cf26f5", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0a40079c-0839-4c6e-a0fe-1130113be859", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-31T22:46:14.6597333-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-07-31T22:46:14.6597333-07:00", "Fields": [ { "FormTypeFieldId": "54575887-2ed1-46ff-b282-df636d74910d", "Section": { "FormTypeSectionId": "b1af8317-6c91-41e9-aba0-26f17665c937", "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": "53bee26f-e490-45d1-a88b-c68ad6731ec8", "Name": "sample string 1" }, "Unit": { "UnitId": "6bf4c42c-ce2f-48f6-8ee9-cbd236452f18", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "b9c4d8a2-9d40-488f-9053-17ab76ce4a20", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T22:46:14.6597333-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": "54575887-2ed1-46ff-b282-df636d74910d", "Section": { "FormTypeSectionId": "b1af8317-6c91-41e9-aba0-26f17665c937", "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": "53bee26f-e490-45d1-a88b-c68ad6731ec8", "Name": "sample string 1" }, "Unit": { "UnitId": "6bf4c42c-ce2f-48f6-8ee9-cbd236452f18", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "b9c4d8a2-9d40-488f-9053-17ab76ce4a20", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T22:46:14.6597333-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": "417a7683-4c46-4102-b532-08499b28c19a", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T22:46:14.6597333-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-07-31T22:46:14.6597333-07:00", "Location": "sample string 1", "TaskId": "6fb057b0-9ba4-4356-8f9d-7e968168f9f8", "Values": [ { "FormFieldValueId": "7608153c-6c5a-4b21-85d0-3d93a3711775", "FormTypeField": { "FormTypeFieldId": "54575887-2ed1-46ff-b282-df636d74910d", "Section": { "FormTypeSectionId": "b1af8317-6c91-41e9-aba0-26f17665c937", "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": "53bee26f-e490-45d1-a88b-c68ad6731ec8", "Name": "sample string 1" }, "Unit": { "UnitId": "6bf4c42c-ce2f-48f6-8ee9-cbd236452f18", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "b9c4d8a2-9d40-488f-9053-17ab76ce4a20", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T22:46:14.6597333-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": "7608153c-6c5a-4b21-85d0-3d93a3711775", "FormTypeField": { "FormTypeFieldId": "54575887-2ed1-46ff-b282-df636d74910d", "Section": { "FormTypeSectionId": "b1af8317-6c91-41e9-aba0-26f17665c937", "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": "53bee26f-e490-45d1-a88b-c68ad6731ec8", "Name": "sample string 1" }, "Unit": { "UnitId": "6bf4c42c-ce2f-48f6-8ee9-cbd236452f18", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "b9c4d8a2-9d40-488f-9053-17ab76ce4a20", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-31T22:46:14.6597333-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": "dbdb7fde-5c78-416b-ba40-35356343cb2d", "CreateDate": "2025-07-31T22:46:14.6597333-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-07-31T22:46:14.6597333-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }