Business Service Web Services
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 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 |
|
Create a Business Service: Example Request
XML Request | JSON Request |
---|---|
Business Service: Properties
Property | UI Field Name | Description | Specifications | Required |
---|---|---|---|---|
| Description | User-defined; description of this record. | N | |
| n/a | Universal Controller release that the record was exported from. | read only | N |
| n/a | Record table information. | read only | N |
| Name | Name used within the Controller to identify this Business Service. | Maximum 40 alphanumerics. | Y |
| n/a | Specification for whether or not the Create a Business Service web service will persist the sysId property.
Note In XML web services, | Valid values: true/false (default is true). | N |
| 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 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 |
|
Delete a Business Service: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this Business Service. | String; URI parameter. | Y |
|
| Name used within the Controller to identify this Business Service. | String; URI parameter. | Y |
|
List Business Services
Description | |
---|---|
URI | |
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 |
List Business Services: Example Response
XML Request | JSON Request |
---|---|
Modify a Business Service
Description | |
---|---|
URI | http://host_name/uc/resources/businessservice |
HTTP Method | PUT |
Description | Modifies the Business Service specified by the |
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 | |
Example Response |
|
Modify a Business Service: Example Request
XML Request | JSON Request |
---|---|
Read a Business Service
URI | |
HTTP Method | GET |
Description | Retrieves information on a specific Business Service. |
URI Parameters | See Read a Business Service: URI Parameters, below. |
Example URI | |
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 |
Read a Business Service: URI Parameters
Parameter | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify this Business Service. | String; URI parameter. | Y |
|
| Name used within the Controller to identify this Business Service. | String; URI parameter. | Y |
|
Read a Business Service: Example Response
The retainSysIds
and version
properties are specified as attributes in XML.
The exportReleaseLevel
and exportTable
properties are specified as attributes in XML.
XML Response | JSON Response |
---|---|