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": "a21b23a9-1660-4744-88f2-df89cb36a424", "Asset": { "AssetId": "fc82f76f-86cd-4e5e-a30f-39935a802a78", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "43f873cf-2494-42fb-ae2f-fd574ca6d5b8", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "8a1e6f9f-bf92-4681-a011-1d22a841d7fd", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-22T23:57:00.01651-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "cecf9c78-abd7-4083-a08f-ce58f846eb13", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T23:57:00.01651-07:00", "MeasurementValueNeededDate": "2025-06-22T23:57:00.01651-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ee379100-9672-487d-b3c7-2f87ffe17cf8", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:57:00.01651-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-22T23:57:00.01651-07:00", "MeasurementValueNeededDate": "2025-06-22T23:57:00.01651-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "f4f4782a-ada7-41b6-8fd5-f44a2362235e", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-22T23:57:00.01651-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "c2774a8b-76ea-455c-a860-091ad09b30c3", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "43f873cf-2494-42fb-ae2f-fd574ca6d5b8", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "8a1e6f9f-bf92-4681-a011-1d22a841d7fd", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-22T23:57:00.01651-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-22T23:57:00.01651-07:00", "Fields": [ { "FormTypeFieldId": "5d8259a0-3ef6-4ec9-9a37-f075101efadd", "Section": { "FormTypeSectionId": "d6230bec-d2e1-41bc-9176-535da3c8f626", "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": "63f81eb3-f945-4899-bee2-36db9f910b1a", "Name": "sample string 1" }, "Unit": { "UnitId": "c6701987-aa26-4b99-a155-b16c08028ccb", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "5c2c0780-beed-4bcf-890d-fa0362514b3e", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:57:00.01651-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": "5d8259a0-3ef6-4ec9-9a37-f075101efadd", "Section": { "FormTypeSectionId": "d6230bec-d2e1-41bc-9176-535da3c8f626", "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": "63f81eb3-f945-4899-bee2-36db9f910b1a", "Name": "sample string 1" }, "Unit": { "UnitId": "c6701987-aa26-4b99-a155-b16c08028ccb", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "5c2c0780-beed-4bcf-890d-fa0362514b3e", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:57:00.01651-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": "c3ab32c4-4c8b-4805-a005-c16d99b71de7", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:57:00.01651-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-06-22T23:57:00.01651-07:00", "Location": "sample string 1", "TaskId": "50d74bd1-af07-4a06-b8be-771c6a93a541", "Values": [ { "FormFieldValueId": "e2558e1d-f51e-4714-ad5c-0cb05d166173", "FormTypeField": { "FormTypeFieldId": "5d8259a0-3ef6-4ec9-9a37-f075101efadd", "Section": { "FormTypeSectionId": "d6230bec-d2e1-41bc-9176-535da3c8f626", "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": "63f81eb3-f945-4899-bee2-36db9f910b1a", "Name": "sample string 1" }, "Unit": { "UnitId": "c6701987-aa26-4b99-a155-b16c08028ccb", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "5c2c0780-beed-4bcf-890d-fa0362514b3e", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:57:00.01651-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": "e2558e1d-f51e-4714-ad5c-0cb05d166173", "FormTypeField": { "FormTypeFieldId": "5d8259a0-3ef6-4ec9-9a37-f075101efadd", "Section": { "FormTypeSectionId": "d6230bec-d2e1-41bc-9176-535da3c8f626", "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": "63f81eb3-f945-4899-bee2-36db9f910b1a", "Name": "sample string 1" }, "Unit": { "UnitId": "c6701987-aa26-4b99-a155-b16c08028ccb", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "5c2c0780-beed-4bcf-890d-fa0362514b3e", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:57:00.01651-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": "d0512730-e8d0-4355-8bc3-e935731e070a", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-22T23:57:00.01651-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": "3df134d4-1111-4ddf-8ae1-59285d8a2f70", "Asset": { "AssetId": "632d4256-2486-4504-aa50-6a7fe57c37ed", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "e66cef88-cac6-4a65-bc87-d2b00a5f52c0", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5eb47332-08f3-4a06-8f62-411d56702fad", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-22T23:57:00.01651-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "ad7c45fe-84d1-4032-b179-c35a8feb38eb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-06-22T23:57:00.01651-07:00", "MeasurementValueNeededDate": "2025-06-22T23:57:00.01651-07:00", "SourceSystemId": "sample string 3", "CompanyId": "5baa2ccf-2d56-4a03-b3f7-151b99f75f94", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:57:00.01651-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2025-06-22T23:57:00.01651-07:00", "MeasurementValueNeededDate": "2025-06-22T23:57:00.01651-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "0c3b0a99-89d5-4a83-a809-b973bebe4a69", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-06-22T23:57:00.01651-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "e0476715-5a9e-417d-80cf-9a6a4307d526", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "e66cef88-cac6-4a65-bc87-d2b00a5f52c0", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "5eb47332-08f3-4a06-8f62-411d56702fad", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-06-22T23:57:00.01651-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2025-06-22T23:57:00.01651-07:00", "Fields": [ { "FormTypeFieldId": "563142c2-c2b5-4383-8e25-dce048c49a98", "Section": { "FormTypeSectionId": "5b0e28f6-cdbf-473f-8c97-f7201b143024", "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": "eef547b8-4d5f-4aff-a32f-0c46eb376cb3", "Name": "sample string 1" }, "Unit": { "UnitId": "bea44b7d-f4c8-43ce-a577-31aa614f6140", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2682b1b2-a4b6-41d9-a058-c6d8a5dd7e8b", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:57:00.01651-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": "563142c2-c2b5-4383-8e25-dce048c49a98", "Section": { "FormTypeSectionId": "5b0e28f6-cdbf-473f-8c97-f7201b143024", "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": "eef547b8-4d5f-4aff-a32f-0c46eb376cb3", "Name": "sample string 1" }, "Unit": { "UnitId": "bea44b7d-f4c8-43ce-a577-31aa614f6140", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2682b1b2-a4b6-41d9-a058-c6d8a5dd7e8b", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:57:00.01651-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": "fdc19161-f134-4c09-b2fa-3ab6950a81d9", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:57:00.01651-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2025-06-22T23:57:00.01651-07:00", "Location": "sample string 1", "TaskId": "48ba3a4f-dd39-478a-9195-af4c02e85b35", "Values": [ { "FormFieldValueId": "75df7221-5c24-4382-a04d-c9be10fd75b3", "FormTypeField": { "FormTypeFieldId": "563142c2-c2b5-4383-8e25-dce048c49a98", "Section": { "FormTypeSectionId": "5b0e28f6-cdbf-473f-8c97-f7201b143024", "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": "eef547b8-4d5f-4aff-a32f-0c46eb376cb3", "Name": "sample string 1" }, "Unit": { "UnitId": "bea44b7d-f4c8-43ce-a577-31aa614f6140", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2682b1b2-a4b6-41d9-a058-c6d8a5dd7e8b", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:57:00.01651-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": "75df7221-5c24-4382-a04d-c9be10fd75b3", "FormTypeField": { "FormTypeFieldId": "563142c2-c2b5-4383-8e25-dce048c49a98", "Section": { "FormTypeSectionId": "5b0e28f6-cdbf-473f-8c97-f7201b143024", "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": "eef547b8-4d5f-4aff-a32f-0c46eb376cb3", "Name": "sample string 1" }, "Unit": { "UnitId": "bea44b7d-f4c8-43ce-a577-31aa614f6140", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "2682b1b2-a4b6-41d9-a058-c6d8a5dd7e8b", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-06-22T23:57:00.01651-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": "83bb2611-c3ec-4dbb-be47-1885092d6584", "CreateDate": "2025-06-22T23:57:00.01651-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2025-06-22T23:57:00.01651-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }