PUT Forms
Updates the given form.
Request Information
URI Parameters
None.
Body Parameters
The form to update
Form| Name | 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": "8d121e54-4b9a-495d-959e-9dbca6546681",
"Asset": {
"AssetId": "74bfe741-2103-4905-95e4-c9ffd325073b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "228d7239-8bc8-4e35-b80f-b34da5b4b7b7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4206e3b5-38b5-471d-9fbf-e9379b1e6490",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T08:09:39.006504-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "88f994ae-b216-48f7-9f74-9e33f9e775f8",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-02T08:09:39.006504-07:00",
"MeasurementValueNeededDate": "2025-06-02T08:09:39.006504-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "9e9319a3-36e0-454f-8287-8983971d14aa",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T08:09:39.006504-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-02T08:09:39.006504-07:00",
"MeasurementValueNeededDate": "2025-06-02T08:09:39.006504-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f2863e2b-f3f1-4f62-8618-d228bceaa9cc",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T08:09:39.006504-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "7874d86a-607b-4ada-bd26-9a7a0f6f68b8",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "228d7239-8bc8-4e35-b80f-b34da5b4b7b7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "4206e3b5-38b5-471d-9fbf-e9379b1e6490",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T08:09:39.006504-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-06-02T08:09:39.006504-07:00",
"Fields": [
{
"FormTypeFieldId": "a892e666-100a-49a3-8814-20de243465cf",
"Section": {
"FormTypeSectionId": "00492a2b-899a-49cb-81b8-e9f284160395",
"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": "8c9437dc-bfd3-44b8-98f1-ad12113f13f6",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "30688422-0868-4b70-834b-11bf1eae144e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "433cbe5b-aebe-4524-8dba-68d4b37ae23d",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T08:09:39.006504-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": "a892e666-100a-49a3-8814-20de243465cf",
"Section": {
"FormTypeSectionId": "00492a2b-899a-49cb-81b8-e9f284160395",
"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": "8c9437dc-bfd3-44b8-98f1-ad12113f13f6",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "30688422-0868-4b70-834b-11bf1eae144e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "433cbe5b-aebe-4524-8dba-68d4b37ae23d",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T08:09:39.006504-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": "89fa1874-85c9-4eab-b10c-2389bc4f7eea",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T08:09:39.006504-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2025-06-02T08:09:39.006504-07:00",
"Location": "sample string 1",
"TaskId": "45ab5605-7f6b-43f9-92eb-cbd3a8cba1a2",
"Values": [
{
"FormFieldValueId": "a07af369-c127-41f3-bf3b-005f61538dd6",
"FormTypeField": {
"FormTypeFieldId": "a892e666-100a-49a3-8814-20de243465cf",
"Section": {
"FormTypeSectionId": "00492a2b-899a-49cb-81b8-e9f284160395",
"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": "8c9437dc-bfd3-44b8-98f1-ad12113f13f6",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "30688422-0868-4b70-834b-11bf1eae144e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "433cbe5b-aebe-4524-8dba-68d4b37ae23d",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T08:09:39.006504-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": "a07af369-c127-41f3-bf3b-005f61538dd6",
"FormTypeField": {
"FormTypeFieldId": "a892e666-100a-49a3-8814-20de243465cf",
"Section": {
"FormTypeSectionId": "00492a2b-899a-49cb-81b8-e9f284160395",
"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": "8c9437dc-bfd3-44b8-98f1-ad12113f13f6",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "30688422-0868-4b70-834b-11bf1eae144e",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "433cbe5b-aebe-4524-8dba-68d4b37ae23d",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T08:09:39.006504-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": "83625b7b-5a5d-4931-bd31-b0a12f2a217d",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-02T08:09:39.006504-07:00",
"LastModifiedUser": "sample string 5"
}
Response Information
Resource Description
On success, the updated form.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | Form |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"FormId": "0d2743e7-a987-4a29-9ba2-e039996ffbea",
"Asset": {
"AssetId": "97d1de3b-5918-4152-b1bb-4d979001d933",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "3fa01179-9915-44f9-bb5e-6626c4dc076b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "90a98dc9-de36-4c95-b1c0-193f67f147ca",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T08:09:39.006504-07:00",
"LastModifiedUser": "sample string 7"
},
"AssetGroup": {
"AssetGroupId": "43358a8c-6517-4e76-88f7-b3e019231168",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-02T08:09:39.006504-07:00",
"MeasurementValueNeededDate": "2025-06-02T08:09:39.006504-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "8f0cd43d-a009-4f30-ac79-ec74c1419c8b",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T08:09:39.006504-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"FormValueNeededDate": "2025-06-02T08:09:39.006504-07:00",
"MeasurementValueNeededDate": "2025-06-02T08:09:39.006504-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "242d2138-3446-45e4-b4c0-7292bc027d3d",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-02T08:09:39.006504-07:00",
"LastModifiedUser": "sample string 8"
},
"FormType": {
"FormTypeId": "a432ad60-2253-41fd-adb6-52c6873e90d3",
"Name": "sample string 1",
"Description": "sample string 2",
"AssetType": {
"AssetTypeId": "3fa01179-9915-44f9-bb5e-6626c4dc076b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayColor": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "90a98dc9-de36-4c95-b1c0-193f67f147ca",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-02T08:09:39.006504-07:00",
"LastModifiedUser": "sample string 7"
},
"FrequencyNeeded": 1,
"ValueNeededDate": "2025-06-02T08:09:39.006504-07:00",
"Fields": [
{
"FormTypeFieldId": "d364c125-8f4e-426b-b499-e4851ae64c29",
"Section": {
"FormTypeSectionId": "1ab247fd-9dad-4e99-9cc5-a45a9d3b33cb",
"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": "6b920233-ce11-43ad-a87d-cdb03a8c29b2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "823495c7-6a9d-4f47-bae1-a26b84083eda",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f8f60207-cf8c-4210-946d-b219e6ce757e",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T08:09:39.006504-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": "d364c125-8f4e-426b-b499-e4851ae64c29",
"Section": {
"FormTypeSectionId": "1ab247fd-9dad-4e99-9cc5-a45a9d3b33cb",
"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": "6b920233-ce11-43ad-a87d-cdb03a8c29b2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "823495c7-6a9d-4f47-bae1-a26b84083eda",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f8f60207-cf8c-4210-946d-b219e6ce757e",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T08:09:39.006504-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": "8ad31a1a-b11d-4ff0-9f62-ffbb449d1af3",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T08:09:39.006504-07:00",
"LastModifiedUser": "sample string 6"
},
"EffectiveDate": "2025-06-02T08:09:39.006504-07:00",
"Location": "sample string 1",
"TaskId": "9fc3e82b-13ce-40fb-9364-3a4588355676",
"Values": [
{
"FormFieldValueId": "264991ac-e458-485e-97e1-1adc031c318c",
"FormTypeField": {
"FormTypeFieldId": "d364c125-8f4e-426b-b499-e4851ae64c29",
"Section": {
"FormTypeSectionId": "1ab247fd-9dad-4e99-9cc5-a45a9d3b33cb",
"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": "6b920233-ce11-43ad-a87d-cdb03a8c29b2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "823495c7-6a9d-4f47-bae1-a26b84083eda",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f8f60207-cf8c-4210-946d-b219e6ce757e",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T08:09:39.006504-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": "264991ac-e458-485e-97e1-1adc031c318c",
"FormTypeField": {
"FormTypeFieldId": "d364c125-8f4e-426b-b499-e4851ae64c29",
"Section": {
"FormTypeSectionId": "1ab247fd-9dad-4e99-9cc5-a45a9d3b33cb",
"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": "6b920233-ce11-43ad-a87d-cdb03a8c29b2",
"Name": "sample string 1"
},
"Unit": {
"UnitId": "823495c7-6a9d-4f47-bae1-a26b84083eda",
"Code": "sample string 1",
"Description": "sample string 2",
"SourceSystemId": "sample string 3",
"CompanyId": "f8f60207-cf8c-4210-946d-b219e6ce757e",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-02T08:09:39.006504-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": "618a29a9-bd09-49bc-af65-1c375811d5e6",
"CreateDate": "2025-06-02T08:09:39.006504-07:00",
"CreateUser": "sample string 4",
"LastModifiedDate": "2025-06-02T08:09:39.006504-07:00",
"LastModifiedUser": "sample string 5"
},
"Total": 1,
"Message": "sample string 1"
}