POST StateTypes

Back to endpoints

POST StateTypes

Creates a new state type.

Request Information

URI Parameters

None.

Body Parameters

State type to create. StateTypeId should not be filled in.

StateType

Name	Type	Additional 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": "5c4964cb-c093-4a5d-890e-6d06b4ca2a2d",
  "Name": "sample string 1",
  "IsOperational": true,
  "AssetType": {
    "AssetTypeId": "997ad0b2-f613-44ec-97e3-f51cc0ffe4a6",
    "Name": "sample string 1",
    "Description": "sample string 2",
    "IsWell": true,
    "DisplayColor": "sample string 4",
    "SourceSystemId": "sample string 5",
    "CompanyId": "0e04d11f-ee79-4db7-abdd-1a4e0eb2a0c7",
    "CreateDate": "2024-04-25T00:19:43.5568854-07:00",
    "CreateUser": "sample string 7",
    "LastModifiedDate": "2024-04-25T00:19:43.5568854-07:00",
    "LastModifiedUser": "sample string 8"
  },
  "SourceSystemId": "sample string 3",
  "CompanyId": "ee8e96c4-e05f-40fb-8af0-5a93b6a12830",
  "CreateDate": "2024-04-25T00:19:43.5568854-07:00",
  "CreateUser": "sample string 5",
  "LastModifiedDate": "2024-04-25T00:19:43.5568854-07:00",
  "LastModifiedUser": "sample string 6"
}

Response Information

Resource Description

On success, the created state type.

Name	Type	Additional information
Data	StateType	None.
Total	integer	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Data": {
    "StateTypeId": "e4fe4ee9-fa2b-458c-9149-5499149f894e",
    "Name": "sample string 1",
    "IsOperational": true,
    "AssetType": {
      "AssetTypeId": "00a4bae4-65c3-4499-aee6-a7b0f57d7f6a",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "IsWell": true,
      "DisplayColor": "sample string 4",
      "SourceSystemId": "sample string 5",
      "CompanyId": "89a9c0a6-367a-4bad-928d-f53a11a5e227",
      "CreateDate": "2024-04-25T00:19:43.5568854-07:00",
      "CreateUser": "sample string 7",
      "LastModifiedDate": "2024-04-25T00:19:43.5568854-07:00",
      "LastModifiedUser": "sample string 8"
    },
    "SourceSystemId": "sample string 3",
    "CompanyId": "3653b0ac-f9fd-4c39-9b8c-814f55d3cc19",
    "CreateDate": "2024-04-25T00:19:43.5568854-07:00",
    "CreateUser": "sample string 5",
    "LastModifiedDate": "2024-04-25T00:19:43.5568854-07:00",
    "LastModifiedUser": "sample string 6"
  },
  "Total": 1,
  "Message": "sample string 1"
}