Skip to main content

Getting Selected Services

Getting Selected Services

Instead of getting all the services from the registry or getting a single service by ID, you can select a subset of services. You can specify any one the following selection criteria:

  • Protocol—selects any service that has a protocol in the list. Protocols can be any of the following: File, FTP, HL7, HTTP, REST, SOAP, SQL, X12, and any custom value.

  • Stage—selects any service that has a stage that is specified in the list. Stages can be any of the following: Concept, Development, Test, Staging, Live, Deprecated, and Defunct.

  • Version—selects any service that has the specified version.

  • Text search—selects any service that contains the specified text in any of the following fields: Name, Domain, Description, Endpoint, and Topics. The text comparison is not case-sensitive.

  • Modification date—selects any service whose entry has been modified after the specified date.

The Get Services By Protocols call selects the services that have a protocol that matches one of the ones in the list. The URL syntax for this call is:

GET /services/protocols/protocol-list

The following call returns all services with the REST protocol:

https://esb.example.com/registry/services/protocols/REST

The following call returns all services with either the REST or SOAP protocol:

https://esb.example.com/registry/services/protocols/REST,SOAP

The Get Services By Stages call selects the services that have a stage that matches one of the stages in the list. The URL syntax for this call is:

GET /services/stages/stage-list

The following call returns all services with the Live stage:

https://esb.example.com/registry/services/stages/Live

The Get Services By Version call selects the services that have a version that matches the specified version. The URL syntax for this call is:

GET /services/version/version

For example, the following call returns all services with version 1.0:

https://esb.example.com/registry/services/version/1.0

The Get Services By Word call finds all services that contain the specified search text in any of the following fields:

  • Name

  • Domain

  • Description

  • Endpoint

  • Topics

The URL syntax for the Get Services By Word call is:

GET /services/includesword/search-text

For example, the following call returns all services that have the text string “accounts, payable” in one of the fields:

https://esb.example.com/registry/services/includesword/accounts,%20payable

The Get Services Since Modified call returns all services whose registry entry has been modified after the specific date-time. The URL syntax for this call is:

GET /services/modifiedsince/date-time

For example, the following call returns all services whose entries were modified after the specific date-time:

https://esb.example.com/registry/services/modifiedsince/2015-02-1%2011:30

The date is specified as year-month-day, the URL space code %20 as a separator, and hours:minutes using a 24 hour clock.

FeedbackOpens in a new tab