Registers A new service To the component registry.
Only available to solution users.
Request
URI
POST
https://{api_host}/component-registry/services
COPY
Request Body
the service to register
ServiceInfo
of type(s)
application/json
Required
{
"serviceVersion": "string",
"serviceType": {
"productId": "string",
"serviceTypeId": "string",
"typeId": "string",
"serviceName": "string"
},
"lastUpdated": "string",
"nameMsgKey": "string",
"createdDate": "string",
"name": "string",
"serviceAttributes": [
{
"id": "string",
"value": "string",
"key": "string"
}
],
"id": "string",
"ownerId": "string",
"endPoints": [
{
"lastUpdated": "string",
"endPointType": {
"protocol": "string",
"typeId": "string"
},
"serviceInfoId": "string",
"createdDate": "string",
"endPointAttributes": [
{
"id": "string",
"value": "string",
"key": "string"
}
],
"id": "string",
"sslTrusts": [
"string"
],
"url": "string"
}
]
}
string
serviceVersion
Optional
The service version. For example, "1.0.0".
string As date-time
As date-time
lastUpdated
Optional
The last updated date.
string
nameMsgKey
Optional
The service name message key used for localization
string As date-time
As date-time
createdDate
Optional
The created date.
string
name
Optional
The name of the service. NOTE: Services of the same serviceType should have same name.
array of
Attribute
serviceAttributes
Optional
Service specific attributes to be advertised to service consumers (optional).
string As uuid
As uuid
id
Optional
The id.
string
ownerId
Optional
The solution username of the SSO principal owning the service.
Responses
200
successful operation
Returns
ServiceInfo
of type(s)
*/*
{
"serviceVersion": "string",
"serviceType": {
"productId": "string",
"serviceTypeId": "string",
"typeId": "string",
"serviceName": "string"
},
"lastUpdated": "string",
"nameMsgKey": "string",
"createdDate": "string",
"name": "string",
"serviceAttributes": [
{
"id": "string",
"value": "string",
"key": "string"
}
],
"id": "string",
"ownerId": "string",
"endPoints": [
{
"lastUpdated": "string",
"endPointType": {
"protocol": "string",
"typeId": "string"
},
"serviceInfoId": "string",
"createdDate": "string",
"endPointAttributes": [
{
"id": "string",
"value": "string",
"key": "string"
}
],
"id": "string",
"sslTrusts": [
"string"
],
"url": "string"
}
]
}
string
serviceVersion
Optional
The service version. For example, "1.0.0".
string As date-time
As date-time
lastUpdated
Optional
The last updated date.
string
nameMsgKey
Optional
The service name message key used for localization
string As date-time
As date-time
createdDate
Optional
The created date.
string
name
Optional
The name of the service. NOTE: Services of the same serviceType should have same name.
array of
Attribute
serviceAttributes
Optional
Service specific attributes to be advertised to service consumers (optional).
string As uuid
As uuid
id
Optional
The id.
string
ownerId
Optional
The solution username of the SSO principal owning the service.
201
Operation doesn't return any data structure
Component Registry Operations
POST
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.
POST
Create Or update A service.
POST
Create Endpoint Type Extension
POST
Create Endpoint Type Spec
GET
Creates A new ModelAndView object with 'docs/odata'view name and sets the base bath To /services
DELETE
DELETE calls are not allowed
DELETE
DELETE Method not allowed
DELETE
Delete Endpoint
DELETE
Delete Endpoint Type Extension
DELETE
Delete Endpoint Type Spec
DELETE
Deletes the endpoint associated with the provided service Id and endpointTypeId.
GET
Get all serviceStatuses for services with registered status type endpoints.
GET
GET Method not allowed
GET
Get the config.js needed for API Explorer
GET
Get Endpoint Type Extension
GET
Get Endpoint Type Spec
GET
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.
GET
Gets A new ModelAndView object with 'docs/auth' view name and sets the base bath To /services
GET
Gets all distinct endpoint types
GET
Gets all distinct endpoint types associated with endpoints with services that match the provided serviceTypeId.
GET
Gets all distinct service types In the system.
GET
Gets all documentation endpoints
GET
Gets all endpoint instances for A given service instance.
GET
Gets all endpoint instances that implement the provided endpointTypeId
GET
Gets all endpoints
GET
Gets all endpoints associated with services that match the provided serviceTypeId AND that match the provided endpointTypeId.
GET
Gets all endpoints associated with services that match the provided serviceTypeId.
GET
Gets all registered services
GET
Gets all services associated with the provided serviceTypeId.
GET
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
GET
Gets the 'default' endpoint instance that implements the provided endpointTypeId
GET
Gets the default endpoint associated with the identity service's token endpoint (used To create Bearer tokens).
GET
Gets the default endpoint associated with the SSO server endpoint type.
GET
Gets the default service associated with the provided serviceTypeId
GET
Gets the endpoint identified By Id
GET
Gets the endpoint instance that implements endpointTypeId for A given service instance.
GET
Gets the LoggerEntity Of the given category for provided serviceTypeId
GET
Gets the service identified By id.
GET
Gets the serviceStatus for the specified serviceId.
DELETE
Handler for DELETE HTTP operations
POST
Handler for POST HTTP operations
PUT
Handler for PUT HTTP operations
GET
List Endpoint Type Extension
GET
List Endpoint Type Spec
POST
POST calls are not allowed
POST
POST Method not allowed
PUT
PUT calls are not allowed
POST
Registers A new service To the component registry.
DELETE
Removes (i.e.: deregisters) the service matching the provided id.
PUT
Sets the given level To category To all services with endpoint
PUT
Sets the given severity level To category for the provided serviceTypeId
GET
Similar To /services/status, this API gets all serviceStatuses for services with registered status type endpoints.
POST
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.
PUT
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.
POST
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
PUT
Update Or create A service.
PUT
Update Endpoint
PUT
Update Endpoint Type Extension
PUT
Update Endpoint Type Spec
POST
Updates Or creates An endpoint associated with the provided service Id and endpointTypeId.