Overview

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

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}.

XML Request	JSON Request
<businessService retainSysIds="true"> <description>1</description> <name>test</name> <sysId>e3a0d7b81f904c8fa4ae55cde6d58665</sysId> </businessService>	{ "description": 1, "name": "test", "retainSysIds": true, "sysId": "e3a0d7b81f904c8fa4ae55cde6d58665" }

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

	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.