PUT States

Back to endpoints

PUT States

Updates the given state.

Request Information

URI Parameters

None.

Body Parameters

The state to update

State

Name	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": "e3a961ff-b411-4ea1-80af-f7a645007f0b",
  "Asset": {
    "AssetId": "874c8542-0eea-416c-bde0-318ebf57971e",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "DisplayOrder": 1,
    "AssetType": {
      "AssetTypeId": "57209406-2926-4f01-8f08-e88dbbb65f43",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "IsWell": true,
      "DisplayColor": "sample string 4",
      "SourceSystemId": "sample string 5",
      "CompanyId": "d903fbb2-4edf-4fd1-8b71-66a27d072223",
      "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
      "LastModifiedUser": "sample string 8"
    },
    "AssetGroup": {
      "AssetGroupId": "b7832ca1-f36b-4a58-a284-3bb7dcc28564",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "ParentGroup": null,
      "DisplayOrder": 1,
      "FormValueNeededDate": "2025-04-17T04:39:21.1890438-07:00",
      "MeasurementValueNeededDate": "2025-04-17T04:39:21.1890438-07:00",
      "SourceSystemId": "sample string 3",
      "CompanyId": "f49ebb21-46af-4b69-83a6-bc2863ca8402",
      "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
      "LastModifiedUser": "sample string 6"
    },
    "ParentAsset": null,
    "Location": "sample string 3",
    "Barcode": {
      "Format": 0,
      "Code": "sample string 1"
    },
    "Status": {
      "StatusId": "9493915f-ebe4-4649-9292-2e1df422f736",
      "EffectiveDate": "2025-04-17T04:39:21.1890438-07:00",
      "StatusType": {
        "StatusTypeId": "66461b1f-a362-41f8-b62f-b00c26c0b191",
        "Name": "sample string 1",
        "IsProducing": true,
        "IsInjecting": true,
        "AssetType": {
          "AssetTypeId": "57209406-2926-4f01-8f08-e88dbbb65f43",
          "Name": "sample string 1",
          "Description": "sample string 2",
          "IsWell": true,
          "DisplayColor": "sample string 4",
          "SourceSystemId": "sample string 5",
          "CompanyId": "d903fbb2-4edf-4fd1-8b71-66a27d072223",
          "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
          "CreateUser": "sample string 7",
          "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
          "LastModifiedUser": "sample string 8"
        },
        "SourceSystemId": "sample string 4",
        "CompanyId": "2d69f957-0c4c-4be8-8833-af68f2c7fb6a",
        "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
        "CreateUser": "sample string 6",
        "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
        "LastModifiedUser": "sample string 7"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "0ecce097-3ce0-4ba4-bff3-56bdaaaef5cf",
      "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
      "LastModifiedUser": "sample string 4"
    },
    "WellPurpose": {
      "WellPurposeId": "2bb129c5-a122-4b34-af65-d6e18076e8b9",
      "EffectiveDate": "2025-04-17T04:39:21.1890438-07:00",
      "WellPurposeType": {
        "WellPurposeTypeId": "0ec88077-e185-4526-9513-0ff121e63276",
        "IsProducer": true,
        "IsInjector": true,
        "Name": "sample string 3",
        "SourceSystemId": "sample string 4",
        "CompanyId": "9716b878-4793-4cb9-a9b1-cd8d771f6305",
        "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
        "CreateUser": "sample string 6",
        "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
        "LastModifiedUser": "sample string 7"
      },
      "SourceSystemId": "sample string 1",
      "CompanyId": "8e18af64-aa7c-4c5a-abae-9bee34b62945",
      "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
      "CreateUser": "sample string 3",
      "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
      "LastModifiedUser": "sample string 4"
    },
    "FormValueNeededDate": "2025-04-17T04:39:21.1890438-07:00",
    "MeasurementValueNeededDate": "2025-04-17T04:39:21.1890438-07:00",
    "HasChildren": true,
    "SourceSystemId": "sample string 5",
    "CompanyId": "6cb93df8-2dc8-45b5-9662-6dfd341962f2",
    "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
    "CreateUser": "sample string 7",
    "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
    "LastModifiedUser": "sample string 8"
  },
  "EffectiveDate": "2025-04-17T04:39:21.1890438-07:00",
  "StateType": {
    "StateTypeId": "08192590-36d9-40fd-bd98-ce50b7c1044c",
    "Name": "sample string 1",
    "IsOperational": true,
    "AssetType": {
      "AssetTypeId": "57209406-2926-4f01-8f08-e88dbbb65f43",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "IsWell": true,
      "DisplayColor": "sample string 4",
      "SourceSystemId": "sample string 5",
      "CompanyId": "d903fbb2-4edf-4fd1-8b71-66a27d072223",
      "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
      "LastModifiedUser": "sample string 8"
    },
    "SourceSystemId": "sample string 3",
    "CompanyId": "71cf02dd-0ea8-4e1a-93b1-c9b71e9ab62d",
    "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
    "CreateUser": "sample string 5",
    "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
    "LastModifiedUser": "sample string 6"
  },
  "SourceSystemId": "sample string 1",
  "CompanyId": "c7f86893-60be-4390-8f57-bc4351d4106c",
  "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
  "CreateUser": "sample string 3",
  "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
  "LastModifiedUser": "sample string 4"
}

Response Information

Resource Description

On success, the updated state.

Name	Type	Additional information
Data	State	None.
Total	integer	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": {
    "StateId": "56479d18-d10c-4bbe-9e3e-b65fe1c9df32",
    "Asset": {
      "AssetId": "4dc9a3a9-111c-4111-a057-2727b6cdb722",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "DisplayOrder": 1,
      "AssetType": {
        "AssetTypeId": "ba348727-c080-4b26-9bf0-40c82a89fde8",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsWell": true,
        "DisplayColor": "sample string 4",
        "SourceSystemId": "sample string 5",
        "CompanyId": "5538821f-cc00-4395-a8ba-15d36041386b",
        "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
        "LastModifiedUser": "sample string 8"
      },
      "AssetGroup": {
        "AssetGroupId": "9941755f-eb39-4c94-8486-c781955e034c",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "ParentGroup": null,
        "DisplayOrder": 1,
        "FormValueNeededDate": "2025-04-17T04:39:21.1890438-07:00",
        "MeasurementValueNeededDate": "2025-04-17T04:39:21.1890438-07:00",
        "SourceSystemId": "sample string 3",
        "CompanyId": "c6095682-cef2-4721-8ed4-22db609b7404",
        "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
        "CreateUser": "sample string 5",
        "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
        "LastModifiedUser": "sample string 6"
      },
      "ParentAsset": null,
      "Location": "sample string 3",
      "Barcode": {
        "Format": 0,
        "Code": "sample string 1"
      },
      "Status": {
        "StatusId": "c1fe4198-5a5b-49d8-9772-c9fe33f1ab7b",
        "EffectiveDate": "2025-04-17T04:39:21.1890438-07:00",
        "StatusType": {
          "StatusTypeId": "7e554d19-9dec-4046-9fa5-3635a7067626",
          "Name": "sample string 1",
          "IsProducing": true,
          "IsInjecting": true,
          "AssetType": {
            "AssetTypeId": "ba348727-c080-4b26-9bf0-40c82a89fde8",
            "Name": "sample string 1",
            "Description": "sample string 2",
            "IsWell": true,
            "DisplayColor": "sample string 4",
            "SourceSystemId": "sample string 5",
            "CompanyId": "5538821f-cc00-4395-a8ba-15d36041386b",
            "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
            "CreateUser": "sample string 7",
            "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
            "LastModifiedUser": "sample string 8"
          },
          "SourceSystemId": "sample string 4",
          "CompanyId": "f77aefca-4325-40d7-8d16-90f25e0c41cf",
          "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "952a741c-1202-4d2c-8195-1c8f116abaf1",
        "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
        "LastModifiedUser": "sample string 4"
      },
      "WellPurpose": {
        "WellPurposeId": "a5028265-5bde-4f36-afe5-06d4db9cac5b",
        "EffectiveDate": "2025-04-17T04:39:21.1890438-07:00",
        "WellPurposeType": {
          "WellPurposeTypeId": "1ebf9dce-bd62-4c5e-9ce0-eb53658a8418",
          "IsProducer": true,
          "IsInjector": true,
          "Name": "sample string 3",
          "SourceSystemId": "sample string 4",
          "CompanyId": "756dbaca-c65b-49f2-a5d9-141f835699c8",
          "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
          "CreateUser": "sample string 6",
          "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
          "LastModifiedUser": "sample string 7"
        },
        "SourceSystemId": "sample string 1",
        "CompanyId": "ee0b9bd9-32e8-4f14-997d-047508ce0856",
        "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
        "CreateUser": "sample string 3",
        "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
        "LastModifiedUser": "sample string 4"
      },
      "FormValueNeededDate": "2025-04-17T04:39:21.1890438-07:00",
      "MeasurementValueNeededDate": "2025-04-17T04:39:21.1890438-07:00",
      "HasChildren": true,
      "SourceSystemId": "sample string 5",
      "CompanyId": "2d0957ef-08c6-4c43-a769-208380905c50",
      "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
      "LastModifiedUser": "sample string 8"
    },
    "EffectiveDate": "2025-04-17T04:39:21.1890438-07:00",
    "StateType": {
      "StateTypeId": "09a9ee9a-4639-48b6-b6c2-0921bd4a0a76",
      "Name": "sample string 1",
      "IsOperational": true,
      "AssetType": {
        "AssetTypeId": "ba348727-c080-4b26-9bf0-40c82a89fde8",
        "Name": "sample string 1",
        "Description": "sample string 2",
        "IsWell": true,
        "DisplayColor": "sample string 4",
        "SourceSystemId": "sample string 5",
        "CompanyId": "5538821f-cc00-4395-a8ba-15d36041386b",
        "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
        "CreateUser": "sample string 7",
        "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
        "LastModifiedUser": "sample string 8"
      },
      "SourceSystemId": "sample string 3",
      "CompanyId": "78f3bdc5-67f2-4594-9e98-0d35d9e07887",
      "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
      "CreateUser": "sample string 5",
      "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
      "LastModifiedUser": "sample string 6"
    },
    "SourceSystemId": "sample string 1",
    "CompanyId": "6c9749c2-f96a-49e9-8b35-c8b851dc1bca",
    "CreateDate": "2025-04-17T04:39:21.1890438-07:00",
    "CreateUser": "sample string 3",
    "LastModifiedDate": "2025-04-17T04:39:21.1890438-07:00",
    "LastModifiedUser": "sample string 4"
  },
  "Total": 1,
  "Message": "sample string 1"
}