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": "43de8ff8-322c-4f9a-9a33-b6ec4db8bb7c", "Asset": { "AssetId": "153b1839-bb4e-47d6-9341-9820759be89b", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "6c6213b6-6f2d-4a42-a05a-a7fa2bd6f9de", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "87580873-03ef-408f-8444-0c79aba99448", "CreateDate": "2025-06-26T12:14:40.4611091-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-26T12:14:40.4611091-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "c3b3ea31-ebc6-4c0b-a9ca-69f82c0e3098", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-26T12:14:40.4611091-07:00", "MeasurementValueNeededDate": "2025-06-26T12:14:40.4611091-07:00", "SourceSystemId": "sample string 3", "CompanyId": "881e9888-98f9-4c34-8b38-10f83209563f", "CreateDate": "2025-06-26T12:14:40.4611091-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T12:14:40.4611091-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-26T12:14:40.4611091-07:00", "MeasurementValueNeededDate": "2025-06-26T12:14:40.4611091-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d538bc97-6933-4530-8a7f-af5ca444f761", "CreateDate": "2025-06-26T12:14:40.4611091-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-26T12:14:40.4611091-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "ef60f234-75e1-4aec-af85-140e9f1d7276", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "6c6213b6-6f2d-4a42-a05a-a7fa2bd6f9de", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "87580873-03ef-408f-8444-0c79aba99448", "CreateDate": "2025-06-26T12:14:40.4611091-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-26T12:14:40.4611091-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-26T12:14:40.4611091-07:00", "Fields": [ { "FormTypeFieldId": "2cdfff8e-2982-47a6-94d9-090d20fdd7fd", "Section": { "FormTypeSectionId": "ba2c4840-e628-40ae-ba69-42bbd8f6acc5", "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": "3d783f53-3ef3-4b04-91d5-30f8aadc18a1", "Name": "sample string 1" }, "Unit": { "UnitId": "534e9d32-086a-4d94-b8f2-a1a647e871dc", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "5a93a9db-9b8a-4655-a086-e9e70bab2a96", "CreateDate": "2025-06-26T12:14:40.4611091-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T12:14:40.4611091-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": "2cdfff8e-2982-47a6-94d9-090d20fdd7fd", "Section": { "FormTypeSectionId": "ba2c4840-e628-40ae-ba69-42bbd8f6acc5", "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": "3d783f53-3ef3-4b04-91d5-30f8aadc18a1", "Name": "sample string 1" }, "Unit": { "UnitId": "534e9d32-086a-4d94-b8f2-a1a647e871dc", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "5a93a9db-9b8a-4655-a086-e9e70bab2a96", "CreateDate": "2025-06-26T12:14:40.4611091-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T12:14:40.4611091-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": "770fb512-0cb5-4f91-bd33-0125f98a2a3e", "CreateDate": "2025-06-26T12:14:40.4611091-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T12:14:40.4611091-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-06-26T12:14:40.4611091-07:00", "Location": "sample string 1", "TaskId": "5ac16cf5-41f9-4744-8979-9aeb1515179d", "Values": [ { "FormFieldValueId": "75cda9eb-1a8e-40d6-b954-c2c2fd63d627", "FormTypeField": { "FormTypeFieldId": "2cdfff8e-2982-47a6-94d9-090d20fdd7fd", "Section": { "FormTypeSectionId": "ba2c4840-e628-40ae-ba69-42bbd8f6acc5", "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": "3d783f53-3ef3-4b04-91d5-30f8aadc18a1", "Name": "sample string 1" }, "Unit": { "UnitId": "534e9d32-086a-4d94-b8f2-a1a647e871dc", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "5a93a9db-9b8a-4655-a086-e9e70bab2a96", "CreateDate": "2025-06-26T12:14:40.4611091-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T12:14:40.4611091-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": "75cda9eb-1a8e-40d6-b954-c2c2fd63d627", "FormTypeField": { "FormTypeFieldId": "2cdfff8e-2982-47a6-94d9-090d20fdd7fd", "Section": { "FormTypeSectionId": "ba2c4840-e628-40ae-ba69-42bbd8f6acc5", "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": "3d783f53-3ef3-4b04-91d5-30f8aadc18a1", "Name": "sample string 1" }, "Unit": { "UnitId": "534e9d32-086a-4d94-b8f2-a1a647e871dc", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "5a93a9db-9b8a-4655-a086-e9e70bab2a96", "CreateDate": "2025-06-26T12:14:40.4611091-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T12:14:40.4611091-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": "96df92fb-b75e-495a-84d3-e5b8e039d98b", "CreateDate": "2025-06-26T12:14:40.4611091-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-26T12:14:40.4611091-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": "1bae0fbb-4a11-4c54-a80e-c30acf91bde8", "Asset": { "AssetId": "0a76ed83-d1e1-4250-84e0-8396b556429b", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "a0d8b551-2916-4055-b925-d589aa6cc5ba", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "af14f5e1-ec5e-4d86-9165-6571d97a54f8", "CreateDate": "2025-06-26T12:14:40.4923408-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-26T12:14:40.4923408-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "cdf8fe8f-5ef0-4307-88b9-a978c7ac4cfd", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-26T12:14:40.4923408-07:00", "MeasurementValueNeededDate": "2025-06-26T12:14:40.4923408-07:00", "SourceSystemId": "sample string 3", "CompanyId": "155cc87a-31a3-4623-b903-7dc6bea212bb", "CreateDate": "2025-06-26T12:14:40.4923408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T12:14:40.4923408-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-26T12:14:40.4923408-07:00", "MeasurementValueNeededDate": "2025-06-26T12:14:40.4923408-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "50280c55-cac3-47c2-9d1f-76f101de06c3", "CreateDate": "2025-06-26T12:14:40.4923408-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-26T12:14:40.4923408-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "2028591d-c7c0-4033-9301-33dab29240ff", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "a0d8b551-2916-4055-b925-d589aa6cc5ba", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "af14f5e1-ec5e-4d86-9165-6571d97a54f8", "CreateDate": "2025-06-26T12:14:40.4923408-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-26T12:14:40.4923408-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-26T12:14:40.4923408-07:00", "Fields": [ { "FormTypeFieldId": "508a8532-6974-4d8b-97fa-6c2f9e8ee609", "Section": { "FormTypeSectionId": "3978c5dd-6c84-4fc7-873a-b5959c5bc1cc", "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": "79984ada-cd44-41cf-a999-49dd948f5080", "Name": "sample string 1" }, "Unit": { "UnitId": "d36ab6c3-28b0-41f7-b284-8db2507a17b7", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "655d2219-dd6c-447f-af84-ba84a56ef594", "CreateDate": "2025-06-26T12:14:40.4923408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T12:14:40.4923408-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": "508a8532-6974-4d8b-97fa-6c2f9e8ee609", "Section": { "FormTypeSectionId": "3978c5dd-6c84-4fc7-873a-b5959c5bc1cc", "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": "79984ada-cd44-41cf-a999-49dd948f5080", "Name": "sample string 1" }, "Unit": { "UnitId": "d36ab6c3-28b0-41f7-b284-8db2507a17b7", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "655d2219-dd6c-447f-af84-ba84a56ef594", "CreateDate": "2025-06-26T12:14:40.4923408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T12:14:40.4923408-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": "681f22af-e108-4c8c-aead-2ad832d85c60", "CreateDate": "2025-06-26T12:14:40.4923408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T12:14:40.4923408-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-06-26T12:14:40.4923408-07:00", "Location": "sample string 1", "TaskId": "dfecc526-c97b-46b0-955b-141ef01c0295", "Values": [ { "FormFieldValueId": "f7b34ec0-0349-4121-897f-93d498afe2ae", "FormTypeField": { "FormTypeFieldId": "508a8532-6974-4d8b-97fa-6c2f9e8ee609", "Section": { "FormTypeSectionId": "3978c5dd-6c84-4fc7-873a-b5959c5bc1cc", "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": "79984ada-cd44-41cf-a999-49dd948f5080", "Name": "sample string 1" }, "Unit": { "UnitId": "d36ab6c3-28b0-41f7-b284-8db2507a17b7", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "655d2219-dd6c-447f-af84-ba84a56ef594", "CreateDate": "2025-06-26T12:14:40.4923408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T12:14:40.4923408-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": "f7b34ec0-0349-4121-897f-93d498afe2ae", "FormTypeField": { "FormTypeFieldId": "508a8532-6974-4d8b-97fa-6c2f9e8ee609", "Section": { "FormTypeSectionId": "3978c5dd-6c84-4fc7-873a-b5959c5bc1cc", "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": "79984ada-cd44-41cf-a999-49dd948f5080", "Name": "sample string 1" }, "Unit": { "UnitId": "d36ab6c3-28b0-41f7-b284-8db2507a17b7", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "655d2219-dd6c-447f-af84-ba84a56ef594", "CreateDate": "2025-06-26T12:14:40.4923408-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-26T12:14:40.4923408-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": "8122c009-9895-488f-858c-b4a00feeb7ce", "CreateDate": "2025-06-26T12:14:40.4923408-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-26T12:14:40.4923408-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }