API docs by Redocly

Manager Applications API (v1)

Manager Applications API

applications

registerApplication

Register a new application.

query Parameters
check
boolean
Default: true

Whether to run default validation of application descriptor or not Default validation mode specified in the application properties

header Parameters
x-okapi-token
string

An OKAPI authentication token

Request Body schema: application/json
description
string

A description of application manager

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdBy
string <uuid>

ID of the user who created the record (when available)

modifiedDate
string <date-time>

Date and time when the record was last updated

modifiedBy
string <uuid>

ID of the user who last updated the record (when available)

Array of objects (module)

List of modules which are grouped by the application

Array
url
string

URL to the artifact

id
string

A Name-Version id for identifying this artifact

name
required
string

Artifact name

version
required
string (version) ^(\d+)\.(\d+)\.(\d+)(?:-([\dA-Za-z-]+(?:\.[\d...

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

Array of objects (module)

List of ui-modules which are grouped by the application

Array
url
string

URL to the artifact

id
string

A Name-Version id for identifying this artifact

name
required
string

Artifact name

version
required
string (version) ^(\d+)\.(\d+)\.(\d+)(?:-([\dA-Za-z-]+(?:\.[\d...

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

moduleDescriptors
Array of objects (moduleDescriptor)

List of module descriptors which are grouped by the application

uiModuleDescriptors
Array of objects (moduleDescriptor)

List of ui module descriptors which are grouped by the application

platform
string

information about version of a platform

Array of objects (dependency)

List of dependencies to other applications

Array
name
required
string

Artifact name

version
required
string

The concrete version of an artifact (semantic version) or the version range

optional
boolean
Default: false

Indicates whether the dependency is optional

object (Application Deployment Schema)

An information about application deployment generated by pipelines

Array of objects (module)

List of modules which are grouped by the application

Array of objects (module)

List of modules which are grouped by the application

object (Deployment)

Deployment info about application

id
string

A Name-Version id for identifying this artifact

name
required
string

Artifact name

version
required
string (version) ^(\d+)\.(\d+)\.(\d+)(?:-([\dA-Za-z-]+(?:\.[\d...

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "metadata": {
    },
  • "modules": [
    ],
  • "uiModules": [
    ],
  • "moduleDescriptors": [
    ],
  • "uiModuleDescriptors": [
    ],
  • "platform": "string",
  • "dependencies": [
    ],
  • "deployment": {
    },
  • "id": "string",
  • "name": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "metadata": {
    },
  • "modules": [
    ],
  • "uiModules": [
    ],
  • "moduleDescriptors": [
    ],
  • "uiModuleDescriptors": [
    ],
  • "platform": "string",
  • "dependencies": [
    ],
  • "deployment": {
    },
  • "id": "string",
  • "name": "string",
  • "version": "string"
}

getApplicationsByQuery

Retrieve registered application by query.

query Parameters
query
string

A CQL query string with search conditions.

offset
integer >= 0
Default: 0

Skip over a number of elements by specifying an offset value for the query.

limit
integer [ 0 .. 500 ]
Default: 10

Limit the number of elements returned in the response.

full
boolean
Default: false

Show full information in the response including ModuleDescriptors

Responses

Response samples

Content type
application/json
{
  • "applicationDescriptors": [
    ],
  • "totalRecords": 0
}

getApplicationById

Retrieve registered application by id.

path Parameters
id
required
string

Entity/document id

query Parameters
full
boolean
Default: false

Show full information in the response including ModuleDescriptors

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "metadata": {
    },
  • "modules": [
    ],
  • "uiModules": [
    ],
  • "moduleDescriptors": [
    ],
  • "uiModuleDescriptors": [
    ],
  • "platform": "string",
  • "dependencies": [
    ],
  • "deployment": {
    },
  • "id": "string",
  • "name": "string",
  • "version": "string"
}

deregisterApplicationById

De-register (delete) application by id.

path Parameters
id
required
string

Entity/document id

header Parameters
x-okapi-token
string

An OKAPI authentication token

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "total_records": 0
}

validateApplicationDescriptor

Validate application descriptor.

query Parameters
mode
string (validationMode)
Default: "default"
Enum: "default" "basic" "onCreate"

Validation mode to be applied

Request Body schema: application/json
description
string

A description of application manager

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

createdDate
required
string <date-time>

Date and time when the record was created

createdBy
string <uuid>

ID of the user who created the record (when available)

modifiedDate
string <date-time>

Date and time when the record was last updated

modifiedBy
string <uuid>

ID of the user who last updated the record (when available)

Array of objects (module)

List of modules which are grouped by the application

Array
url
string

URL to the artifact

id
string

A Name-Version id for identifying this artifact

name
required
string

Artifact name

version
required
string (version) ^(\d+)\.(\d+)\.(\d+)(?:-([\dA-Za-z-]+(?:\.[\d...

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

Array of objects (module)

List of ui-modules which are grouped by the application

Array
url
string

URL to the artifact

id
string

A Name-Version id for identifying this artifact

name
required
string

Artifact name

version
required
string (version) ^(\d+)\.(\d+)\.(\d+)(?:-([\dA-Za-z-]+(?:\.[\d...

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

moduleDescriptors
Array of objects (moduleDescriptor)

List of module descriptors which are grouped by the application

uiModuleDescriptors
Array of objects (moduleDescriptor)

List of ui module descriptors which are grouped by the application

platform
string

information about version of a platform

Array of objects (dependency)

List of dependencies to other applications

Array
name
required
string

Artifact name

version
required
string

The concrete version of an artifact (semantic version) or the version range

optional
boolean
Default: false

Indicates whether the dependency is optional

object (Application Deployment Schema)

An information about application deployment generated by pipelines

Array of objects (module)

List of modules which are grouped by the application

Array of objects (module)

List of modules which are grouped by the application

object (Deployment)

Deployment info about application

id
string

A Name-Version id for identifying this artifact

name
required
string

Artifact name

version
required
string (version) ^(\d+)\.(\d+)\.(\d+)(?:-([\dA-Za-z-]+(?:\.[\d...

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "metadata": {
    },
  • "modules": [
    ],
  • "uiModules": [
    ],
  • "moduleDescriptors": [
    ],
  • "uiModuleDescriptors": [
    ],
  • "platform": "string",
  • "dependencies": [
    ],
  • "deployment": {
    },
  • "id": "string",
  • "name": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "total_records": 0
}

validateModulesInterfaceIntegrity

Validate module interface integrity.

Request Body schema: application/json
applicationIds
required
Array of strings non-empty unique

List of application ids

Responses

Request samples

Content type
application/json
{
  • "applicationIds": [
    ]
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "total_records": 0
}

validateDescriptorsDependenciesIntegrity

Validate descriptors integrity at application and interface levels.

Request Body schema: application/json
required
Array of objects (Application Descriptor Schema)

List of application descriptors

Array
description
string

A description of application manager

object (Metadata Schema)

Metadata about creation and changes to records, provided by the server (client should not provide)

Array of objects (module)

List of modules which are grouped by the application

Array of objects (module)

List of ui-modules which are grouped by the application

moduleDescriptors
Array of objects (moduleDescriptor)

List of module descriptors which are grouped by the application

uiModuleDescriptors
Array of objects (moduleDescriptor)

List of ui module descriptors which are grouped by the application

platform
string

information about version of a platform

Array of objects (dependency)

List of dependencies to other applications

object (Application Deployment Schema)

An information about application deployment generated by pipelines

id
string

A Name-Version id for identifying this artifact

name
required
string

Artifact name

version
required
string (version) ^(\d+)\.(\d+)\.(\d+)(?:-([\dA-Za-z-]+(?:\.[\d...

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

Responses

Request samples

Content type
application/json
{
  • "applicationDescriptors": [
    ]
}

Response samples

Content type
application/json
[
  • "string"
]

application-discovery

getDiscovery

Retrieve module discovery info for application referenced by id.

path Parameters
id
required
string

Entity/document id

query Parameters
offset
integer >= 0
Default: 0

Skip over a number of elements by specifying an offset value for the query.

limit
integer [ 0 .. 500 ]
Default: 10

Limit the number of elements returned in the response.

Responses

Response samples

Content type
application/json
{
  • "discovery": [
    ],
  • "totalRecords": 0
}

module-bootstrap

getModuleBootstrap

Retrieve bootstrap information for module referenced by id

path Parameters
id
required
string

Entity/document id

Responses

Response samples

Content type
application/json
{
  • "module": {
    },
  • "requiredModules": [
    ]
}

module-discovery

searchModuleDiscovery

Retrieving module discovery information by CQL query and pagination parameters.

query Parameters
query
string

A CQL query string with search conditions.

offset
integer >= 0
Default: 0

Skip over a number of elements by specifying an offset value for the query.

limit
integer [ 0 .. 500 ]
Default: 10

Limit the number of elements returned in the response.

Responses

Response samples

Content type
application/json
{
  • "discovery": [
    ],
  • "totalRecords": 0
}

createModuleDiscoveries

Creates module discovery information in a batch

header Parameters
x-okapi-token
string

An OKAPI authentication token

Request Body schema: application/json
required
Array of objects (moduleDiscovery)

Discovery information for the modules that comprise this application

Array
location
required
string

A url address of module where its been deployed

id
string

A Name-Version id for identifying this artifact

name
required
string

Artifact name

version
required
string (version) ^(\d+)\.(\d+)\.(\d+)(?:-([\dA-Za-z-]+(?:\.[\d...

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

Responses

Request samples

Content type
application/json
{
  • "discovery": [
    ]
}

Response samples

Content type
application/json
{
  • "discovery": [
    ],
  • "totalRecords": 0
}

getModuleDiscovery

Retrieving discovery for the module referenced by id.

path Parameters
id
required
string

Entity/document id

Responses

Response samples

Content type
application/json
{
  • "location": "string",
  • "id": "string",
  • "name": "string",
  • "version": "string"
}

createModuleDiscovery

Creates a discovery for the module referenced by id.

path Parameters
id
required
string

Entity/document id

header Parameters
x-okapi-token
string

An OKAPI authentication token

Request Body schema: application/json
required
location
required
string

A url address of module where its been deployed

id
string

A Name-Version id for identifying this artifact

name
required
string

Artifact name

version
required
string (version) ^(\d+)\.(\d+)\.(\d+)(?:-([\dA-Za-z-]+(?:\.[\d...

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

Responses

Request samples

Content type
application/json
{
  • "location": "string",
  • "id": "string",
  • "name": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "location": "string",
  • "id": "string",
  • "name": "string",
  • "version": "string"
}

updateModuleDiscovery

Update discovery for the module referenced by id.

path Parameters
id
required
string

Entity/document id

header Parameters
x-okapi-token
string

An OKAPI authentication token

Request Body schema: application/json
required
location
required
string

A url address of module where its been deployed

id
string

A Name-Version id for identifying this artifact

name
required
string

Artifact name

version
required
string (version) ^(\d+)\.(\d+)\.(\d+)(?:-([\dA-Za-z-]+(?:\.[\d...

A universally unique identifier (UUID), this is a 128-bit number used to identify a record and is shown in hex with dashes, for example 6312d172-f0cf-40f6-b27d-9fa8feaf332f; the UUID version must be from 1-5; see https://dev.folio.org/guides/uuids/

Responses

Request samples

Content type
application/json
{
  • "location": "string",
  • "id": "string",
  • "name": "string",
  • "version": "string"
}

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "total_records": 0
}

deleteModuleDiscovery

Delete discovery of the module referenced by id.

path Parameters
id
required
string

Entity/document id

header Parameters
x-okapi-token
string

An OKAPI authentication token

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "total_records": 0
}