POST StateTypes
Creates a new state type.
Request Information
URI Parameters
None.
Body Parameters
State type to create. StateTypeId should not be filled in.
StateTypeName | Description | 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": "26c6b40f-21b4-488c-ac7f-a96d1fcf629d", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "71c46042-bec7-4c52-b81d-130c30155de2", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "864c4e3a-3a36-4dc3-bc1a-a8a71163fad9", "CreateDate": "2024-04-28T16:44:12.7658484-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T16:44:12.7658484-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "924a9a67-706a-460b-96c1-670da881e163", "CreateDate": "2024-04-28T16:44:12.7658484-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T16:44:12.7658484-07:00", "LastModifiedUser": "sample string 6" }
Response Information
Resource Description
On success, the created state type.
Name | Description | Type | Additional information |
---|---|---|---|
Data | StateType |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": { "StateTypeId": "3f25cf8d-16f9-4d20-a108-8fc9ebaf37c8", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "c4bcbf4c-5632-4f5a-888b-514ed506ae5b", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "ae16d35a-8f5b-4aa9-ba7a-7ebace632a8f", "CreateDate": "2024-04-28T16:44:12.7658484-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-04-28T16:44:12.7658484-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "27830dc8-60cf-4c98-8d4d-391fb1fea069", "CreateDate": "2024-04-28T16:44:12.7658484-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-04-28T16:44:12.7658484-07:00", "LastModifiedUser": "sample string 6" }, "Total": 1, "Message": "sample string 1" }