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": "cf781e3d-ac26-4ad4-be34-d01b130c81e7", "Asset": { "AssetId": "3106f3da-9b7b-44fa-9611-b0348232491f", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "1c5b406e-50f4-4cb1-ac8a-0e2abc0f9500", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "eb34eeec-62c0-4d11-9187-51cc2e0a3723", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T03:40:13.5502289-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "9a0064fa-13ca-4102-a876-353c1f099c3e", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-10-10T03:40:13.5502289-07:00", "MeasurementValueNeededDate": "2024-10-10T03:40:13.5502289-07:00", "SourceSystemId": "sample string 3", "CompanyId": "f9ca25d6-ca73-4a23-9bbd-f2c562a244fa", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:40:13.5502289-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-10-10T03:40:13.5502289-07:00", "MeasurementValueNeededDate": "2024-10-10T03:40:13.5502289-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "32ec2107-59fe-4971-acb1-f5140e3e3a7f", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-10-10T03:40:13.5502289-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "443b836e-7b3b-4764-9a5f-7e28028bfd15", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "1c5b406e-50f4-4cb1-ac8a-0e2abc0f9500", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "eb34eeec-62c0-4d11-9187-51cc2e0a3723", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T03:40:13.5502289-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-10-10T03:40:13.5502289-07:00", "Fields": [ { "FormTypeFieldId": "fba67e80-57b4-4c27-abe5-b506504c506e", "Section": { "FormTypeSectionId": "c175dfa5-2251-4a5e-b76b-b7af897eec46", "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": "3f9f5eba-b7e6-496b-8e3b-a9aa7441941d", "Name": "sample string 1" }, "Unit": { "UnitId": "e3f3e0d8-cf81-4db3-bb70-9593e7107733", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "876173c1-9e14-4b2f-afb9-943c4d4a3ed6", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:40:13.5502289-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": "fba67e80-57b4-4c27-abe5-b506504c506e", "Section": { "FormTypeSectionId": "c175dfa5-2251-4a5e-b76b-b7af897eec46", "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": "3f9f5eba-b7e6-496b-8e3b-a9aa7441941d", "Name": "sample string 1" }, "Unit": { "UnitId": "e3f3e0d8-cf81-4db3-bb70-9593e7107733", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "876173c1-9e14-4b2f-afb9-943c4d4a3ed6", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:40:13.5502289-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": "78f29f8f-cd89-4b89-8cf2-aefd3113beb5", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:40:13.5502289-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-10-10T03:40:13.5502289-07:00", "Location": "sample string 1", "TaskId": "40bca37a-3030-430e-b070-25d627083ce3", "Values": [ { "FormFieldValueId": "4ce4b1f0-1342-4c89-99da-ac58ada72295", "FormTypeField": { "FormTypeFieldId": "fba67e80-57b4-4c27-abe5-b506504c506e", "Section": { "FormTypeSectionId": "c175dfa5-2251-4a5e-b76b-b7af897eec46", "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": "3f9f5eba-b7e6-496b-8e3b-a9aa7441941d", "Name": "sample string 1" }, "Unit": { "UnitId": "e3f3e0d8-cf81-4db3-bb70-9593e7107733", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "876173c1-9e14-4b2f-afb9-943c4d4a3ed6", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:40:13.5502289-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": "4ce4b1f0-1342-4c89-99da-ac58ada72295", "FormTypeField": { "FormTypeFieldId": "fba67e80-57b4-4c27-abe5-b506504c506e", "Section": { "FormTypeSectionId": "c175dfa5-2251-4a5e-b76b-b7af897eec46", "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": "3f9f5eba-b7e6-496b-8e3b-a9aa7441941d", "Name": "sample string 1" }, "Unit": { "UnitId": "e3f3e0d8-cf81-4db3-bb70-9593e7107733", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "876173c1-9e14-4b2f-afb9-943c4d4a3ed6", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:40:13.5502289-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": "90828189-5f44-4d22-ac0c-609f239ae839", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-10-10T03:40:13.5502289-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": "62b525fd-b043-4260-a50a-b0039fc9e47e", "Asset": { "AssetId": "4eeea12c-6e5b-4882-b1da-885fd6c9c196", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "1cce6dd3-3413-4790-9236-50afe781ddd7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0995dfac-e2e3-4343-8020-24107f068742", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T03:40:13.5502289-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "aee787fd-03db-4b82-a83d-1e1ddbd35cb2", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-10-10T03:40:13.5502289-07:00", "MeasurementValueNeededDate": "2024-10-10T03:40:13.5502289-07:00", "SourceSystemId": "sample string 3", "CompanyId": "536fe0d3-eae2-43ac-8da8-1b411349e3c9", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:40:13.5502289-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-10-10T03:40:13.5502289-07:00", "MeasurementValueNeededDate": "2024-10-10T03:40:13.5502289-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "2e876898-0942-4337-8b39-cf95931cfe05", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-10-10T03:40:13.5502289-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "f41a8e8e-5655-4d39-a9d1-a2889ff2bfce", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "1cce6dd3-3413-4790-9236-50afe781ddd7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "0995dfac-e2e3-4343-8020-24107f068742", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-10-10T03:40:13.5502289-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-10-10T03:40:13.5502289-07:00", "Fields": [ { "FormTypeFieldId": "e77299c9-f217-4a5d-9b0b-7c3c63cff142", "Section": { "FormTypeSectionId": "a3c35b81-5ba6-45f0-8ac0-d0bd5541d02c", "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": "0af86e9b-eebc-4738-a912-94b2847378cb", "Name": "sample string 1" }, "Unit": { "UnitId": "017f1d93-5b7e-4b93-8060-4c750f7125ab", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f79fba43-c0bc-42a7-9b24-2daa3909e3ea", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:40:13.5502289-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": "e77299c9-f217-4a5d-9b0b-7c3c63cff142", "Section": { "FormTypeSectionId": "a3c35b81-5ba6-45f0-8ac0-d0bd5541d02c", "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": "0af86e9b-eebc-4738-a912-94b2847378cb", "Name": "sample string 1" }, "Unit": { "UnitId": "017f1d93-5b7e-4b93-8060-4c750f7125ab", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f79fba43-c0bc-42a7-9b24-2daa3909e3ea", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:40:13.5502289-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": "ee29122e-8608-4ef4-a729-055653a3772c", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:40:13.5502289-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-10-10T03:40:13.5502289-07:00", "Location": "sample string 1", "TaskId": "962163c7-4439-42f5-9a44-1943304af069", "Values": [ { "FormFieldValueId": "8ae40ad0-c9a0-447a-b58a-39d069d2cb16", "FormTypeField": { "FormTypeFieldId": "e77299c9-f217-4a5d-9b0b-7c3c63cff142", "Section": { "FormTypeSectionId": "a3c35b81-5ba6-45f0-8ac0-d0bd5541d02c", "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": "0af86e9b-eebc-4738-a912-94b2847378cb", "Name": "sample string 1" }, "Unit": { "UnitId": "017f1d93-5b7e-4b93-8060-4c750f7125ab", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f79fba43-c0bc-42a7-9b24-2daa3909e3ea", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:40:13.5502289-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": "8ae40ad0-c9a0-447a-b58a-39d069d2cb16", "FormTypeField": { "FormTypeFieldId": "e77299c9-f217-4a5d-9b0b-7c3c63cff142", "Section": { "FormTypeSectionId": "a3c35b81-5ba6-45f0-8ac0-d0bd5541d02c", "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": "0af86e9b-eebc-4738-a912-94b2847378cb", "Name": "sample string 1" }, "Unit": { "UnitId": "017f1d93-5b7e-4b93-8060-4c750f7125ab", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f79fba43-c0bc-42a7-9b24-2daa3909e3ea", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-10-10T03:40:13.5502289-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": "e7c09de1-c8b0-4896-9480-b1a09fc9661b", "CreateDate": "2024-10-10T03:40:13.5502289-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-10-10T03:40:13.5502289-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }