Create, Update, or Delete Service Types
post
/api/CXIPlatformService/{version}/CXIReferenceEntity/serviceType
Create, update or delete one ore more Service Type records.
Request
Path Parameters
-
version(required): string
API version. Example: v1
Supported Media Types
- application/json
Nested Schema : items
Type:
Show Source
object
-
data(required): object
serviceType
-
operation(required): string
The field specifies the mode of operation. Supported operations: create,update or delete
Nested Schema : serviceType
Type:
Show Source
object
-
active: boolean
Boolean that is true if active, false if inactive.
-
code(required): string
Code for the Service Type.
-
color: string
Color used in graphs.
-
description(required): string
Description
-
icon: string
Icon displayed in User Interfaces.
-
id(required): string
Id for the record.
Examples
Back to Top
Response
Supported Media Types
- application/json
200 Response
The resource was updated successfully.
Nested Schema : serviceType
Type:
Show Source
object
-
active: boolean
Boolean that is true if active, false if inactive.
-
code(required): string
Code for the Service Type.
-
color: string
Color used in graphs.
-
description(required): string
Description
-
icon: string
Icon displayed in User Interfaces.
-
id(required): string
Id for the record.
Examples
204 Response
The resource was updated successfully, but a failure in returning the updated resource back
400 Response
An error is encountered due to an invalid request
Root Schema : Error
Type:
Show Source
object
-
code: string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
500 Response
An internal server error is encountered, due to an unknown reason
Root Schema : Error
Type:
Show Source
object
-
code: string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension