Overview

Universal Controller supports the following RESTful-based web services for Business Service operations, which are listed alphabetically on this page.

Create a Business Service
Delete a Business Service
List Business Services
Modify a Business Service
Read a Business Service

Formatting specifications for each web service, including details about property requirements, are provided.

Create a Business Service

	Description
URI	http://host_name/uc/resources/businessservice
HTTP Method	POST
Description	Creates a Business Service.
Example URI	http://localhost:8080/uc/resources/businessservice
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example Request	See Create a Business Service: Example Request, below.
Business Service Properties	See Business Service Properties, below.
Example Response	Status 200 /OK Successfully created the Business Service with sysId {sysId}.

Create a Business Service: Example Request

XML Request

JSON Request

XML Request

 <businessService retainSysIds="true">
	<description>1</description>
	<name>test</name>
	<sysId>e3a0d7b81f904c8fa4ae55cde6d58665</sysId>
</businessService>

JSON Request

{
  "description": 1,
  "name": "test",
  "retainSysIds": true,
  "sysId": "e3a0d7b81f904c8fa4ae55cde6d58665"
}

Business Service: Properties

Property	UI Field Name	Description	Specifications	Required
`description`	Description	User-defined; description of this record.		N
`exportReleaseLevel`	n/a	Universal Controller release that the record was exported from.	read only	N
`exportTable`	n/a	Record table information.	read only	N
`name`	Name	Name used within the Controller to identify this Business Service.	Maximum 40 alphanumerics.	Y
`retainSysIds`	n/a	Specification for whether or not the Create a Business Service web service will persist the sysId property. If retainSysIds="true" and `sysId` is included in the request/response, `sysId` will be persisted to the database. If retainSysIds="false" and `sysId` is included in the request/response, `sysId` will be ignored; it will be autogenerated by the Controller. Note In XML web services, `retainSysIds` is specified as an attribute in the <businessService> element.	Valid values: true/false (default is true).	N
`sysId`	n/a	System ID field in the database for this Business Service record.	Persisted only if retainSysIds is set to true.	N

Delete a Business Service

	Description
URI	http://host_name/uc/resources/businessservice
HTTP Method	DELETE
Description	Deletes a Business Service.
URI Parameters	See Delete a Business Service: URI Parameters, below.
Example URI	http://localhost:8080/uc/resources/businessservice?busserviceid=77171434c0a801c9016d5b2b5d17ddee
Example Response	Status 200 /OK Business Service deleted successfully. Status 400 /Bad Request Mutual exclusion violation. Cannot specify `busservicename` and `bussserviceid` at the same time. Status 404 /Not Found A business service with {name/id} "test" does not exist.

Delete a Business Service: URI Parameters

Parameter	Description	Specifications	Required	Mutually Exclusive With
`busserviceid`	ID used within the Controller to identify this Business Service.	String; URI parameter.	Y (unless `busservicename` is specified)	`busservicename`
`busservicename`	Name used within the Controller to identify this Business Service.	String; URI parameter.	Y (unless `busserviceid` is specified)	`busserviceid`

List Business Services

	Description
URI	http://host_name/uc/resources/businessservice/list
HTTP Method	GET
Description	Retrieves information on all Business Services.
Example URI	http://localhost:8080/uc/resources/businessservice/list
Authentication	HTTP Basic
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Example Response	See List Business Services: Example Response, below.
Response Properties	See Business Service Properties.

List Business Services: Example Response

XML Request

JSON Request

XML Request

<businessServices>
	<businessService exportReleaseLevel="7.2.0.0" exportTable="ops_generic group" version="1"> <description /> <name>bus service 1</name> <sysId>639d90bf8b61479191f46b1e524ac916</sysId> </businessService> <businessService exportReleaseLevel="7.2.0.0" exportTable="ops_generic group" version="4"> <description/> <name>bus service 2</name> <sysId>0ff4a7bafa0441a9b1a57b6451344ab6</sysId> </businessService> <businessService exportReleaseLevel="7.2.0.0" exportTable="ops_generic group"" version="1"> <description/> <name>bus service 3</name> <sysId>2822fa2848de438c97167bfa1d7a633c</sysId> </businessService> <businessService exportReleaseLevel="7.2.0.0" exportTable="ops_generic group" version="1"> <description/> <name>bus service 4</name> <sysId>ff4b77d628ae4bc78c78f383bf1265b0</sysId> </businessService> </businessServices>

JSON Request

[
  {
  "description": null,
  "exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_generic_group",
"name": "bus service 1", "sysId": "639d90bf8b61479191f46b1e524ac916", "version": 1 }, { "description" " null,
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_generic_group",
"name": "bus service 2", "sysId": "0ff4a7bafa0441a9b1a57b6451344ab6", "version": 4 }, { "description": null,
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_generic_group",
"name": "bus service 3", "sysId": "2822fa2848de438c97167bfa1d7a633c", "version": 1 }, { "description": null,
"exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_generic_group",
"name": "bus service 4", "sysId": "ff4b77d628ae4bc78c78f383bf1265b0", "version": 1 } ]

Modify a Business Service

	Description
URI	http://host_name/uc/resources/businessservice
HTTP Method	PUT
Description	Modifies the Business Service specified by the `sysId`.
Example URI	http://localhost:8080/uc/resources/businessservice
Consumes Content-Type	application/xml, application/json
Produces Content-Type	n/a
Example Request	See Modify a Business Service: Example Request, below.
Business Service Properties	See Business Service Properties.
Example Response	Status 200 /OK Successfully updated the business service with sysId <sysId> to version <version>.

Modify a Business Service: Example Request

XML Request

JSON Request

XML Request

 <businessService>
	<description>1</description>
	<name>test</name>
	<sysId>e3a0d7b81f904c8fa4ae55cde6d58665</sysId>
</businessService>

JSON Request

{
  "description": 1,
  "name": "test",
  "sysId": "e3a0d7b81f904c8fa4ae55cde6d58665"
}

Read a Business Service

URI	http://host_name/uc/resources/businessservice
HTTP Method	GET
Description	Retrieves information on a specific Business Service.
URI Parameters	See Read a Business Service: URI Parameters, below.
Example URI	http://localhost:8080/uc/resources/businessservice?busservicename=test http://localhost:8080/uc/resources/businessservice?busserviceid=f87848b00a0001037f43e7c81c8ec969
Consumes Content-Type	n/a
Produces Content-Type	application/xml, application/json
Example Response	See Read a Business Service: Example Response, below.
Business Service Properties	See Business Service Properties.

Read a Business Service: URI Parameters

Parameter	Description	Specifications	Required	Mutually Exclusive With
`busserviceid`	ID used within the Controller to identify this Business Service.	String; URI parameter.	Y (unless `busservicename` is specified)	`busservicename`
`busservicename`	Name used within the Controller to identify this Business Service.	String; URI parameter.	Y (unless `busserviceid` is specified)	`busserviceid`

Read a Business Service: Example Response

The retainSysIdsand versionproperties are specified as attributes in XML.

The exportReleaseLevel and exportTable properties are specified as attributes in XML.

XML Response

JSON Response

XML Response

<businessService exportReleaseLevel="7.2.0.0" exportTable="ops_generic group" retainSysIds="true"version="1"> <description>1</description> <name>test</name> <sysId>e3a0d7b81f904c8fa4ae55cde6d58665</sysId> </businessService>

JSON Response

{
  "description": 1,
  "exportReleaseLevel": "7.2.0.0",
"exportTable": "ops_generic_group",
"name": "test", "retainSysIds": true, "sysId": "e3a0d7b81f904c8fa4ae55cde6d58665", "version": 1 }

Browser not supported