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": "03f074d7-88ab-40c8-828c-ac9aa94be719", "Asset": { "AssetId": "b218ef5d-39ab-4b6f-a5f1-29ed8e39ac3e", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d9665abf-fdb9-4a87-b367-0ba88bfb79df", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "81709114-df59-447b-be87-f43a92e52667", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "cc5dfcdb-dfc6-415b-a5d2-41639a23588a", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-01-30T16:58:24.1514311-08:00", "MeasurementValueNeededDate": "2025-01-30T16:58:24.1514311-08:00", "SourceSystemId": "sample string 3", "CompanyId": "12d2dc72-d031-40e0-9dd0-5e859224441c", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "Status": { "StatusId": "8c097558-b635-4150-aa1e-45dec77f3c93", "EffectiveDate": "2025-01-30T16:58:24.1514311-08:00", "StatusType": { "StatusTypeId": "623253cc-18bd-4f95-8f6a-f751a7ae4a62", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "d9665abf-fdb9-4a87-b367-0ba88bfb79df", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "81709114-df59-447b-be87-f43a92e52667", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "7f08b3c1-b667-4bc5-9445-8350fc381c63", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "883c5265-fb1e-4b21-873e-c724cd471e62", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "3cf20154-3d5e-43c1-b1e0-9ccebaa87a9c", "EffectiveDate": "2025-01-30T16:58:24.1514311-08:00", "WellPurposeType": { "WellPurposeTypeId": "92301563-8e56-494b-873e-6d5217047ae4", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "f3a0f4bd-6890-4cca-86cb-4c094ab57635", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "4c5f4e57-679e-4ded-8c97-8b0ec29f06db", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-01-30T16:58:24.1514311-08:00", "MeasurementValueNeededDate": "2025-01-30T16:58:24.1514311-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "dff8ddcf-e6e4-441e-8005-bbc9e5ed960c", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-01-30T16:58:24.1514311-08:00", "StateType": { "StateTypeId": "4eacefc6-00c1-462a-b240-8d821ea93fcc", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "d9665abf-fdb9-4a87-b367-0ba88bfb79df", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "81709114-df59-447b-be87-f43a92e52667", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "778982bf-494f-4953-8fc7-2fa6c7e332ba", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "5e44898f-1ed3-47a1-be58-6b3e1438ca08", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08: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": "7ea860f6-38b8-4284-9668-a91f3c9b65fa", "Asset": { "AssetId": "d9319704-7764-41f9-b089-7e6f26f206d1", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "516a62e3-63da-4369-8637-6dcf376b3cf6", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8c0ee8ee-c9a7-4fc3-85d4-d76f653b758f", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "db5ccc67-f59c-4bcb-99b4-cf6d218c75bb", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2025-01-30T16:58:24.1514311-08:00", "MeasurementValueNeededDate": "2025-01-30T16:58:24.1514311-08:00", "SourceSystemId": "sample string 3", "CompanyId": "1f113aa0-41a8-419d-90dc-f95731f89f20", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "Status": { "StatusId": "12651ee2-92ad-43ca-9739-1d843bd1b648", "EffectiveDate": "2025-01-30T16:58:24.1514311-08:00", "StatusType": { "StatusTypeId": "9271b79b-d452-4bd9-9a4c-58d2e007a45c", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "516a62e3-63da-4369-8637-6dcf376b3cf6", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8c0ee8ee-c9a7-4fc3-85d4-d76f653b758f", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "7e49a694-752b-4289-ab86-36cee367672f", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "aa71d85e-643d-435b-888c-dd78be38c581", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "a6f4e8eb-96de-4c31-a8cd-8047b296dbdf", "EffectiveDate": "2025-01-30T16:58:24.1514311-08:00", "WellPurposeType": { "WellPurposeTypeId": "077f9570-216a-4be1-ab33-fc2b25e872a2", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "511aed30-bb6e-42be-bea9-73f4c6a0754f", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 6", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "5441b0ec-2974-4367-a5ca-7fe3a431d77b", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2025-01-30T16:58:24.1514311-08:00", "MeasurementValueNeededDate": "2025-01-30T16:58:24.1514311-08:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "43b7a18a-c3ed-4842-ae3b-6ed108d928da", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 8" }, "EffectiveDate": "2025-01-30T16:58:24.1514311-08:00", "StateType": { "StateTypeId": "d3857094-d16c-4b00-890a-b840dffdb7ef", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "516a62e3-63da-4369-8637-6dcf376b3cf6", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "8c0ee8ee-c9a7-4fc3-85d4-d76f653b758f", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 7", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "bd517088-6975-4323-a77f-e81912f6389a", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 5", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "f1741ae2-7868-4526-89aa-aba6329bf894", "CreateDate": "2025-01-30T16:58:24.1514311-08:00", "CreateUser": "sample string 3", "LastModifiedDate": "2025-01-30T16:58:24.1514311-08:00", "LastModifiedUser": "sample string 4" }, "Total": 1, "Message": "sample string 1" }