POST Forms
Creates a new form.
Request Information
URI Parameters
None.
Body Parameters
The form to create. FormId should not be filled in.
Form| Name | Description | Type | Additional information |
|---|---|---|---|
| FormId | globally unique identifier |
None. |
|
| Asset | Asset |
None. |
|
| FormType | FormType |
None. |
|
| EffectiveDate | date |
None. |
|
| WellKnownText | string |
None. |
|
| Values | Collection of FormFieldValue |
None. |
|
| SourceSystemId | string |
None. |
|
| CompanyId | globally unique identifier |
None. |
|
| CreateDate | date |
None. |
|
| CreateUser | string |
None. |
|
| CreateMachine | string |
None. |
|
| LastModifiedDate | date |
None. |
|
| LastModifiedUser | string |
None. |
|
| LastModifiedMachine | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"FormId": "77779cd7-2795-4512-86b5-26b1b6fc31fb",
"Asset": {
"AssetId": "e472a138-0e45-40f9-993f-298f94a482f0",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "4977210c-b076-4953-9b3a-97b7802456ce",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ddd8e121-c37d-4d90-b7a2-fe3fef3d7611",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
"AssetGroup": {
"AssetGroupId": "1ef4b96c-3458-4686-af12-81905f4c35c4",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2021-04-17T08:26:20.7089639-07:00",
"MeasurementValueNeededDate": "2021-04-17T08:26:20.7089639-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "31ff5fde-984e-4473-a54f-3d8e51191133",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"ParentAsset": null,
"WellKnownText": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2021-04-17T08:26:20.7089639-07:00",
"MeasurementValueNeededDate": "2021-04-17T08:26:20.7089639-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "43ace69d-bc10-4061-8585-6574ad334490",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 7",
"CreateMachine": "sample string 8",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 9",
"LastModifiedMachine": "sample string 10"
},
"FormType": {
"FormTypeId": "eb4853ef-8656-4d71-99d3-e62992d52282",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "4977210c-b076-4953-9b3a-97b7802456ce",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "ddd8e121-c37d-4d90-b7a2-fe3fef3d7611",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2021-04-17T08:26:20.7089639-07:00",
"Fields": [
{
"FormTypeFieldId": "ce0a394e-5ea9-4158-9ea9-ddddacf7c79a",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "f656f06e-de4a-482e-9926-d5985a962d0b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ba73df5e-9963-43c3-bc80-5651a7277051",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4e42007a-53e1-480c-904e-0901515d72ab",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
},
{
"FormTypeFieldId": "ce0a394e-5ea9-4158-9ea9-ddddacf7c79a",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "f656f06e-de4a-482e-9926-d5985a962d0b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ba73df5e-9963-43c3-bc80-5651a7277051",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4e42007a-53e1-480c-904e-0901515d72ab",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "abcc3889-ed3f-4d8c-9e29-51585e923577",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"EffectiveDate": "2021-04-17T08:26:20.7089639-07:00",
"WellKnownText": "sample string 1",
"Values": [
{
"FormFieldValueId": "97ef5efa-69c5-4aa0-9cef-14d00ee6aba1",
"FormTypeField": {
"FormTypeFieldId": "ce0a394e-5ea9-4158-9ea9-ddddacf7c79a",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "f656f06e-de4a-482e-9926-d5985a962d0b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ba73df5e-9963-43c3-bc80-5651a7277051",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4e42007a-53e1-480c-904e-0901515d72ab",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
},
"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": "97ef5efa-69c5-4aa0-9cef-14d00ee6aba1",
"FormTypeField": {
"FormTypeFieldId": "ce0a394e-5ea9-4158-9ea9-ddddacf7c79a",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "f656f06e-de4a-482e-9926-d5985a962d0b",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "ba73df5e-9963-43c3-bc80-5651a7277051",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "4e42007a-53e1-480c-904e-0901515d72ab",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
},
"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": "580eb9af-9ebc-4846-ac06-846bc5d570c5",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 4",
"CreateMachine": "sample string 5",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 6",
"LastModifiedMachine": "sample string 7"
}
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": "f85cd96e-3e4d-416f-9ffe-e541637a6a86",
"Asset": {
"AssetId": "ab2c34d1-bdab-4b14-91b0-3fe9746ca4ea",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "21191cd5-8f68-419d-aca3-4f3d46879635",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "259ae8a3-faab-4369-a4ff-29d85c2e485a",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
"AssetGroup": {
"AssetGroupId": "e878c19a-0df1-42a0-b836-438120ae9fd5",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2021-04-17T08:26:20.7089639-07:00",
"MeasurementValueNeededDate": "2021-04-17T08:26:20.7089639-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "780679e2-01c9-4565-8cd2-aef86e53d82c",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"ParentAsset": null,
"WellKnownText": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2021-04-17T08:26:20.7089639-07:00",
"MeasurementValueNeededDate": "2021-04-17T08:26:20.7089639-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "7ad04e39-da24-4437-abda-d1d455466745",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 7",
"CreateMachine": "sample string 8",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 9",
"LastModifiedMachine": "sample string 10"
},
"FormType": {
"FormTypeId": "680aa1a4-8d11-4e9a-b458-c176f1efa959",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "21191cd5-8f68-419d-aca3-4f3d46879635",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "259ae8a3-faab-4369-a4ff-29d85c2e485a",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 6",
"CreateMachine": "sample string 7",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 8",
"LastModifiedMachine": "sample string 9"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2021-04-17T08:26:20.7089639-07:00",
"Fields": [
{
"FormTypeFieldId": "7842394c-2636-4938-a9b3-74e692cf724b",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "a30dcae7-3323-4e2f-bff8-4537706c7f4e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "914a8942-b1ce-42f4-bc45-0c8d26f558af",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "528302eb-9bc7-467c-b702-03350ed80235",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
},
{
"FormTypeFieldId": "7842394c-2636-4938-a9b3-74e692cf724b",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "a30dcae7-3323-4e2f-bff8-4537706c7f4e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "914a8942-b1ce-42f4-bc45-0c8d26f558af",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "528302eb-9bc7-467c-b702-03350ed80235",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
}
],
"SourceSystemId": "sample string 3",
"CompanyId": "9f698724-dd69-40f6-88e4-ec5c4913e88a",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"EffectiveDate": "2021-04-17T08:26:20.7089639-07:00",
"WellKnownText": "sample string 1",
"Values": [
{
"FormFieldValueId": "95c95913-9b36-4cd7-922c-4805619aee03",
"FormTypeField": {
"FormTypeFieldId": "7842394c-2636-4938-a9b3-74e692cf724b",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "a30dcae7-3323-4e2f-bff8-4537706c7f4e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "914a8942-b1ce-42f4-bc45-0c8d26f558af",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "528302eb-9bc7-467c-b702-03350ed80235",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
},
"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": "95c95913-9b36-4cd7-922c-4805619aee03",
"FormTypeField": {
"FormTypeFieldId": "7842394c-2636-4938-a9b3-74e692cf724b",
"Name": "sample string 1",
"Label": "sample string 2",
"Description": "sample string 3",
"DataType": {
"DataTypeId": "a30dcae7-3323-4e2f-bff8-4537706c7f4e",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "914a8942-b1ce-42f4-bc45-0c8d26f558af",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "528302eb-9bc7-467c-b702-03350ed80235",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 5",
"CreateMachine": "sample string 6",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 7",
"LastModifiedMachine": "sample string 8"
},
"DisplayOrder": 1,
"MinValue": 1.0,
"MaxValue": 1.0,
"MinLength": 1,
"MaxLength": 1,
"HasValidValues": true,
"ValidValues": [
"sample string 1",
"sample string 2"
],
"Expression": "sample string 5",
"IsRequired": true,
"IsAttachment": true,
"DefaultValue": "sample string 8",
"IsAccumulator": true,
"IsMultiline": true,
"SourceSystemId": "sample string 11"
},
"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": "d8ea190b-1d33-4210-9258-35ea1e6caa1f",
"CreateDate": "2021-04-17T08:26:20.7089639-07:00",
"CreateUser": "sample string 4",
"CreateMachine": "sample string 5",
"LastModifiedDate": "2021-04-17T08:26:20.7089639-07:00",
"LastModifiedUser": "sample string 6",
"LastModifiedMachine": "sample string 7"
},
"Total": 1,
"Message": "sample string 1"
}