DELETE StateTypes

Deletes the given state type, including all states of that type.

Request Information

URI Parameters

None.

Body Parameters

State type to delete

StateType
NameDescriptionTypeAdditional information
StateTypeId

globally unique identifier

None.

Name

string

None.

IsOperational

boolean

None.

AssetType

AssetType

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:
{
  "StateTypeId": "df3ba12a-8cb6-4d84-9c68-3341456db6b5",
  "Name": "sample string 1",
  "IsOperational": true,
  "AssetType": {
    "AssetTypeId": "c98481b1-7e9e-42df-8675-c03df909a20f",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "IsWell": true,
    "DisplayColor": "sample string 4",
    "SourceSystemId": "sample string 5",
    "CompanyId": "51bcfeba-95d8-4f4b-a504-28c8e2fc2e42",
    "CreateDate": "2024-03-27T20:18:37.0205526-07:00",
    "CreateUser": "sample string 7",
    "LastModifiedDate": "2024-03-27T20:18:37.0205526-07:00",
    "LastModifiedUser": "sample string 8"
  },
  "SourceSystemId": "sample string 3",
  "CompanyId": "77268a43-8c05-40d9-846f-28c8cc7648cd",
  "CreateDate": "2024-03-27T20:18:37.0205526-07:00",
  "CreateUser": "sample string 5",
  "LastModifiedDate": "2024-03-27T20:18:37.0205526-07:00",
  "LastModifiedUser": "sample string 6"
}

Response Information

Resource Description

NameDescriptionTypeAdditional information
Data

Object

None.

Total

integer

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {},
  "Total": 1,
  "Message": "sample string 2"
}