Service

API to interact with services

A service represents a customer-facing/user friendly set of activities. In the context of this Service Catalog, these activities are the Catalog items and Resource Actions. A Service must be owned by a specific Organization and all the activities it contains should belongs to the same Organization.

The following resources are applicable:

• /api/consumer/services
• /api/consumer/services/{id}
• /api/consumer/services/{id}/icon
• /api/services
• /api/services/{id}
• /api/services/{id}/catalogItems

/api/consumer/services

GET

Get all Active Services the current user is entitled to see. Each returned services must own at least one Catalog Item the current user is entitled to.

Permissions

Solution Provider	System Admin	Tenant Manager	User Permissions
			CATALOG_CONSUME_TENANT_MGMT CATALOG_CONSUME_SELF CATALOG_CONSUME_SUBTENANT_MGMT

Parameters

name	description	type	default
page	Page Number	query	1
limit	Number of entries per page	query	20
$orderby	Multiple comma-separated properties sorted in ascending or descending order	query
$top	Sets the number of returned entries from the top of the response (total number per page in relation to skip)	query
$skip	Sets how many entries you would like to skip	query
$filter	Boolean expression for whether a particular entry should be included in the response	query
onBehalfOf	optional query parameter providing the value of the user Id when the intention is to request on behalf of someone else.	query

Response Body

element:	Page of service
media types:

A Page of Services

/api/consumer/services/{id}

GET

Get a Service according to its unique id provided in the path.

Permissions

Solution Provider	System Admin	Tenant Manager	User Permissions
			CATALOG_CONSUME_TENANT_MGMT CATALOG_CONSUME_SELF CATALOG_CONSUME_SUBTENANT_MGMT

Parameters

name	description	type	default
id	The uuid of a Service	path

Response Body

element:	service
media types:

A Service corresponding to the unique Id.

/api/consumer/services/{id}/icon

GET

Get a Service's Icon according to its unique id provided in the path.

Permissions

Solution Provider	System Admin	Tenant Manager	User Permissions
			CATALOG_CONSUME_TENANT_MGMT CATALOG_CONSUME_SELF CATALOG_CONSUME_SUBTENANT_MGMT

Parameters

name	description	type	default
id	The UUID of a Service	path

Response Body

element:	(custom)
media types:

A Service Icon corresponding to the unique Id.

/api/services

POST

Create a new Service.

Permissions

Solution Provider	System Admin	Tenant Manager	User Permissions
			CATALOG_AUTHOR_TENANT CATALOG_AUTHOR_SUBTENANT

Request Body

element:	service
media types:

the Service to be created.

Response Body

element:	service
media types:

the updated Service and HTTP status code.

Status Codes

HTTP Status Code	Description
201 Created	Created

GET

Finds all Services that the currently logged in user has access to.

Permissions

Solution Provider	System Admin	Tenant Manager	User Permissions
			CATALOG_AUTHOR_TENANT CATALOG_AUTHOR_SUBTENANT CATALOG_ENTITLE_SUBTENANT CATALOG_ENTITLE_TENANT

Parameters

name	description	type	default
page	Page Number	query	1
limit	Number of entries per page	query	20
$orderby	Multiple comma-separated properties sorted in ascending or descending order	query
$top	Sets the number of returned entries from the top of the response (total number per page in relation to skip)	query
$skip	Sets how many entries you would like to skip	query
$filter	Boolean expression for whether a particular entry should be included in the response	query

Response Body

element:	Page of service
media types:

a Page of Services.

/api/services/{id}

GET

Retrieve an existing Service. It checks if the user is permitted to view the service.

Permissions

Solution Provider	System Admin	Tenant Manager	User Permissions
			CATALOG_AUTHOR_TENANT CATALOG_AUTHOR_SUBTENANT CATALOG_ENTITLE_SUBTENANT CATALOG_ENTITLE_TENANT

Parameters

name	description	type	default
id	the unique identifier for the Service.	path

Response Body

element:	service
media types:

The Service.

PUT

Updates an existing Service.

Permissions

Solution Provider	System Admin	Tenant Manager	User Permissions
			CATALOG_AUTHOR_TENANT CATALOG_AUTHOR_SUBTENANT

Parameters

name	description	type	default
id	- the unique identifier for the service.	path

Request Body

element:	service
media types:

- the service to be updated.

Response Body

element:	service
media types:

The updated service.

Status Codes

HTTP Status Code	Description
200 OK	OK

/api/services/{id}/catalogItems

GET

Retrieve all the catalog items belonging to a given service

Permissions

Solution Provider	System Admin	Tenant Manager	User Permissions
			CATALOG_AUTHOR_TENANT CATALOG_AUTHOR_SUBTENANT CATALOG_ENTITLE_SUBTENANT CATALOG_ENTITLE_TENANT

Parameters

name	description	type	default
id	- the unique identifier for the service.	path
page	Page Number	query	1
limit	Number of entries per page	query	20
$orderby	Multiple comma-separated properties sorted in ascending or descending order	query
$top	Sets the number of returned entries from the top of the response (total number per page in relation to skip)	query
$skip	Sets how many entries you would like to skip	query
$filter	Boolean expression for whether a particular entry should be included in the response	query

Response Body

element:	Page of catalogItem
media types:

Page of Catalog items for a given service