...
Universal Controller supports the following RESTful-based web services for Business Service operations, which are listed alphabetically on this page.
- Business Service Web Services#Create Create a Business ServiceBusiness Service Web Services#Delete
- Delete a Business Service
- List Business Service Web Services#List Business ServicesBusiness
- Service Web Services#Modify Modify a Business ServiceBusiness Service Web Services#Read
- Read a Business Service
Formatting specifications for each web service, including details about property requirements, are provided.
...
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 Web Services#Business Service Properties, below. |
Example Response |
|
...
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. Html bobswift |
| 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 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 Web Services#Business Service Properties. |
| Anchor | ||||
|---|---|---|---|---|
|
...
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 | See Business Service Web Services#Business Service Properties. |
Example Response |
|
...
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 | See Business Service Web Services#Business Service Properties. |
| Anchor | ||||
|---|---|---|---|---|
|
...