Search Service Operations

Software AG Products 10.11 | CentraSite for Developers | Web Service Interfaces | Approval Service | Search Service Operations

The Search service provides a set of operations that supplies various information about registered services inside CentraSite.

The WSDL for the Search service is located here:

http://server:port/wsstack/services/SearchService?wsdl

where server is the machine in which the Software AG Runtime is running and port is the port on which the Software AG Runtime is listening (port 53307 if CentraSite is configured to use the default Software AG Runtime port number).

The following lists the operations that the Search service provides:

findAllServices

findServices

findOrganizations

getAllServiceDetails

getServiceDetails

getAllAssociatedServices

getAssociatedServices

findServices and findAllServices

The findServices operation returns a list of services in CentraSite. You can optionally filter the list by specific criteria.

The findAllServices operation, in addition, returns a list of registered services in Integration Server.

Input Message

Parameter Name	Description
locationCentraSite	(Optional). (String). The address of the CentraSite registry repository (CRR) from which you want to retrieve the search requests. The registry or repository runs at the following URL: http://server:port/CentraSite/CentraSite Where server is the machine on which the CRR is running and port is the port on which CentraSite is listening to requests. If you do not specify locationCentraSite, the Search service uses the following default URL: http://localhost:53307/CentraSite/CentraSite
keyword	(Mandatory). (String). The pattern for matching an exact service name or %, or * for matching all services.
organizationKey	(Optional). (String). (Array). The UDDI key or the organization name where the services belong to.
owner	Optional). (String). (Array). The first and last name of the owner of services to be selected. The first and last name must be separated with a ,.
lifeCycleStateName	(Optional). (String). The name of a valid lifecycle state currently active with the service type. Only the services matching that lifecycle state will be selected. You may specify multiple lifecycle state name elements to match more states.
product	(Optional). (String). A product name the service is classified with. If specified it must be a valid name among the Products taxonomy of CentraSite, for example, ARIS. You may specify multiple product name elements to match more product classifications.
locale	(Optional). (String). The locale in which you want the results to be returned.
sortCriteria	Sort criteria for returning the result in a sorted order. Possible values are: SortByNameAsc SortByNameDesc SortByDateAsc SortByDateDesc Organization
scroll	(Optional). (Scroll). If you want to return a particular block of entries from the result set, specify the following values in the scroll element.
	start	(Integer). The first entry that you want to include in the block (where 1 represents the first entry in the entire result set).
	number	(Optional). (Integer). The number of entries to be returned in the block of approval requests. If you specify a start value, but no number value, then the remainder of the result set is returned.

Output Message

ServiceInfo[]

Parameter Name	Description
ServiceInfo - An array of ServiceInfo elements. Each ServiceInfo entry represents one registered service. The ServiceInfo message has the following details:
key	The UDDI key of the service.
name	The display name of the service.
wsdlURL	The URL of the service’s WSDL in the CentraSite repository.
lifeCycleState	The name of the current lifecycle state
owner	The user who created the service.
organizationKey	The UDDI key of the organization which owns the service.
organizationName	The organization which owns the service.
version	The user-assigned version identifier for the service.

Example SOAP Request

Returns the first 10 services for a particular organization, sorted by name in ascending order:

<soapenv:Body>
<findAllServices>
<locationCentraSite></locationCentraSite>
<keyword>*<keyword>
<organizationKey>uddi:207ff1cc-25c5-544c-415c-5d98ea91060c
</organizationKey>
<owner></owner>
<product></product>
<locale>EN</locale>
<sortCriteria>SortByNameAsc</sortCriteria>
<scroll>
<start>1</start>
<number>10</number>
</scroll>
</findAllServices>
</soapenv:Body>

findOrganizations

The findOrganizations operation returns a list of organizations in CentraSite. You can optionally filter the list by specific criteria.

Input Message

Parameter Name	Description
locationCentraSite	(Optional). (String). The address of the CentraSite registry repository (CRR) from which you want to retrieve the search requests. The registry or repository runs at the following URL: http://server:port/CentraSite/CentraSite Where server is the machine on which the CRR is running and port is the port on which CentraSite is listening to requests. If you do not specify locationCentraSite, the Search service uses the following default URL: http://localhost:53307/CentraSite/CentraSite
keyword	(Mandatory). (String). The pattern for matching an exact organization name or %, or * for matching all organizations.
locale	(Optional). (String). The locale in which you want the results to be returned.
sortCriteria	Sort criteria for returning the result in a sorted order. Possible values are: SortByNameAsc SortByNameDesc SortByDateAsc SortByDateDesc Organization
scroll	(Optional). (Scroll). If you want to return a particular block of entries from the result set, specify the following values in the scroll element.
	start	(Integer). The first entry that you want to include in the block (where 1 represents the first entry in the entire result set).
	number	(Optional). (Integer). The number of entries to be returned in the block of approval requests. If you specify a start value, but no number value, then the remainder of the result set is returned.

Output Message

OrganizationInfo[]

Parameter Name	Description
OrganizationInfo - An array of OrganizationInfo elements. Each OrganizationInfo entry represents one organization. The OrganizationInfo message has the following details:
key	The UDDI key of the organization.
name	The display name of the organization.
description	The description for the organization.

Example SOAP Request

Returns information for the organization myorg:

<soapenv:Body>
<findOrganizations>
<locationCentraSite>
http://localhost:53305/CentraSite/CentraSite
</locationCentraSite>
<keyword>myorg</keyword>
<locale>DE</locale>
<sortCriteria></sortCriteria>
</findOrganizations>
</soapenv:Body>

getServiceDetails and getAllServiceDetails

The getServiceDetails operation returns a detailed information about a particular service in CentraSite. You can optionally filter the list of service information by specific criteria.

The getAllServiceDetails operation, in addition, returns a list of additional properties for the service.

Input Message

Parameter Name	Description
locationCentraSite	(Optional). (String). The address of the CentraSite registry repository (CRR) from which you want to retrieve the search requests. The registry or repository runs at the following URL: http://server:port/CentraSite/CentraSite Where server is the machine on which the CRR is running and port is the port on which CentraSite is listening to requests. If you do not specify locationCentraSite, the Search service uses the following default URL: http://localhost:53307/CentraSite/CentraSite
serviceKey	(Optional). (String). (Array). The UDDI key of the service.
locale	(Optional). (String). The locale in which you want the results to be returned.

Output Message

ServiceDetail[]

Parameter Name	Description
ServiceDetail - An array of ServiceDetail elements for each of the service. The ServiceDetail message has the following details:
key	The UDDI key of the service.
name	The display name of the service.
wsdlURL	The URL of the service’s WSDL in the CentraSite repository.
lifeCycleState	The name of the current lifecycle state
owner	The user who created the service.
organizationKey	The UDDI key of the organization which owns the service.
organizationName	The organization which owns the service.
version	The user-assigned version identifier for the service.
property	service namespace - The target namespace of the service.
OperationInfo[] - An array of OperationInfo for the service.
key	The UDDI key of the service.
name	The display name of the service.
description	The description for the service.
property	input - The input message. output - The output message.

Example SOAP Request

Returns detailed information for two particular services:

<soapenv:Body>
<getServiceDetails>
<locationCentraSite></locationCentraSite>
<serviceKey>uddi:372ad925-d207-11e4-8844-ad99cc9211e8</serviceKey>
<serviceKey>uddi:65f11014-c8b8-11e4-9dd8-c736d339af26</serviceKey>
<locale></locale>
</getServiceDetails>
</soapenv:Body>

getAssociatedServices and getAllAssociatedServices

The getAssociatedServices operation returns information about services that are associated to a particular service in CentraSite. You can optionally filter the list of service information by specific criteria.

Input Message

Parameter Name	Description
locationCentraSite	(Optional). (String). The address of the CentraSite registry repository (CRR) from which you want to retrieve the search requests. The registry or repository runs at the following URL: http://server:port/CentraSite/CentraSite Where server is the machine on which the CRR is running and port is the port on which CentraSite is listening to requests. If you do not specify locationCentraSite, the Search service uses the following default URL: http://localhost:53307/CentraSite/CentraSite
assetKey	(Optional). (String). (Array). The UDDI key of the service.
associationType	(Optional). (String). The name of the association type, for example, Uses, through which the asset references a service.

Output Message

ServiceDetail[]

Parameter Name	Description
ServiceDetail - An array of ServiceDetail elements for each of the service. The ServiceDetail message has the following details:
key	The UDDI key of the service.
name	The display name of the service.
wsdlURL	The URL of the service’s WSDL in the CentraSite repository.
lifeCycleState	The name of the current lifecycle state
owner	The user who created the service.
organizationKey	The UDDI key of the organization which owns the service.
organizationName	The organization which owns the service.
version	The user-assigned version identifier for the service.
property	service namespace - The target namespace of the service.
OperationInfo[] - An array of OperationInfo for the service.
key	The UDDI key of the service.
name	The display name of the service.
description	The description for the service.
property	input - The input message. output - The output message.