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": "4618c1cb-6a7c-4e37-8dac-e670faa1e654",
"Asset": {
"AssetId": "452b2e05-7c34-49cc-bfc3-e15ee7b9d19e",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "7df706d1-1e87-4eae-8778-9cc8bf150620",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e8aba022-e1dd-4290-b389-0f936c36ee5a",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "9f5a51a7-5c79-4c39-9e0a-85bf04313959",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-27T01:07:30.4723291-07:00",
"MeasurementValueNeededDate": "2025-06-27T01:07:30.4723291-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e06c0402-3c8a-4c2f-9aae-b182100a28e4",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "1fc50cff-2eed-4d99-9ea8-590b913656fa",
"EffectiveDate": "2025-06-27T01:07:30.4723291-07:00",
"StatusType": {
"StatusTypeId": "59d528e0-f803-48b0-99ca-6752bfe6ab89",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "7df706d1-1e87-4eae-8778-9cc8bf150620",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e8aba022-e1dd-4290-b389-0f936c36ee5a",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "ba884caf-48fc-4a50-b9b6-c81de38a5d0b",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b362a6d7-f000-40b5-b118-e5071b48c8c5",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "4ce9dac6-7fce-48aa-8b13-ddf8364bef15",
"EffectiveDate": "2025-06-27T01:07:30.4723291-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "c1ddf39f-052e-42ae-918e-368993ed9cd7",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "9bf07876-99f4-4899-bbd1-ff1ed6ac296d",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "8f6a55ce-7076-48fc-9f07-fbc3d9f7e44f",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-06-27T01:07:30.4723291-07:00",
"MeasurementValueNeededDate": "2025-06-27T01:07:30.4723291-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "233c3be3-d18d-4fc0-ade0-bd3b133dd526",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-06-27T01:07:30.4723291-07:00",
"StateType": {
"StateTypeId": "9896a236-fc5c-433a-9a6e-b53f396205d5",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "7df706d1-1e87-4eae-8778-9cc8bf150620",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e8aba022-e1dd-4290-b389-0f936c36ee5a",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "fd74346e-e8ba-4eb0-952e-2bd8e0b5c07e",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "d09a21e1-64b8-47e6-9de2-f4164a0910a2",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07: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": "8d82126c-0271-4e39-adff-675f975939c3",
"Asset": {
"AssetId": "1a839c0c-97a7-409a-9cee-a64233ff0fd7",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "87b328cb-e901-464b-8010-8f2eff32d570",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "25d5773e-877b-425d-8f10-29777fd99bae",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4edd483e-6c7d-480d-af92-2190e0a2d94e",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-06-27T01:07:30.4723291-07:00",
"MeasurementValueNeededDate": "2025-06-27T01:07:30.4723291-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "337b9de9-a02c-4512-80e1-4d35a4a5aac5",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "4dfe6234-d3ef-45b7-bf09-7c52198d14b7",
"EffectiveDate": "2025-06-27T01:07:30.4723291-07:00",
"StatusType": {
"StatusTypeId": "a367451d-e87a-4e8e-9dce-8fd1267d5275",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "87b328cb-e901-464b-8010-8f2eff32d570",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "25d5773e-877b-425d-8f10-29777fd99bae",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "311d48f2-4141-4231-8678-ae4f477da431",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "6766ae7e-ff97-440b-a7d9-c35759e953e0",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "72ea953e-192a-4453-82f6-a0b51beb8d14",
"EffectiveDate": "2025-06-27T01:07:30.4723291-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "dc339418-6380-443b-bd70-185aea06d2dc",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "05b68c56-b7ee-4aa9-9ad1-5583c7d01e89",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "76babf4e-ee6b-4648-a27e-5f9c53687417",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-06-27T01:07:30.4723291-07:00",
"MeasurementValueNeededDate": "2025-06-27T01:07:30.4723291-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "2fd214b3-6c5c-46dd-9e96-c654a9ed2df7",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-06-27T01:07:30.4723291-07:00",
"StateType": {
"StateTypeId": "447e8d5a-0a9c-40ae-9433-bd7bcbef9421",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "87b328cb-e901-464b-8010-8f2eff32d570",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "25d5773e-877b-425d-8f10-29777fd99bae",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "cccbc9bc-d4a0-4c69-b66a-dc1f07a67cda",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "469537c8-bc7f-431e-98fd-2f9b9ec36142",
"CreateDate": "2025-06-27T01:07:30.4723291-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-06-27T01:07:30.4723291-07:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}