Service catalog REST API

You are here:
Estimated reading time: 2 min

REST API of service catalog enables you to use service catalog data from SimplyIT.cloud and connect them with other tools.

We have at the moment six API calls which enables you use SimplyIT.cloud as master data about services and it’s dependencies.

If you haven’t read the basic information about REST API, you can find it here.

Service Components

We have one API call for getting Service Components data. Information about parameters and available options can be found in the table below.

Parameters with options for Service Components filter:
ParametersOptionsDescription
nameFree text, name of Service Componentfilter by existing Service Component name
internaltrue, falsefilter only internal or external Service Components
responsible_userFree text, name of Service Component responsible userfilter by name of existing Service Component responsible user
statusPlanned, Operated, Retiredfilter by Service Component status
component_typeApplication, Infra, EUSfilter by Service Component type

REST API: “service_components”

Description of the call:

Returns information about all Service Components in your “company” and its impacted E2E services as well dependencies to other Service Components.

Accessing data from tables:

ServiceComponent, E2eService

Example of curl:

curl -u username:password -i -H ‘Accept:application/json’ http://trial.simplyit.cloud/api/v1/service_components

Example output:

E2E Services

We have four API calls for getting E2E Services data. Information about parameters and available options can be found in the table below and these paramateres can be used for all E2E Services calls without difference.

Parameters with options for E2E Services filter:
ParametersOptionsDescription
nameFree text, name of E2E Servicefilter by existing E2E Service name
ownerFree text, name of E2E Service owner userfilter by name of existing E2E Service owner user
statusPlanned, Operated, Retiredfilter by E2E Service status
criticalityBusiness Critical, Mission Critical, Task Critical, Task Standardfilter by E2E Service criticality

REST API: “e2e_services”

Description of the call:

Returns information about all E2E Services in your “company” including all custom attributes without information about depended Service Components or Stakeholders.

Accessing data from tables:

E2eService

Example of curl:

curl -u username:password -i -H ‘Accept:application/json’ http://trial.simplyit.cloud/api/v1/e2e_services?status=Operated

Example output:

REST API: “e2e_service_components”

Description of the call:

Returns information about all E2E Services in your company including all custom attributes and depended Service Components.

Accessing data from tables:

E2eService, ServiceComponent

Example of curl:

curl -u username:password -i -H ‘Accept:application/json’ http://trial.simplyit.cloud/api/v1/e2e_service_components?status=Operated&criticality=Task%20Critical

Example output:

REST API: “e2e_stakeholders”

Description of the call:

Returns information about all E2E Services in your company including all custom attributes and depended Stakeholders.

Accessing data from tables:

E2eService, Stakeholder

Example of curl:

curl -u username:password -i -H ‘Accept:application/json’ http://trial.simplyit.cloud/api/v1/e2e_stakeholders?criticality=Business%20critical

Example output:

REST API: “e2e_service_components_stakeholders”

Description of the call:

Returns information about all E2E Services in your company including all custom attributes, depended Service Components and Stakeholders.

Accessing data from tables:

E2eService, ServiceComponent, Stakeholder

Example of curl:

curl -u username:password -i -H ‘Accept:application/json’ http://trial.simplyit.cloud/api/v1/e2e_service_components_stakeholders

Example output:

Stakeholders

We have one API call for getting Stakeholders data. Information about parameters and available options can be found in the table below.

Parameters with options for Stakeholders filter:
ParametersOptionsDescription
nameFree text, name of Stakeholderfilter by existing Stakeholder name
responsible_userFree text, name of Stakeholder responsible userfilter by name of existing Stakeholder responsible user

REST API: “stakeholders”

Description of the call:

Returns information about all Stakeholders in your company including depended E2E Services.

Accessing data from tables:

Stakeholder, E2E Service

Example of curl:

curl -u username:password -i -H ‘Accept:application/json’ http://trial.simplyit.cloud/api/v1/stakeholders?name=some%20stakeholder

Example output:
Was this article helpful?
Dislike 0
Views: 65
Start using SimplyIT today
Bring visibility into your services provided by IT, HR, maintenance or external vendors.