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": "3253c146-eea5-4359-96a4-564c53366487",
"Asset": {
"AssetId": "d2c60c9b-1d79-4e2d-9bb5-eeee540ca127",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "ce753bf2-a3d9-4f90-84c1-19ef86811936",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b71653ef-fe58-4285-bb0e-e96fc2606684",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "88471b46-37d7-4795-a0ef-12ae63e06636",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T15:26:29.764677-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:26:29.764677-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "0df26e14-c50f-4a2a-9b17-a79ce3fa05ce",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "d8cf6b34-feba-4325-9a92-c73b8a68e480",
"EffectiveDate": "2025-10-13T15:26:29.764677-07:00",
"StatusType": {
"StatusTypeId": "93a8f5ce-3c38-401c-972c-790fe76c9343",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "ce753bf2-a3d9-4f90-84c1-19ef86811936",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b71653ef-fe58-4285-bb0e-e96fc2606684",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "a3a03692-1355-4f5a-af58-74c3402c6392",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "4ae8353c-42ff-4131-b10d-9f57a628ca8e",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "4ead203b-e4dc-4b19-a12a-9ce83fb541b7",
"EffectiveDate": "2025-10-13T15:26:29.764677-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "498fd003-5264-4073-a52f-6e19ac33ce53",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "653cb61c-2cd7-4a36-8cbb-9027e7d5317e",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "ece0dd92-d968-46c4-afcf-503b08da7215",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-10-13T15:26:29.764677-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:26:29.764677-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "6e57bca7-100a-4782-ae2b-fa6c516a5523",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-10-13T15:26:29.764677-07:00",
"StateType": {
"StateTypeId": "d121da42-b27f-415b-a7e0-34cba93b7e6d",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "ce753bf2-a3d9-4f90-84c1-19ef86811936",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "b71653ef-fe58-4285-bb0e-e96fc2606684",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "e28deba5-5833-49e0-8f48-f81db0b3422e",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "e2702d09-649f-495a-b126-f66a95eac9b0",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:26:29.764677-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": "52f828e1-6fdc-4677-8c49-1352d899a3bf",
"Asset": {
"AssetId": "0f505391-4cb5-4ad9-8a48-3538e6a567ce",
"Name": "sample string 1",
"Description": "sample string 2",
"DisplayOrder": 1,
"AssetType": {
"AssetTypeId": "9a18a9f5-db4f-46ad-b3f7-23782e1c89a0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "62a9d659-5e31-4f7d-8d18-a44ac14d71aa",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 8"
},
"AssetGroup": {
"AssetGroupId": "bd44a8dc-6b1e-4fcb-bc58-15e7bcffaf07",
"Name": "sample string 1",
"Description": "sample string 2",
"ParentGroup": null,
"DisplayOrder": 1,
"FormValueNeededDate": "2025-10-13T15:26:29.764677-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:26:29.764677-07:00",
"SourceSystemId": "sample string 3",
"CompanyId": "027aafe6-82fb-4967-8f10-569e0722655b",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 6"
},
"ParentAsset": null,
"Location": "sample string 3",
"Barcode": {
"Format": 0,
"Code": "sample string 1"
},
"Status": {
"StatusId": "29249d46-7d66-47ed-a210-ce51a7d57dc2",
"EffectiveDate": "2025-10-13T15:26:29.764677-07:00",
"StatusType": {
"StatusTypeId": "c5c95a6e-81df-423c-956e-c06b9b6cc84c",
"Name": "sample string 1",
"IsProducing": true,
"IsInjecting": true,
"AssetType": {
"AssetTypeId": "9a18a9f5-db4f-46ad-b3f7-23782e1c89a0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "62a9d659-5e31-4f7d-8d18-a44ac14d71aa",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 4",
"CompanyId": "4fca5095-af8d-4330-9fbb-16230c219d28",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "19956382-8562-4333-8248-ca14d372d3e7",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 4"
},
"WellPurpose": {
"WellPurposeId": "9ecedf0a-fb33-4dae-9c5c-a6f279fbeabf",
"EffectiveDate": "2025-10-13T15:26:29.764677-07:00",
"WellPurposeType": {
"WellPurposeTypeId": "35429b33-7685-4f93-8c45-dc8409cb069a",
"IsProducer": true,
"IsInjector": true,
"Name": "sample string 3",
"SourceSystemId": "sample string 4",
"CompanyId": "52d99105-e8e2-42a5-83a9-fce6903a2804",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 6",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 7"
},
"SourceSystemId": "sample string 1",
"CompanyId": "b04cd2f1-e8a9-4d94-a826-fc0e60aec264",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 4"
},
"FormValueNeededDate": "2025-10-13T15:26:29.764677-07:00",
"MeasurementValueNeededDate": "2025-10-13T15:26:29.764677-07:00",
"HasChildren": true,
"SourceSystemId": "sample string 5",
"CompanyId": "58b48564-dd83-4615-84a7-ddd6663d3043",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 8"
},
"EffectiveDate": "2025-10-13T15:26:29.764677-07:00",
"StateType": {
"StateTypeId": "13be2a9b-933b-4c51-8737-93910480d577",
"Name": "sample string 1",
"IsOperational": true,
"AssetType": {
"AssetTypeId": "9a18a9f5-db4f-46ad-b3f7-23782e1c89a0",
"Name": "sample string 1",
"Description": "sample string 2",
"IsWell": true,
"DisplayColor": "sample string 4",
"SourceSystemId": "sample string 5",
"CompanyId": "62a9d659-5e31-4f7d-8d18-a44ac14d71aa",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 7",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 8"
},
"SourceSystemId": "sample string 3",
"CompanyId": "2e38e60a-5a24-438a-90c6-bba1c9c9004c",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 5",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 6"
},
"SourceSystemId": "sample string 1",
"CompanyId": "a8158310-3e70-43c4-9648-57d4da06505f",
"CreateDate": "2025-10-13T15:26:29.764677-07:00",
"CreateUser": "sample string 3",
"LastModifiedDate": "2025-10-13T15:26:29.764677-07:00",
"LastModifiedUser": "sample string 4"
},
"Total": 1,
"Message": "sample string 1"
}