Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property

UI Field Name

Description

Specifications

Required

Anchor
description - CBS
description - CBS
description

Description

User-defined; description of this record.


N

Anchor
exportReleaseLevel - CBS
exportReleaseLevel - CBS
exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read onlyN

Anchor
exportTable - CBS
exportTable - CBS
exportTable

n/aRecord table information.read onlyN

Anchor
name - CBS
name - CBS
name

Name

Name used within the Controller to identify this Business Service.

Maximum 40 alphanumerics.

Y

Anchor
retainSysIds - CBS
retainSysIds - CBS
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
titleNote

In XML web services, retainSysIds is specified as an attribute in the <businessService> element.


Valid values: true/false (default is true).

N

Anchor
sysId - CBS
sysId - CBS
sysId

n/a

System ID field in the database for this Business Service record.

Persisted only if retainSysIds is set to true.

N

...

XML Request

JSON Request


Expand
titleXML 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 <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<businessService exportReleaseLevel="7.2.0.0" exportTable="ops_generic group" version="1"> 		<description/> 		<name>bus service 4</name> 		<sysId>ff4b77d628ae4bc78c78f383bf1265b0</sysId> 	</businessService> </businessServices>




Expand
titleJSON 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 } ]


Anchor
Modify a Business Service
Modify a Business Service
Modify a Business Service

...

Anchor
Read a Business Service Example Response
Read a Business Service Example Response
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


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



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