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": "095b0b4d-8214-4577-a1ad-7ce981e95423", "Asset": { "AssetId": "7a8c4925-5d3a-49c1-b4bc-556c5ae59d83", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "2002533a-ab38-472e-86fb-e41ae784a0f8", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "10e7c6d1-3f6d-4663-9b29-0e4b4e882eeb", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T01:56:25.0254477-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "862fc7c3-4f24-4dcf-8fcf-66b660234acb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T01:56:25.0254477-07:00", "MeasurementValueNeededDate": "2025-05-09T01:56:25.0254477-07:00", "SourceSystemId": "sample string 3", "CompanyId": "acbae824-f131-45ce-8974-35b2d35ab138", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:56:25.0254477-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-09T01:56:25.0254477-07:00", "MeasurementValueNeededDate": "2025-05-09T01:56:25.0254477-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "8259293a-ee82-4614-96f0-fc0bf20fd344", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T01:56:25.0254477-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "0dcdd8a7-b592-440f-b6ae-76bef68ed3bc", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "2002533a-ab38-472e-86fb-e41ae784a0f8", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "10e7c6d1-3f6d-4663-9b29-0e4b4e882eeb", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T01:56:25.0254477-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-09T01:56:25.0254477-07:00", "Fields": [ { "FormTypeFieldId": "8312ffca-f4ff-4c29-8ebd-5da38d454c5e", "Section": { "FormTypeSectionId": "b073381d-40b1-4a97-9637-6bb3f2372d44", "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": "cb4613e1-8705-4e4f-8de5-cc10a6f75a7a", "Name": "sample string 1" }, "Unit": { "UnitId": "b15341e9-cdb3-46fa-a1ca-2f4e88d7ada2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "154d5bea-d4af-4ac0-8af9-4198beb5c328", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:56:25.0254477-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": "8312ffca-f4ff-4c29-8ebd-5da38d454c5e", "Section": { "FormTypeSectionId": "b073381d-40b1-4a97-9637-6bb3f2372d44", "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": "cb4613e1-8705-4e4f-8de5-cc10a6f75a7a", "Name": "sample string 1" }, "Unit": { "UnitId": "b15341e9-cdb3-46fa-a1ca-2f4e88d7ada2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "154d5bea-d4af-4ac0-8af9-4198beb5c328", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:56:25.0254477-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": "b3af4e31-3191-4d21-9915-8703e865ae83", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:56:25.0254477-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-05-09T01:56:25.0254477-07:00", "Location": "sample string 1", "TaskId": "423b06b3-9b04-4dc6-b495-cfb1d32b208b", "Values": [ { "FormFieldValueId": "78146759-3fe8-41b2-b77a-54c2e3c8373f", "FormTypeField": { "FormTypeFieldId": "8312ffca-f4ff-4c29-8ebd-5da38d454c5e", "Section": { "FormTypeSectionId": "b073381d-40b1-4a97-9637-6bb3f2372d44", "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": "cb4613e1-8705-4e4f-8de5-cc10a6f75a7a", "Name": "sample string 1" }, "Unit": { "UnitId": "b15341e9-cdb3-46fa-a1ca-2f4e88d7ada2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "154d5bea-d4af-4ac0-8af9-4198beb5c328", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:56:25.0254477-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": "78146759-3fe8-41b2-b77a-54c2e3c8373f", "FormTypeField": { "FormTypeFieldId": "8312ffca-f4ff-4c29-8ebd-5da38d454c5e", "Section": { "FormTypeSectionId": "b073381d-40b1-4a97-9637-6bb3f2372d44", "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": "cb4613e1-8705-4e4f-8de5-cc10a6f75a7a", "Name": "sample string 1" }, "Unit": { "UnitId": "b15341e9-cdb3-46fa-a1ca-2f4e88d7ada2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "154d5bea-d4af-4ac0-8af9-4198beb5c328", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:56:25.0254477-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": "ffcd273d-2cfd-4fea-a327-6a592aad0710", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-09T01:56:25.0254477-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": "40786aa7-70ed-4f73-b5b4-e7215ad92a3d", "Asset": { "AssetId": "7268471a-3607-4f8c-9e34-49b2ee76db06", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d2b02669-59d2-4e13-a940-b680bd30e0f0", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "224302da-38b1-42a5-8f2c-5727a9abf52f", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T01:56:25.0254477-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "437ea1ea-d41a-455e-a5bb-da8f3f2b53a9", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-05-09T01:56:25.0254477-07:00", "MeasurementValueNeededDate": "2025-05-09T01:56:25.0254477-07:00", "SourceSystemId": "sample string 3", "CompanyId": "35f163ae-46d8-402c-88fb-9ea82e000a5a", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:56:25.0254477-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-05-09T01:56:25.0254477-07:00", "MeasurementValueNeededDate": "2025-05-09T01:56:25.0254477-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "b6baec69-e539-4243-9f3c-2e026f58af86", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-05-09T01:56:25.0254477-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "e1ffedca-7ca7-4254-9e75-6856bf467089", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "d2b02669-59d2-4e13-a940-b680bd30e0f0", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "224302da-38b1-42a5-8f2c-5727a9abf52f", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-05-09T01:56:25.0254477-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-05-09T01:56:25.0254477-07:00", "Fields": [ { "FormTypeFieldId": "76caffcd-a63e-4bde-89cc-d3b5563ab640", "Section": { "FormTypeSectionId": "dc62d825-4c20-4be6-8191-9c0fef2dfd8d", "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": "61b34cac-46cf-4ff2-8200-83d4d6d86938", "Name": "sample string 1" }, "Unit": { "UnitId": "4ffe93cc-f294-493c-a3e8-8c54f819852a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "719ea7d8-958d-4acc-9643-9fa12bf4fd56", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:56:25.0254477-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": "76caffcd-a63e-4bde-89cc-d3b5563ab640", "Section": { "FormTypeSectionId": "dc62d825-4c20-4be6-8191-9c0fef2dfd8d", "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": "61b34cac-46cf-4ff2-8200-83d4d6d86938", "Name": "sample string 1" }, "Unit": { "UnitId": "4ffe93cc-f294-493c-a3e8-8c54f819852a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "719ea7d8-958d-4acc-9643-9fa12bf4fd56", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:56:25.0254477-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": "036d16a6-ae4f-4a21-8903-b144d79619c9", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:56:25.0254477-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-05-09T01:56:25.0254477-07:00", "Location": "sample string 1", "TaskId": "e4f374e4-5558-40b5-ad8b-4675b1b920ac", "Values": [ { "FormFieldValueId": "6a007644-dc36-43a6-81a0-a0287fbc2f90", "FormTypeField": { "FormTypeFieldId": "76caffcd-a63e-4bde-89cc-d3b5563ab640", "Section": { "FormTypeSectionId": "dc62d825-4c20-4be6-8191-9c0fef2dfd8d", "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": "61b34cac-46cf-4ff2-8200-83d4d6d86938", "Name": "sample string 1" }, "Unit": { "UnitId": "4ffe93cc-f294-493c-a3e8-8c54f819852a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "719ea7d8-958d-4acc-9643-9fa12bf4fd56", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:56:25.0254477-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": "6a007644-dc36-43a6-81a0-a0287fbc2f90", "FormTypeField": { "FormTypeFieldId": "76caffcd-a63e-4bde-89cc-d3b5563ab640", "Section": { "FormTypeSectionId": "dc62d825-4c20-4be6-8191-9c0fef2dfd8d", "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": "61b34cac-46cf-4ff2-8200-83d4d6d86938", "Name": "sample string 1" }, "Unit": { "UnitId": "4ffe93cc-f294-493c-a3e8-8c54f819852a", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "719ea7d8-958d-4acc-9643-9fa12bf4fd56", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-05-09T01:56:25.0254477-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": "53649c71-65c4-42af-a264-33024ff84613", "CreateDate": "2025-05-09T01:56:25.0254477-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-05-09T01:56:25.0254477-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }