PUT States
Updates the given state.
Request Information
URI Parameters
None.
Body Parameters
The state to update
StateName | Description | Type | Additional information |
---|---|---|---|
StateId | globally unique identifier |
None. |
|
Asset | Asset |
None. |
|
EffectiveDate | date |
None. |
|
StateType | StateType |
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:
{ "StateId": "2c8d2ae8-3975-46c3-a452-58b3abb29287", "Asset": { "AssetId": "09f80d6b-a2b8-408c-9465-61347c946bc5", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "a5867871-18a5-4092-a4b5-b6d1186af9aa", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "263800f3-a2fe-4f3f-8941-071936d84ee1", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "2632968a-897e-43aa-af1c-853f774fe64a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T04:54:54.0516987-07:00", "MeasurementValueNeededDate": "2025-07-19T04:54:54.0516987-07:00", "SourceSystemId": "sample string 3", "CompanyId": "1ecd4ca9-59b7-404a-bea5-486c4caab3f2", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "Status": { "StatusId": "01c1f5ce-69e0-43ab-8f9c-05e1dd08bde5", "EffectiveDate": "2025-07-19T04:54:54.0516987-07:00", "StatusType": { "StatusTypeId": "7889013d-2979-42e1-9bb8-7fd416db1705", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "a5867871-18a5-4092-a4b5-b6d1186af9aa", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "263800f3-a2fe-4f3f-8941-071936d84ee1", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "e71df365-7ab3-447d-b8b6-27fce69720e3", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "74e644cf-a91c-4c28-8b82-1d69b8e61ef1", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "0089537a-262b-4317-9a4d-eb0171bcdaee", "EffectiveDate": "2025-07-19T04:54:54.0516987-07:00", "WellPurposeType": { "WellPurposeTypeId": "4371c5c1-e761-434d-b908-38f18c2fb976", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "69c73313-0d0c-43a0-a282-1876154dffda", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "45105cce-2652-42af-8228-297b4fc9c0be", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-19T04:54:54.0516987-07:00", "MeasurementValueNeededDate": "2025-07-19T04:54:54.0516987-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "5a5f9f9c-0af6-4082-b82c-f994de364452", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-07-19T04:54:54.0516987-07:00", "StateType": { "StateTypeId": "85e6c014-eb7c-4c23-b230-9daf47cb677f", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "a5867871-18a5-4092-a4b5-b6d1186af9aa", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "263800f3-a2fe-4f3f-8941-071936d84ee1", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "a7d76019-1f58-4f71-b514-f30d3bcf3d9c", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "46567975-6b12-4297-8fee-a99afa1da26b", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 4" }
Response Information
Resource Description
On success, the updated state.
Name | Description | Type | Additional information |
---|---|---|---|
Data | State |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "StateId": "25f136b4-dd52-4b91-824f-750da4201e51", "Asset": { "AssetId": "f982f722-a68a-4f2a-b855-0dc956614eea", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "8179b2e0-8bce-432f-a44f-670d71ef99c2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3337a637-30c8-4320-b1ff-20f9f9e3335a", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "2138b23b-62ad-4b27-ad1b-166bed4bd0cb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-07-19T04:54:54.0516987-07:00", "MeasurementValueNeededDate": "2025-07-19T04:54:54.0516987-07:00", "SourceSystemId": "sample string 3", "CompanyId": "2b29c03a-955a-432f-aa3e-606b15940ba8", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "Status": { "StatusId": "b0cdb33e-816d-4134-aa8b-b41dbb8909ff", "EffectiveDate": "2025-07-19T04:54:54.0516987-07:00", "StatusType": { "StatusTypeId": "53e163c3-f695-42e5-a7eb-9a76d0778fe6", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "8179b2e0-8bce-432f-a44f-670d71ef99c2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3337a637-30c8-4320-b1ff-20f9f9e3335a", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "827d8220-8223-4adf-a3e9-4db8b07b1845", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "0e0362d8-a7e4-4da5-9cd7-db482dc5ae16", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "37474efa-75e8-46ec-9ea4-46314a373318", "EffectiveDate": "2025-07-19T04:54:54.0516987-07:00", "WellPurposeType": { "WellPurposeTypeId": "dda836a0-7181-4134-8cfc-850515c455b8", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f80735c1-f03b-4133-b77d-3514660851f6", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "32b1da3e-f949-40a2-aac5-576de6fafb91", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-07-19T04:54:54.0516987-07:00", "MeasurementValueNeededDate": "2025-07-19T04:54:54.0516987-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "214422df-3db3-4989-8e16-64ff027fc001", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-07-19T04:54:54.0516987-07:00", "StateType": { "StateTypeId": "84fdd472-5413-49f4-bcfc-1fcea08576fd", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "8179b2e0-8bce-432f-a44f-670d71ef99c2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "3337a637-30c8-4320-b1ff-20f9f9e3335a", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "df03033c-8452-4bb1-809f-0b14745e3fd3", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "7958cc10-8c14-405d-9f0d-abf489b0cb66", "CreateDate": "2025-07-19T04:54:54.0516987-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-07-19T04:54:54.0516987-07:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }