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": "f75813bd-4201-443f-ba84-d65a1f4b64c9", "Asset": { "AssetId": "6a67f7d4-2db0-4546-879f-00efabcbacba", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "e8134203-89b0-4b13-be65-ff8c44db524e", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "ceff5979-0f26-44e8-b947-2909c4e71823", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "da9b862e-faac-4eb4-b74c-ec27f23870af", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-02-05T07:58:19.4138214-08:00", "MeasurementValueNeededDate": "2025-02-05T07:58:19.4138214-08:00", "SourceSystemId": "sample string 3", "CompanyId": "77e56d7b-3769-4bc7-a647-d3b7ac2b21fd", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-02-05T07:58:19.4138214-08:00", "MeasurementValueNeededDate": "2025-02-05T07:58:19.4138214-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "47e6fa8c-838d-4977-8b94-7f0ace066ca4", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "0c1b662f-1bd1-4202-8333-2223bcb09abc", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "e8134203-89b0-4b13-be65-ff8c44db524e", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "ceff5979-0f26-44e8-b947-2909c4e71823", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-02-05T07:58:19.4138214-08:00", "Fields": [ { "FormTypeFieldId": "55dcae1c-1d21-444f-ac70-26478ca73445", "Section": { "FormTypeSectionId": "a6e6ddf0-577f-40d2-9fe4-61fab7f557f4", "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": "02e980ab-a438-4db9-bed7-cb04f82def97", "Name": "sample string 1" }, "Unit": { "UnitId": "25453c69-c196-412f-8080-bfc24962492e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9c4c7d69-6825-431e-86ba-f496fff3ab4d", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08: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": "55dcae1c-1d21-444f-ac70-26478ca73445", "Section": { "FormTypeSectionId": "a6e6ddf0-577f-40d2-9fe4-61fab7f557f4", "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": "02e980ab-a438-4db9-bed7-cb04f82def97", "Name": "sample string 1" }, "Unit": { "UnitId": "25453c69-c196-412f-8080-bfc24962492e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9c4c7d69-6825-431e-86ba-f496fff3ab4d", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08: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": "e2ddcfc3-33da-4136-a9ee-2d556800c1e1", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-02-05T07:58:19.4138214-08:00", "Location": "sample string 1", "TaskId": "2e0d1ebe-7ba8-468f-96af-c1238b6df564", "Values": [ { "FormFieldValueId": "a7bb92a5-0b1d-40c8-aa73-853d20006954", "FormTypeField": { "FormTypeFieldId": "55dcae1c-1d21-444f-ac70-26478ca73445", "Section": { "FormTypeSectionId": "a6e6ddf0-577f-40d2-9fe4-61fab7f557f4", "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": "02e980ab-a438-4db9-bed7-cb04f82def97", "Name": "sample string 1" }, "Unit": { "UnitId": "25453c69-c196-412f-8080-bfc24962492e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9c4c7d69-6825-431e-86ba-f496fff3ab4d", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08: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": "a7bb92a5-0b1d-40c8-aa73-853d20006954", "FormTypeField": { "FormTypeFieldId": "55dcae1c-1d21-444f-ac70-26478ca73445", "Section": { "FormTypeSectionId": "a6e6ddf0-577f-40d2-9fe4-61fab7f557f4", "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": "02e980ab-a438-4db9-bed7-cb04f82def97", "Name": "sample string 1" }, "Unit": { "UnitId": "25453c69-c196-412f-8080-bfc24962492e", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "9c4c7d69-6825-431e-86ba-f496fff3ab4d", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08: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": "9c12706b-1574-46fe-ab94-f187d6b79006", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08: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": "5a55d140-b367-4d14-b8b2-9aad8cf983ae", "Asset": { "AssetId": "c0663737-455d-4129-8ad3-56d5e6bd2487", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "ecc2f70a-d1d5-4d55-81d6-04065da81872", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "33c65f88-812d-415b-96ed-1416db4c2bb0", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "f717cd8d-d8fa-48ec-bbe7-66e39276ba08", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-02-05T07:58:19.4138214-08:00", "MeasurementValueNeededDate": "2025-02-05T07:58:19.4138214-08:00", "SourceSystemId": "sample string 3", "CompanyId": "e5d9f6bb-1719-4239-8e95-cc9e3579e2fc", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-02-05T07:58:19.4138214-08:00", "MeasurementValueNeededDate": "2025-02-05T07:58:19.4138214-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "f0987562-54ed-46ef-be38-4f0ef28f177c", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "c575e4aa-99ca-4a6c-99b4-4de806bb72d1", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "ecc2f70a-d1d5-4d55-81d6-04065da81872", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "33c65f88-812d-415b-96ed-1416db4c2bb0", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-02-05T07:58:19.4138214-08:00", "Fields": [ { "FormTypeFieldId": "5a00ed53-c0d5-4d09-8a1b-3e327bdc28b0", "Section": { "FormTypeSectionId": "8138f7fe-4347-4eb4-ac05-13b2c46404f0", "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": "64296e91-5551-49de-945e-796694469e36", "Name": "sample string 1" }, "Unit": { "UnitId": "301cdca0-6194-4e48-981c-012ab0b868d9", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0cf8bd0a-62bd-4465-b2e4-ab4b72017d3b", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08: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": "5a00ed53-c0d5-4d09-8a1b-3e327bdc28b0", "Section": { "FormTypeSectionId": "8138f7fe-4347-4eb4-ac05-13b2c46404f0", "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": "64296e91-5551-49de-945e-796694469e36", "Name": "sample string 1" }, "Unit": { "UnitId": "301cdca0-6194-4e48-981c-012ab0b868d9", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0cf8bd0a-62bd-4465-b2e4-ab4b72017d3b", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08: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": "0acb14ca-0333-4a41-9d0b-b0cff7585a31", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-02-05T07:58:19.4138214-08:00", "Location": "sample string 1", "TaskId": "899a1dc4-0bb6-4d99-8b55-4d5796c5a718", "Values": [ { "FormFieldValueId": "627ce96a-31b4-46f0-b5f1-9522892d4b70", "FormTypeField": { "FormTypeFieldId": "5a00ed53-c0d5-4d09-8a1b-3e327bdc28b0", "Section": { "FormTypeSectionId": "8138f7fe-4347-4eb4-ac05-13b2c46404f0", "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": "64296e91-5551-49de-945e-796694469e36", "Name": "sample string 1" }, "Unit": { "UnitId": "301cdca0-6194-4e48-981c-012ab0b868d9", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0cf8bd0a-62bd-4465-b2e4-ab4b72017d3b", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08: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": "627ce96a-31b4-46f0-b5f1-9522892d4b70", "FormTypeField": { "FormTypeFieldId": "5a00ed53-c0d5-4d09-8a1b-3e327bdc28b0", "Section": { "FormTypeSectionId": "8138f7fe-4347-4eb4-ac05-13b2c46404f0", "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": "64296e91-5551-49de-945e-796694469e36", "Name": "sample string 1" }, "Unit": { "UnitId": "301cdca0-6194-4e48-981c-012ab0b868d9", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "0cf8bd0a-62bd-4465-b2e4-ab4b72017d3b", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08: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": "48acce14-9493-4eba-81bb-5bcba137a191", "CreateDate": "2025-02-05T07:58:19.4138214-08:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-02-05T07:58:19.4138214-08:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }