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": "9f202c77-bc42-4366-8a7e-68f3888e40d1", "Asset": { "AssetId": "de52ddcb-70f9-40b6-b69b-a616e5771422", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "6baac9ac-64bc-41d1-a731-58e2a0182ea2", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "040af6d5-48db-4e71-b4a4-0afbed3b98c1", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-29T08:22:22.0618242-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "dbbf6f5b-ea9d-41ac-8976-d96bbe565c34", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-03-29T08:22:22.0618242-07:00", "MeasurementValueNeededDate": "2024-03-29T08:22:22.0618242-07:00", "SourceSystemId": "sample string 3", "CompanyId": "962eabb9-718b-483f-abf2-c8a244a11c5e", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T08:22:22.0618242-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-03-29T08:22:22.0618242-07:00", "MeasurementValueNeededDate": "2024-03-29T08:22:22.0618242-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "3ff6e47f-6495-4f98-8a0d-2ca0a55b38d8", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T08:22:22.0618242-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "ff98bf82-5ed5-49d2-93fb-30234de4af19", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "6baac9ac-64bc-41d1-a731-58e2a0182ea2", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "040af6d5-48db-4e71-b4a4-0afbed3b98c1", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-29T08:22:22.0618242-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-03-29T08:22:22.0618242-07:00", "Fields": [ { "FormTypeFieldId": "4c41280c-e5f0-4792-80c3-bc07fc656c47", "Section": { "FormTypeSectionId": "58b10e98-aad4-4e04-9de2-7daa7e1d3d11", "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": "dbe868ed-6b9f-4d23-ac6e-67bb0bcea4c2", "Name": "sample string 1" }, "Unit": { "UnitId": "3c1598fb-038b-4143-91f6-5b6cec8ff193", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "4b92ba5b-667c-452f-aadf-748c2bca8764", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T08:22:22.0618242-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": "4c41280c-e5f0-4792-80c3-bc07fc656c47", "Section": { "FormTypeSectionId": "58b10e98-aad4-4e04-9de2-7daa7e1d3d11", "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": "dbe868ed-6b9f-4d23-ac6e-67bb0bcea4c2", "Name": "sample string 1" }, "Unit": { "UnitId": "3c1598fb-038b-4143-91f6-5b6cec8ff193", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "4b92ba5b-667c-452f-aadf-748c2bca8764", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T08:22:22.0618242-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": "693b3545-7f39-42fd-8fc7-8a7d15984210", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T08:22:22.0618242-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-03-29T08:22:22.0618242-07:00", "Location": "sample string 1", "TaskId": "a9018429-ab00-4fc8-b701-778109b01f23", "Values": [ { "FormFieldValueId": "55396c29-34ef-4089-94c3-470254053a6b", "FormTypeField": { "FormTypeFieldId": "4c41280c-e5f0-4792-80c3-bc07fc656c47", "Section": { "FormTypeSectionId": "58b10e98-aad4-4e04-9de2-7daa7e1d3d11", "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": "dbe868ed-6b9f-4d23-ac6e-67bb0bcea4c2", "Name": "sample string 1" }, "Unit": { "UnitId": "3c1598fb-038b-4143-91f6-5b6cec8ff193", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "4b92ba5b-667c-452f-aadf-748c2bca8764", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T08:22:22.0618242-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": "55396c29-34ef-4089-94c3-470254053a6b", "FormTypeField": { "FormTypeFieldId": "4c41280c-e5f0-4792-80c3-bc07fc656c47", "Section": { "FormTypeSectionId": "58b10e98-aad4-4e04-9de2-7daa7e1d3d11", "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": "dbe868ed-6b9f-4d23-ac6e-67bb0bcea4c2", "Name": "sample string 1" }, "Unit": { "UnitId": "3c1598fb-038b-4143-91f6-5b6cec8ff193", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "4b92ba5b-667c-452f-aadf-748c2bca8764", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T08:22:22.0618242-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": "935310b2-95e6-4091-940f-c911927f6c5b", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-03-29T08:22:22.0618242-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": "883cbcc2-719c-45d1-a31a-ab0a19b625a7", "Asset": { "AssetId": "f0961c7e-21c2-44f3-be3b-3ae9e287690c", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "408e928f-f065-44d7-91a4-f1b75945a137", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a7713183-dec3-467a-b021-3018c62d8dbc", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-29T08:22:22.0618242-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "c83813a1-f064-4c33-b6b9-8dd5217272d8", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-03-29T08:22:22.0618242-07:00", "MeasurementValueNeededDate": "2024-03-29T08:22:22.0618242-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1705838f-400d-42c7-aeb0-9b824c3a90e1", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T08:22:22.0618242-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-03-29T08:22:22.0618242-07:00", "MeasurementValueNeededDate": "2024-03-29T08:22:22.0618242-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "e4f1bd51-26cc-4c07-87cb-56f5bfb79e88", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-29T08:22:22.0618242-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "4a8db6ce-8d6b-4c9c-a96c-161c1ea400d6", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "408e928f-f065-44d7-91a4-f1b75945a137", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "a7713183-dec3-467a-b021-3018c62d8dbc", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-29T08:22:22.0618242-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-03-29T08:22:22.0618242-07:00", "Fields": [ { "FormTypeFieldId": "c0405d57-86b1-446d-aa54-03669c6424d7", "Section": { "FormTypeSectionId": "f0d30389-10a6-452a-a6ac-941103733c21", "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": "39ed74c1-a349-40f6-a5b4-cb09d34690b2", "Name": "sample string 1" }, "Unit": { "UnitId": "fa5d45ad-f0c2-4a2f-ab5d-ce58fec32219", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "bf570058-789a-4459-a05d-84c0492d6c02", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T08:22:22.0618242-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": "c0405d57-86b1-446d-aa54-03669c6424d7", "Section": { "FormTypeSectionId": "f0d30389-10a6-452a-a6ac-941103733c21", "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": "39ed74c1-a349-40f6-a5b4-cb09d34690b2", "Name": "sample string 1" }, "Unit": { "UnitId": "fa5d45ad-f0c2-4a2f-ab5d-ce58fec32219", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "bf570058-789a-4459-a05d-84c0492d6c02", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T08:22:22.0618242-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": "2fe6d752-b857-4108-9b35-67855b78a7f0", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T08:22:22.0618242-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-03-29T08:22:22.0618242-07:00", "Location": "sample string 1", "TaskId": "4ae0f224-ca28-43c6-add3-7ca3f6525450", "Values": [ { "FormFieldValueId": "9ad3070d-b4f5-47bd-af89-4dab1f038777", "FormTypeField": { "FormTypeFieldId": "c0405d57-86b1-446d-aa54-03669c6424d7", "Section": { "FormTypeSectionId": "f0d30389-10a6-452a-a6ac-941103733c21", "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": "39ed74c1-a349-40f6-a5b4-cb09d34690b2", "Name": "sample string 1" }, "Unit": { "UnitId": "fa5d45ad-f0c2-4a2f-ab5d-ce58fec32219", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "bf570058-789a-4459-a05d-84c0492d6c02", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T08:22:22.0618242-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": "9ad3070d-b4f5-47bd-af89-4dab1f038777", "FormTypeField": { "FormTypeFieldId": "c0405d57-86b1-446d-aa54-03669c6424d7", "Section": { "FormTypeSectionId": "f0d30389-10a6-452a-a6ac-941103733c21", "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": "39ed74c1-a349-40f6-a5b4-cb09d34690b2", "Name": "sample string 1" }, "Unit": { "UnitId": "fa5d45ad-f0c2-4a2f-ab5d-ce58fec32219", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "bf570058-789a-4459-a05d-84c0492d6c02", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-29T08:22:22.0618242-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": "264b7d03-0d75-4e19-828b-ad626c1fa485", "CreateDate": "2024-03-29T08:22:22.0618242-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-03-29T08:22:22.0618242-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }