Services (API) | Connectware Documentation

validate a commissioning file

POST/api/validate/service

Authorization

Body

validate a commissioning file

commissioningFile*string

The commissioning file of this service as base64 encoded content of a buffer

Response

Validation Successful

Request

const response = await fetch('/api/validate/service', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "commissioningFile": "text"
    }),
});
const data = await response.json();

Response

[
  {
    "message": "text"
  }
]

Create a new service

POST/api/services

Authorization

Body

Service to be created

id*string

commissioningFile*string

The commissioning file of this service as base64 encoded content of a buffer

parametersobject

The parameter values of this service as a JSON object

marketplaceobject

targetStateenum

disabledenabled

Response

Created service

Body

idstring

Unique identifier representing a specific service.

targetStatestring

Target state of the service (user's wish).

currentStatestring

Current state of the service.

Request

const response = await fetch('/api/services', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": "text",
      "commissioningFile": "text"
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "targetState": "text",
  "currentState": "text"
}

Read all services

GET/api/services

Authorization

Response

Array of services

Body

idstring

commissioningDataobject

resourcesobject

targetStatestring

currentStatestring

Request

const response = await fetch('/api/services', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "targetState": "text",
    "currentState": "text"
  }
]

Get the service schemas

POST/api/services/parametersSchema

Authorization

Body

Get the service parameters schemas

commissioningFile*string

The commissioning file of this service as base64 encoded content of a buffer

Response

Service schemas

Body

object

Request

const response = await fetch('/api/services/parametersSchema', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "commissioningFile": "text"
    }),
});
const data = await response.json();

Response

[
  {
    "message": "text"
  }
]

Get status of all services

GET/api/services/status

Authorization

Response

Map of service statuses

Body

object

Request

const response = await fetch('/api/services/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get information of all services

GET/api/services/info

Authorization

Response

Map of service information

Body

object

Request

const response = await fetch('/api/services/info', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get the instance names of the services

GET/api/services/instances

Authorization

Response

Map of service information

Body

itemsstring

Request

const response = await fetch('/api/services/instances', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  "text"
]

Get a specific service

GET/api/services/{id}

Authorization

Path parameters

id*string

Id of service

Response

Service

Body

idstring

commissioningDataobject

resourcesobject

targetStatestring

currentStatestring

Request

const response = await fetch('/api/services/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "targetState": "text",
  "currentState": "text"
}

Update an existing service

PUT/api/services/{id}

Authorization

Path parameters

id*string

Id of service

Body

Data required for updating a service

parametersobject

commissioningFilestring

marketplaceobject

Response

Accepted

Request

const response = await fetch('/api/services/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

[
  {
    "message": "text"
  }
]

Delete an existing service

DELETE/api/services/{id}

Authorization

Path parameters

id*string

Id of service

Response

Body

idstring

The id of the deleted service

Request

const response = await fetch('/api/services/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text"
}

Get a specific service status

GET/api/services/{id}/status

Authorization

Path parameters

id*string

Id of service

Response

Service

Body

idstring

Unique identifier representing a specific service.

targetStatestring

Target state of the service (user's wish).

currentStatestring

Current state of the service.

Request

const response = await fetch('/api/services/{id}/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": "text",
  "targetState": "text",
  "currentState": "text"
}

Get the service dependencies

GET/api/services/{id}/dependencies

Authorization

Path parameters

id*string

Id of service

Response

Service dependencies

Body

dependentarray of string

Ids of dependent cross reference services

dependsOnarray of string

Ids of depends on cross reference services

Request

const response = await fetch('/api/services/{id}/dependencies', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "dependent": [
    "text"
  ],
  "dependsOn": [
    "text"
  ]
}

Get all ingress routes

GET/api/services/ingress-routes

Authorization

Response

Ingress routes

Body

idstring

containerHoststring

containerPortinteger

containerPrefixRewritestring

ingressPortinteger

ingressUrlPrefixstring

typestring

headersarray of string

Request

const response = await fetch('/api/services/ingress-routes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "containerHost": "text",
    "containerPort": 0,
    "containerPrefixRewrite": "text",
    "ingressPort": 0,
    "ingressUrlPrefix": "text",
    "type": "text",
    "headers": [
      "text"
    ]
  }
]

Get all Cybus::Link routes

GET/api/services/links

Authorization

Response

Links

Body

idstring

ingressRoutestring

namestring

hrefstring

Request

const response = await fetch('/api/services/links', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "ingressRoute": "text",
    "name": "text",
    "href": "text"
  }
]

Get all links by all services

GET/api/services/all-links

Authorization

Response

Links

Body

idstring

namestring

linksarray of object

Request

const response = await fetch('/api/services/all-links', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "name": "text",
    "links": [
      {
        "name": "text",
        "href": "text"
      }
    ]
  }
]

Perform an operation on a service

PUT/api/services/{id}/operation

Authorization

Path parameters

id*string

Id of service

Body

Operation to perform

operationstring

Disable and enable

Response

Service

Body

idstring

Unique identifier representing a specific service.

targetStatestring

Target state of the service (user's wish).

currentStatestring

Current state of the service.

Request

const response = await fetch('/api/services/{id}/operation', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "id": "text",
  "targetState": "text",
  "currentState": "text"
}

Get all of the resource schemas

GET/api/resources/schemas

Authorization

Response

Resource schemas in a JSON string

Body

Other propertiesany

Request

const response = await fetch('/api/resources/schemas', {
    method: 'GET',
    headers: {},
});
const data = await response.json();