POST States
Creates a new state.
Request Information
URI Parameters
None.
Body Parameters
The state to create. StateId should not be filled in.
State| Name | 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": "4b461a79-6af6-4441-81d3-f8a229148d89",
"Asset": {
"AssetId": "b9f41daf-c529-4881-b96f-e3de2219d844",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ca0e2be3-5309-4fe6-9315-85759b40e913",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "722a551c-49e7-47df-b6e7-19e582be699d",
"CreateDate": "2025-12-02T07:31:44.872434-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-02T07:31:44.872434-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "bf95f3b4-2a21-4eb4-b13a-d01011b64e28",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-02T07:31:44.872434-08:00",
"MeasurementValueNeededDate": "2025-12-02T07:31:44.872434-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "688b06a9-c01a-49ad-bc7c-d245415e813c",
"CreateDate": "2025-12-02T07:31:44.872434-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-02T07:31:44.872434-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "550d5374-641b-4eee-8c7b-2c12da7f55f7",
"EffectiveDate": "2025-12-02T07:31:44.872434-08:00",
"StatusType": {
"StatusTypeId": "200e7eca-801d-42d3-b17e-4c8ef1f2819a",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "ca0e2be3-5309-4fe6-9315-85759b40e913",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "722a551c-49e7-47df-b6e7-19e582be699d",
"CreateDate": "2025-12-02T07:31:44.872434-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-02T07:31:44.872434-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "435c3725-440d-4d3c-b505-39a2890ae469",
"CreateDate": "2025-12-02T07:31:44.872434-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-02T07:31:44.872434-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "60b50e16-ca34-4cd0-8fdf-b1b0d16a39ab",
"CreateDate": "2025-12-02T07:31:44.872434-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-02T07:31:44.872434-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "98917214-14ea-4786-b59f-2054e6f89ca5",
"EffectiveDate": "2025-12-02T07:31:44.872434-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "3e32aa98-8e36-4bd2-ad89-6b23b08b9644",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "cfceab32-e99e-4a82-afd8-bd0a7c5cead8",
"CreateDate": "2025-12-02T07:31:44.872434-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-02T07:31:44.872434-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "97dd8577-117f-41b9-97f3-d34cadc220a5",
"CreateDate": "2025-12-02T07:31:44.872434-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-02T07:31:44.872434-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-12-02T07:31:44.872434-08:00",
"MeasurementValueNeededDate": "2025-12-02T07:31:44.872434-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "f9169fa5-1d50-477a-a0c1-de61729d6143",
"CreateDate": "2025-12-02T07:31:44.872434-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-02T07:31:44.872434-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-12-02T07:31:44.872434-08:00",
"StateType": {
"StateTypeId": "431ae7ac-c387-464a-bb82-127ed6f9794c",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "ca0e2be3-5309-4fe6-9315-85759b40e913",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "722a551c-49e7-47df-b6e7-19e582be699d",
"CreateDate": "2025-12-02T07:31:44.872434-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-02T07:31:44.872434-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "ec537a38-d285-4ed9-b40f-2f0533ed6134",
"CreateDate": "2025-12-02T07:31:44.872434-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-02T07:31:44.872434-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a06e7159-55e8-4ec9-be23-7cee3868bbb2",
"CreateDate": "2025-12-02T07:31:44.872434-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-02T07:31:44.872434-08:00",
"LastModifiedUser": "sample string 4"
}
Response Information
Resource Description
On success, the created state.
| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | State |
None. |
|
| Total | integer |
None. |
|
| Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": {
"StateId": "d722d64d-ecd1-4ad0-9983-e59af17aaceb",
"Asset": {
"AssetId": "94bc0b15-3c51-445f-bbfd-230a2499dea6",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "2e2e9bc7-144f-43e5-9e01-02319a4c9878",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6c5b2383-bb0b-4089-910b-66079f797a81",
"CreateDate": "2025-12-02T07:31:44.9349382-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-02T07:31:44.9349382-08:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "2dff67bd-9aa1-4862-a95a-af9bdea4cbe0",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-12-02T07:31:44.9349382-08:00",
"MeasurementValueNeededDate": "2025-12-02T07:31:44.9349382-08:00",
"SourceSystemId": "sample string 3",
"CompanyId": "748a321a-4d65-403b-a0f7-e0386e26df3a",
"CreateDate": "2025-12-02T07:31:44.9349382-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-02T07:31:44.9349382-08:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "5b2f56f5-be52-4c01-93dd-ccc155cfb72d",
"EffectiveDate": "2025-12-02T07:31:44.9349382-08:00",
"StatusType": {
"StatusTypeId": "58f6f1dc-0dec-4c87-9cc6-977deeeb0564",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "2e2e9bc7-144f-43e5-9e01-02319a4c9878",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6c5b2383-bb0b-4089-910b-66079f797a81",
"CreateDate": "2025-12-02T07:31:44.9349382-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-02T07:31:44.9349382-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "7970c17f-31fc-421e-bd07-92c990899bbe",
"CreateDate": "2025-12-02T07:31:44.9349382-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-02T07:31:44.9349382-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4516667c-3a61-4372-b17e-e9f9fc7c4835",
"CreateDate": "2025-12-02T07:31:44.9349382-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-02T07:31:44.9349382-08:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "718ef6dc-2d07-4053-9867-7ad35d9dcac0",
"EffectiveDate": "2025-12-02T07:31:44.9349382-08:00",
"WellPurposeType": {
"WellPurposeTypeId": "baa6ee3b-7bea-46c2-ba2a-70ae0c0fdd6a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "b15790e5-f2cd-4205-9e8a-186cfb96cbbc",
"CreateDate": "2025-12-02T07:31:44.9349382-08:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-12-02T07:31:44.9349382-08:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "9ac4b410-3067-4de5-9c54-8e027ff05107",
"CreateDate": "2025-12-02T07:31:44.9349382-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-02T07:31:44.9349382-08:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-12-02T07:31:44.9349382-08:00",
"MeasurementValueNeededDate": "2025-12-02T07:31:44.9349382-08:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "595eca1e-6d69-4f97-b499-3491cf40fed0",
"CreateDate": "2025-12-02T07:31:44.9349382-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-02T07:31:44.9349382-08:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-12-02T07:31:44.9349382-08:00",
"StateType": {
"StateTypeId": "b5abe3cc-c330-4028-824d-e914609896a4",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "2e2e9bc7-144f-43e5-9e01-02319a4c9878",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "6c5b2383-bb0b-4089-910b-66079f797a81",
"CreateDate": "2025-12-02T07:31:44.9349382-08:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-12-02T07:31:44.9349382-08:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "f043a89e-83b9-4aaa-8bb0-499bf431785c",
"CreateDate": "2025-12-02T07:31:44.9349382-08:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-12-02T07:31:44.9349382-08:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "62ca305c-3d95-4075-a782-f089c5499603",
"CreateDate": "2025-12-02T07:31:44.9349382-08:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-12-02T07:31:44.9349382-08:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}