Process states of the product layer installation process (product_layer)

Requests

HTTP verb Endpoint Description

POST

/rest/v1/domain/product_layer

Creating an order to install a product layer or remove it

GET

/rest/v1/domain/product_layer

Obtaining the list of objects with information about the latest states of the product layer installation process


Creating an order to install a product layer or remove it

Request

Field Description: product_layer entity

Request example
POST /rest/v1/domain/product_layer HTTP/1.1
Content-Type: application/json; charset=utf-8

product_layer entity

Response

Field Description: product_layer entity

Response example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "operation": "install",
  "prefix": "era_product",
  "mode": "default",
  "file": "era_product_2022.6.22.zip",
  "site": "main_site",
  "dt": "2022-12-14T09:56:09Z",
  "status": "registered",
  "kind": "current",
  "order": 0
}

Obtaining the list of objects with information about the latest states of the product layer installation process

Request

Table 1. Request parameters
Name Type Description

filter

object

Filter by field values.

mask

str

List of fields to output. Available fields for output: mode, site, status, dt, file, md5, trace, kind, order.

offset

int

Offset in the list of resources to be issued.

limit

int

The maximum number of resources in the list.

order

array<object|str>

The sort order of the resources in the list.

flat

bool

Conversion to flat form of composite fields.

Request example
GET /rest/v1/domain/product_layer?offset=0&limit=1 HTTP/1.1

Response

Field Description: product_layer entity

Response example
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "dt": "2022-07-14T13:42:48Z",
    "file": "era_product_2022_12_09.zip",
    "kind": "current",
    "md5": "C9594C1C0BDF87109763F24D36557D40",
    "mode": "default",
    "order": 0,
    "site": "main_site",
    "status": "installed"
  },
  {
    "dt": "2022-07-18T16:55:51Z",
    "file": "era_product_2022_12_09.zip",
    "kind": "attempt",
    "mode": "default",
    "order": 1,
    "site": "main_site",
    "status": "identical"
  }
]

Examples of POST requests

Sample content of a request to set up a product layer:

{
  "prefix": "era_install"
}

The last product layer (lexicographically the largest archive name) with the specified prefix will be installed. It will be set in super-macro mode - one operating system process serves all the microseurices of the product layer.

This query is equivalent to the following expanded query:

{
  "operation": "install",
  "prefix": "era_install",
  "mode": "default"
}

Sample content of a request to update a product layer:

{
  "operation": "update",
  "prefix": "era_install"
}

Sample content of a request to delete a product layer:

{
  "operation": "delete"
}

Sample content of a request to delete a product layer with data cleansing:

{
  "operation": "clear"
}