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": "18d2cb0b-bf50-4b7d-8c46-973e472822e8",
"Asset": {
"AssetId": "7639981b-245c-450e-87b0-f2487c379c7b",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "d483b783-bbca-448a-b77a-1760feaea25e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f0f71ae8-6392-4be9-a1fa-4ec11f11e84e",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "c9b1194a-91ce-4620-b9b6-fb4a79966045",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-25T14:48:00.7038765-07:00",
"MeasurementValueNeededDate": "2025-04-25T14:48:00.7038765-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "29fceaca-9c4f-45e8-903c-1867e375a670",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "95ef69b8-9c56-406d-b6f2-3f1443a2f2c2",
"EffectiveDate": "2025-04-25T14:48:00.7038765-07:00",
"StatusType": {
"StatusTypeId": "b02cb591-2872-4f67-9b78-f88b6fad54d8",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "d483b783-bbca-448a-b77a-1760feaea25e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f0f71ae8-6392-4be9-a1fa-4ec11f11e84e",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "71154cc4-c26f-4071-bb61-7fae46ba9013",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "aa453b7b-7cdf-4d9d-9e22-1f4cfada0628",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "8525b3ab-5e03-4c4f-bc48-8a01c34837a5",
"EffectiveDate": "2025-04-25T14:48:00.7038765-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "760228ad-fb98-47f0-98b1-d6acdb808cac",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "11a66bc3-55e4-44a8-a69c-9c5635abe97d",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "65d4c8d0-3b62-415d-adcb-3e762d0f9f1f",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-04-25T14:48:00.7038765-07:00",
"MeasurementValueNeededDate": "2025-04-25T14:48:00.7038765-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "4b609274-dd28-4a22-a5db-74eebdd7deb3",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-04-25T14:48:00.7038765-07:00",
"StateType": {
"StateTypeId": "61ae50fd-d038-4d44-83af-17268bb30838",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "d483b783-bbca-448a-b77a-1760feaea25e",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "f0f71ae8-6392-4be9-a1fa-4ec11f11e84e",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "75b171c6-e552-4c9d-9e1a-50b9a0ea7ed7",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "30472441-400b-4558-a646-92ca55044530",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-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": "ef2980f7-7c31-4793-a739-14911016a661",
"Asset": {
"AssetId": "0f4b3e5f-de98-4500-a35f-9e03aee83ac4",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "27c6ca47-6509-40b8-a947-a42316dc790d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e5e52a3d-4fe9-4f82-801b-fae6fe11d12b",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "4ab9370c-eca8-4776-830a-8acf86e9d186",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-04-25T14:48:00.7038765-07:00",
"MeasurementValueNeededDate": "2025-04-25T14:48:00.7038765-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "e62c5280-d724-4423-8d38-3cb9cb7159be",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "888b43ad-8794-4668-957c-fea7590e0991",
"EffectiveDate": "2025-04-25T14:48:00.7038765-07:00",
"StatusType": {
"StatusTypeId": "cc15d863-328f-4181-b065-b7b78e221d57",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "27c6ca47-6509-40b8-a947-a42316dc790d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e5e52a3d-4fe9-4f82-801b-fae6fe11d12b",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "01461591-4054-4fd4-ab20-8a258944f6d8",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ac5a034f-da18-45fb-a7af-d041ac68e349",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "5c4c3378-9cd8-42ae-b27d-b20731aa136a",
"EffectiveDate": "2025-04-25T14:48:00.7038765-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "bee7680f-b651-48d9-8611-5a4e98f1e370",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "f00fd1d5-ab46-4797-af5e-3771554a4f4f",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "c239abf1-ab46-4e87-9305-9df38af7e29d",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-04-25T14:48:00.7038765-07:00",
"MeasurementValueNeededDate": "2025-04-25T14:48:00.7038765-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "74621d63-f941-4bd8-a22d-faf88558df2c",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-04-25T14:48:00.7038765-07:00",
"StateType": {
"StateTypeId": "9f1fafbe-d2a5-4816-847c-99b8af2edde3",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "27c6ca47-6509-40b8-a947-a42316dc790d",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "e5e52a3d-4fe9-4f82-801b-fae6fe11d12b",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "3ae1274a-9300-47bc-b0a8-7582f893a9f4",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "da0f120a-9fb8-4316-9d9e-b536ee6a59ea",
"CreateDate": "2025-04-25T14:48:00.7038765-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-04-25T14:48:00.7038765-07:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}