Component Registry APIs

Component Registry APIs

Operations

API To generate A resolved link which points To A specific UI page and takes into account anyrequired parameters for the UI view page To render properly. The best way To see how To usethis API Is By looking At A real-world example.

API to generate a resolved link which points to a specific UI page and takes into account anyrequired parameters for the UI view page to render properly. The best way to see how to usethis API is by looking at a real-world example.

Create Or update A service.

Create or update a service.

Create Endpoint Type Extension

Creates a new EndPointTypeExtension resource or updates an already existing one. The id of the EndPointTypeExtension must be provided by the client and have to be unique within the system. The recommended format is namespace notation (ex: id="com.company.type....).

Create Endpoint Type Spec

Creates a new EndPointTypeSpec resource or updates an already existing one.

Creates A new ModelAndView object with 'docs/odata'view name and sets the base bath To /services

Creates a new ModelAndView object with 'docs/odata'view name and sets the base bath to /services

DELETE calls are not allowed

DELETE calls are not allowed

DELETE Method not allowed

DELETE Method not allowed

Delete Endpoint

the endpoint containing the desired updates the id

Delete Endpoint Type Extension

Deletes a EndPointTypeExtension resource by ID. No action will be performed if such a resource does not exist and a successful completion will be reported. Only the initial owner of the EndPointTypeExtension resource can delete it. HTTP Status 403 - Forbidden will be returned if other user tries to update a EndPointTypeExtension resource.

Delete Endpoint Type Spec

Deletes a EndPointTypeSpec resource by typeId. No action will be performed if such a resource does not exist and a successful completion will be reported.

Deletes the endpoint associated with the provided service Id and endpointTypeId.

Deletes the endpoint associated with the provided service id and endpointTypeId.

Get all serviceStatuses for services with registered status type endpoints.

Get all serviceStatuses for services with registered status type endpoints.

GET Method not allowed

GET Method not allowed

Get the config.js needed for API Explorer

Get the config.js needed for API Explorer

Get Endpoint Type Extension

Gets the EndPointTypeExtension resource by ID.

Get Endpoint Type Spec

Gets the EndPointTypeSpec resource by typeId.

Gets A new Form resource By endpointTypeId. The form provided will Be A composition Of all forms registered via An EndPointTypeExtension instance and the base Form generated based On the EndPointTypeSpec.

Gets a new Form resource by endpointTypeId. The form provided will be a composition of all forms registered via an EndPointTypeExtension instance and the base Form generated based on the EndPointTypeSpec.

Gets A new ModelAndView object with 'docs/auth' view name and sets the base bath To /services

Gets a new ModelAndView object with 'docs/auth' view name and sets the base bath to /services

Gets all distinct endpoint types

Gets all distinct endpoint types

Gets all distinct endpoint types associated with endpoints with services that match the provided serviceTypeId.

Gets all distinct endpoint types associated with endpoints with services that match the provided serviceTypeId.

Gets all distinct service types In the system.

Gets all distinct service types in the system.

Gets all documentation endpoints

Gets all documentation endpoints

Gets all endpoint instances for A given service instance.

Gets all endpoint instances for a given service instance.

Gets all endpoint instances that implement the provided endpointTypeId

Gets all endpoint instances that implement the provided endpointTypeId

Gets all endpoints

Gets all endpoints

Gets all endpoints associated with services that match the provided serviceTypeId AND that match the provided endpointTypeId.

Gets all endpoints associated with services that match the provided serviceTypeId AND that match the provided endpointTypeId.

Gets all endpoints associated with services that match the provided serviceTypeId.

Gets all endpoints associated with services that match the provided serviceTypeId.

Gets all registered services

Gets all registered services

Gets all services associated with the provided serviceTypeId.

Gets all services associated with the provided serviceTypeId.

Gets An edit Form resource By endpointId. The form provided will Be A composition Of all forms registered via An EndPointTypeExtension instance and the base Form generated based On the EndPointTypeSpec

Gets an edit Form resource by endpointId. The form provided will be a composition of all forms registered via an EndPointTypeExtension instance and the base Form generated based on the EndPointTypeSpec

Gets the 'default' endpoint instance that implements the provided endpointTypeId

Gets the 'default' endpoint instance that implements the provided endpointTypeId. The 'default' endpoint is the most recently updated endpoint associated to an available service instance. If no endpoints exist with an available service, then the most recently updated endpoint is returned.

Gets the default endpoint associated with the identity service's token endpoint (used To create Bearer tokens).

Gets the default endpoint associated with the identity service's token endpoint (used to create Bearer tokens).

Gets the default endpoint associated with the SSO server endpoint type.

Gets the default endpoint associated with the SSO server endpoint type.

Gets the default service associated with the provided serviceTypeId

Gets the default service associated with the provided serviceTypeId. The 'default' service is the service instance that was most recently updated and is available. If there are no available services matching serviceTypeId, then it returns the service most recently updated

Gets the endpoint identified By Id

Gets the endpoint identified by id

Gets the endpoint instance that implements endpointTypeId for A given service instance.

Gets the endpoint instance that implements endpointTypeId for a given service instance.

Gets the LoggerEntity Of the given category for provided serviceTypeId

Gets the LoggerEntity of the given category for provided serviceTypeId

Gets the service identified By id.

Gets the service identified by id.

Gets the serviceStatus for the specified serviceId.

Gets the serviceStatus for the specified serviceId.

Handler for DELETE HTTP operations

Handler for DELETE HTTP operations

Handler for POST HTTP operations

Handler for POST HTTP operations

Handler for PUT HTTP operations

Handler for PUT HTTP operations

List Endpoint Type Extension

Retrieves all or filtered by a criteria EndPointTypeExtension resources in the system.

List Endpoint Type Spec

the id of the EndPointTypeSpec

POST calls are not allowed

POST calls are not allowed

POST Method not allowed

POST Method not allowed

PUT calls are not allowed

PUT calls are not allowed

Registers A new service To the component registry.

Registers a new service to the component registry.

Removes (i.e.: deregisters) the service matching the provided id.

Removes (i.e.: deregisters) the service matching the provided id.

Sets the given level To category To all services with endpoint

Sets the given level to category to all services with endpoint

Sets the given severity level To category for the provided serviceTypeId

Sets the given severity level to category for the provided serviceTypeId

Similar To /services/status, this API gets all serviceStatuses for services with registered status type endpoints.

Similar to /services/status, this API gets all serviceStatuses for services with registered status type endpoints.

Submits A new EndPointFormData resource By endpointTypeId. The values In the form submitted will Be used To create A new EndPoint Of the provided enpointTypeId.

Submits a new EndPointFormData resource by endpointTypeId. The values in the form submitted will be used to create a new EndPoint of the provided enpointTypeId.

Submits An updated version Of An EndPoint through the EndPointFormData resource. The values In the form submitted will Be used To update An existing EndPoint with the provided endpointId As part Of the URL parameters.

Submits an updated version of an EndPoint through the EndPointFormData resource. The values in the form submitted will be used to update an existing EndPoint with the provided endpointId as part of the URL parameters.

This Is A convenience method which creates A new solution user, registers It with the SSO server, and then registers the provided service As new solution user In A single call

This is a convenience method which creates a new solution user, registers it with the SSO server, and then registers the provided service as new solution user in a single call. The serviceRegistration object passed into this method is used as a holder for solutionInfo and serviceInfo objects: 1.) solutionInfo contains info on the new solution user. 2.)serviceInfo contains info on the new service to register (created by the newly created solution user)

Update Or create A service.

Update or create a service.

Update Endpoint

This method updates the endpoint identified by the id

Update Endpoint Type Extension

Creates a new EndPointTypeExtension resource or updates an already existing one. The id of the EndPointTypeExtension must be provided by the client and have to be unique within the system. The recommended format is namespace notation (ex: id="com.company.type....).

Update Endpoint Type Spec

Updates an already existing EndPointTypeSpec resource.

Updates Or creates An endpoint associated with the provided service Id and endpointTypeId.

Updates or creates an endpoint associated with the provided service id and endpointTypeId.