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": "be1c4184-de96-4b31-952e-ac5ece588ddb", "Asset": { "AssetId": "f92c0bf9-e4e9-4f51-b25f-e9f6d6294be6", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "76649d1f-9f73-467b-ab16-f2fcc9afd1c7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "d8086e77-2f15-477e-8000-7d3c75c363f3", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-28T04:23:10.4746869-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "48b76783-0031-4cc0-9e27-e8cb349261b1", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-03-28T04:23:10.4746869-07:00", "MeasurementValueNeededDate": "2024-03-28T04:23:10.4746869-07:00", "SourceSystemId": "sample string 3", "CompanyId": "dfd12e1c-383a-4d73-bcb3-edd3c2139e55", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-28T04:23:10.4746869-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-03-28T04:23:10.4746869-07:00", "MeasurementValueNeededDate": "2024-03-28T04:23:10.4746869-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "b527f471-c9df-41ca-8b9a-c79abd374ac6", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-28T04:23:10.4746869-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "f778a821-bad2-42df-bcc4-4c0e5b406370", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "76649d1f-9f73-467b-ab16-f2fcc9afd1c7", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "d8086e77-2f15-477e-8000-7d3c75c363f3", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-28T04:23:10.4746869-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-03-28T04:23:10.4746869-07:00", "Fields": [ { "FormTypeFieldId": "d75d04ea-8460-470a-8291-82baba1a35c0", "Section": { "FormTypeSectionId": "f37815a5-918c-45f3-b183-9e3e7fb26f6d", "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": "93b166d9-d831-401e-8613-ac5e755187dc", "Name": "sample string 1" }, "Unit": { "UnitId": "3b931e5c-b6e7-4e16-b5cf-70454dcd0419", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "305010c9-48ac-4fd0-a0ec-96a689a16533", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-28T04:23:10.4746869-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": "d75d04ea-8460-470a-8291-82baba1a35c0", "Section": { "FormTypeSectionId": "f37815a5-918c-45f3-b183-9e3e7fb26f6d", "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": "93b166d9-d831-401e-8613-ac5e755187dc", "Name": "sample string 1" }, "Unit": { "UnitId": "3b931e5c-b6e7-4e16-b5cf-70454dcd0419", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "305010c9-48ac-4fd0-a0ec-96a689a16533", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-28T04:23:10.4746869-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": "1bdf5ccb-1de7-4806-b1be-faa4760f237a", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-28T04:23:10.4746869-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-03-28T04:23:10.4746869-07:00", "Location": "sample string 1", "TaskId": "01d0eeb9-83de-4286-b3d0-276198fa7cf9", "Values": [ { "FormFieldValueId": "9984e92f-223a-4892-82b0-e1ee066682fe", "FormTypeField": { "FormTypeFieldId": "d75d04ea-8460-470a-8291-82baba1a35c0", "Section": { "FormTypeSectionId": "f37815a5-918c-45f3-b183-9e3e7fb26f6d", "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": "93b166d9-d831-401e-8613-ac5e755187dc", "Name": "sample string 1" }, "Unit": { "UnitId": "3b931e5c-b6e7-4e16-b5cf-70454dcd0419", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "305010c9-48ac-4fd0-a0ec-96a689a16533", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-28T04:23:10.4746869-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": "9984e92f-223a-4892-82b0-e1ee066682fe", "FormTypeField": { "FormTypeFieldId": "d75d04ea-8460-470a-8291-82baba1a35c0", "Section": { "FormTypeSectionId": "f37815a5-918c-45f3-b183-9e3e7fb26f6d", "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": "93b166d9-d831-401e-8613-ac5e755187dc", "Name": "sample string 1" }, "Unit": { "UnitId": "3b931e5c-b6e7-4e16-b5cf-70454dcd0419", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "305010c9-48ac-4fd0-a0ec-96a689a16533", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-28T04:23:10.4746869-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": "6154b21b-1a9f-4247-8009-925ae937cdd5", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-03-28T04:23:10.4746869-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": "49cad7ee-db1e-474d-b115-1ca41fa72824", "Asset": { "AssetId": "42a74daa-7d85-470e-96fb-7d1fb8444c76", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "f532c520-7537-41a8-abb1-69ce6699f5dd", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "e11667df-12a0-4d6b-a322-4b8ee31f383e", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-28T04:23:10.4746869-07:00", "LastModifiedUser": "sample string 7" }, "AssetGroup": { "AssetGroupId": "3d1e0afc-f90a-4aec-ada0-8661d9a18684", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-03-28T04:23:10.4746869-07:00", "MeasurementValueNeededDate": "2024-03-28T04:23:10.4746869-07:00", "SourceSystemId": "sample string 3", "CompanyId": "ca800167-f876-44fa-b093-668c9ceebab6", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-28T04:23:10.4746869-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "FormValueNeededDate": "2024-03-28T04:23:10.4746869-07:00", "MeasurementValueNeededDate": "2024-03-28T04:23:10.4746869-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d6f5f36b-eb6f-477a-bad7-7e1a65d6d5e9", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-03-28T04:23:10.4746869-07:00", "LastModifiedUser": "sample string 8" }, "FormType": { "FormTypeId": "dd941d8b-9c03-40be-a6a7-4d8aa6a1a824", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "f532c520-7537-41a8-abb1-69ce6699f5dd", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "e11667df-12a0-4d6b-a322-4b8ee31f383e", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-03-28T04:23:10.4746869-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-03-28T04:23:10.4746869-07:00", "Fields": [ { "FormTypeFieldId": "729d4f73-0c90-4ae5-a197-7a81af500cd1", "Section": { "FormTypeSectionId": "a5609435-0f94-4536-a280-7f80259827ae", "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": "53affce7-b769-4cae-ad9e-38e4877db13e", "Name": "sample string 1" }, "Unit": { "UnitId": "aa82d07d-9999-49e8-ac0a-d16814d37a26", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3645ff99-68ef-4fe6-9161-552edc8b8464", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-28T04:23:10.4746869-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": "729d4f73-0c90-4ae5-a197-7a81af500cd1", "Section": { "FormTypeSectionId": "a5609435-0f94-4536-a280-7f80259827ae", "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": "53affce7-b769-4cae-ad9e-38e4877db13e", "Name": "sample string 1" }, "Unit": { "UnitId": "aa82d07d-9999-49e8-ac0a-d16814d37a26", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3645ff99-68ef-4fe6-9161-552edc8b8464", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-28T04:23:10.4746869-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": "b09fa4be-0fb5-4e0c-8b2a-ac383435f2e3", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-28T04:23:10.4746869-07:00", "LastModifiedUser": "sample string 6" }, "EffectiveDate": "2024-03-28T04:23:10.4746869-07:00", "Location": "sample string 1", "TaskId": "d6a1466d-a8f2-45ed-9ee2-8a7e1d221d5d", "Values": [ { "FormFieldValueId": "d0bc24e1-ad5b-4b89-9881-25b2d64ed001", "FormTypeField": { "FormTypeFieldId": "729d4f73-0c90-4ae5-a197-7a81af500cd1", "Section": { "FormTypeSectionId": "a5609435-0f94-4536-a280-7f80259827ae", "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": "53affce7-b769-4cae-ad9e-38e4877db13e", "Name": "sample string 1" }, "Unit": { "UnitId": "aa82d07d-9999-49e8-ac0a-d16814d37a26", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3645ff99-68ef-4fe6-9161-552edc8b8464", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-28T04:23:10.4746869-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": "d0bc24e1-ad5b-4b89-9881-25b2d64ed001", "FormTypeField": { "FormTypeFieldId": "729d4f73-0c90-4ae5-a197-7a81af500cd1", "Section": { "FormTypeSectionId": "a5609435-0f94-4536-a280-7f80259827ae", "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": "53affce7-b769-4cae-ad9e-38e4877db13e", "Name": "sample string 1" }, "Unit": { "UnitId": "aa82d07d-9999-49e8-ac0a-d16814d37a26", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "3645ff99-68ef-4fe6-9161-552edc8b8464", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-03-28T04:23:10.4746869-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": "4449230a-15f3-49b9-a423-c518eccb3371", "CreateDate": "2024-03-28T04:23:10.4746869-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-03-28T04:23:10.4746869-07:00", "LastModifiedUser": "sample string 5" }, "Total": 1, "Message": "sample string 1" }