OpenAPI Swagger-UI

To access online microservice OpenAPI UI, go to https://HOST/swagger-ui/index.html

• maintenance-controller
  • getretrieveTenantsInMaintenance
  • putunSetMaintenance
  • putsetMaintenance
• module-manager-controller
  • getexportConfiguration
  • postimportConfiguration
  • getisConfigurationEnabled
  • getisReady
  • getisReadyEnabled
  • getrestart
  • getisRestartEnabled
• jpa-multitenant-controller
  • getgetDataSourceStatus
  • gettestTenantConnection
• Request controller
  • postRetrieve Requests
  • delDelete Requests
  • postRetry Requests
  • getRetrieve Request
• security-resources-controller
  • getgetAllResources
• dynamic-tenant-setting-controller
  • getretrieveAll
  • delreset
  • putupdate
• manager-controller
  • postimmediateShutdown
• Worker manager
  • getRetrieve worker types

API docs by Redocly

MICROSERVICE WORKER MANAGER (2.0.0)

Download OpenAPI specification:Download

License: GPL-3.0

Worker Manager API

maintenance-controller

retrieveTenantsInMaintenance

Generated server url

/api/v1/rs-worker-manager/maintenance

Authorizations:

REGARDS_OAUTH2

Responses

unSetMaintenance

Generated server url

/api/v1/rs-worker-manager/maintenance/{tenant}/disable

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

setMaintenance

Generated server url

/api/v1/rs-worker-manager/maintenance/{tenant}/enable

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

module-manager-controller

exportConfiguration

Generated server url

/api/v1/rs-worker-manager/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Responses

importConfiguration

Generated server url

/api/v1/rs-worker-manager/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Request Body schema: multipart/form-data

file required

string <binary>

Responses

isConfigurationEnabled

Generated server url

/api/v1/rs-worker-manager/microservice/configuration/enabled

Authorizations:

REGARDS_OAUTH2

Responses

isReady

Generated server url

/api/v1/rs-worker-manager/microservice/ready

Authorizations:

REGARDS_OAUTH2

Responses

isReadyEnabled

Generated server url

/api/v1/rs-worker-manager/microservice/ready/enabled

Authorizations:

REGARDS_OAUTH2

Responses

restart

Generated server url

/api/v1/rs-worker-manager/microservice/restart

Authorizations:

REGARDS_OAUTH2

Responses

isRestartEnabled

Generated server url

/api/v1/rs-worker-manager/microservice/restart/enabled

Authorizations:

REGARDS_OAUTH2

Responses

jpa-multitenant-controller

getDataSourceStatus

Generated server url

/api/v1/rs-worker-manager/regards/{tenant}/datasource/status

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

Response samples

• 200

Content type

application/json

{

• "message": "string",
• "properties": {

  • "property1": { },
  • "property2": { }

  }

}

testTenantConnection

Generated server url

/api/v1/rs-worker-manager/regards/{tenant}/datasource/test

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

Response samples

• 200

Content type

application/json

{

• "message": "string",
• "properties": {

  • "property1": { },
  • "property2": { }

  }

}

Request controller

Retrieve Requests

Generated server url

/api/v1/rs-worker-manager/requests

Retrieve Requests matching given filters.

Authorizations:

REGARDS_OAUTH2

query Parameters

required

object (Pageable) Sorting and page configuration

Request Body schema: application/json

required

	object (ValuesRestrictionString) Filter on Content types
	object (DatesRangeRestriction) Request creation date restriction
dispatchedWorkerType	string Name of the Worker type matching the Request Content Type
	object (ValuesRestrictionLong) Filter on Request IDs
session	string Session that emitted the request
source	string Source that emitted the request
	object (ValuesRestrictionRequestStatus) Filter on Request statuses

Responses

Request samples

• Payload

Content type

application/json

{

• "contentTypes": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • "string"

    ]

  },
• "creationDate": {

  • "after": "2019-08-24T14:15:22Z",
  • "before": "2019-08-24T14:15:22Z"

  },
• "dispatchedWorkerType": "WorkerAcceptingContentType1",
• "ids": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • 0

    ]

  },
• "session": "Today_Mission1",
• "source": "CNES",
• "statuses": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • "DISPATCHED"

    ]

  }

}

Delete Requests

Generated server url

/api/v1/rs-worker-manager/requests/delete

Delete Requests matching provided filters.

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

	object (ValuesRestrictionString) Filter on Content types
	object (DatesRangeRestriction) Request creation date restriction
dispatchedWorkerType	string Name of the Worker type matching the Request Content Type
	object (ValuesRestrictionLong) Filter on Request IDs
session	string Session that emitted the request
source	string Source that emitted the request
	object (ValuesRestrictionRequestStatus) Filter on Request statuses

Responses

Request samples

• Payload

Content type

application/json

{

• "contentTypes": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • "string"

    ]

  },
• "creationDate": {

  • "after": "2019-08-24T14:15:22Z",
  • "before": "2019-08-24T14:15:22Z"

  },
• "dispatchedWorkerType": "WorkerAcceptingContentType1",
• "ids": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • 0

    ]

  },
• "session": "Today_Mission1",
• "source": "CNES",
• "statuses": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • "DISPATCHED"

    ]

  }

}

Retry Requests

Generated server url

/api/v1/rs-worker-manager/requests/retry

Retry Requests matching provided filters.

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

	object (ValuesRestrictionString) Filter on Content types
	object (DatesRangeRestriction) Request creation date restriction
dispatchedWorkerType	string Name of the Worker type matching the Request Content Type
	object (ValuesRestrictionLong) Filter on Request IDs
session	string Session that emitted the request
source	string Source that emitted the request
	object (ValuesRestrictionRequestStatus) Filter on Request statuses

Responses

Request samples

• Payload

Content type

application/json

{

• "contentTypes": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • "string"

    ]

  },
• "creationDate": {

  • "after": "2019-08-24T14:15:22Z",
  • "before": "2019-08-24T14:15:22Z"

  },
• "dispatchedWorkerType": "WorkerAcceptingContentType1",
• "ids": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • 0

    ]

  },
• "session": "Today_Mission1",
• "source": "CNES",
• "statuses": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • "DISPATCHED"

    ]

  }

}

Retrieve Request

Generated server url

/api/v1/rs-worker-manager/requests/{requestId}

Retrieve a Request by its id.

Authorizations:

REGARDS_OAUTH2

path Parameters

requestId required

string Example: 1 Request ID

Responses

security-resources-controller

getAllResources

Generated server url

/api/v1/rs-worker-manager/security/resources

Authorizations:

REGARDS_OAUTH2

Responses

Response samples

• 200

Content type

application/json

[

• {

  • "autorizedRoles": [

    • {

      • "authority": "string",
      • "authorizedIpAdresses": [

        • "string"

        ],
      • "roleName": "string"

      }

    ],
  • "controllerSimpleName": "string",
  • "fullPath": "string",
  • "method": "GET",
  • "resourceAccess": { },
  • "resourceMappingId": "string"

  }

]

dynamic-tenant-setting-controller

retrieveAll

Generated server url

/api/v1/rs-worker-manager/settings

Authorizations:

REGARDS_OAUTH2

query Parameters

names

Array of strings unique

Responses

reset

Generated server url

/api/v1/rs-worker-manager/settings/{name}

Authorizations:

REGARDS_OAUTH2

path Parameters

name required

string

Responses

update

Generated server url

/api/v1/rs-worker-manager/settings/{name}

Authorizations:

REGARDS_OAUTH2

path Parameters

name required

string

Request Body schema: application/json

required

defaultValue	object
description	string
name	string
value	object

Responses

Request samples

• Payload

Content type

application/json

{

• "defaultValue": { },
• "description": "string",
• "name": "string",
• "value": { }

}

manager-controller

immediateShutdown

Generated server url

/api/v1/rs-worker-manager/shutdown/immediate

Authorizations:

REGARDS_OAUTH2

Responses

Worker manager

Retrieve worker types

Generated server url

/api/v1/rs-worker-manager/workers

Retrieve worker types with its number of alive instances.

Authorizations:

REGARDS_OAUTH2

query Parameters

contentTypes

Array of strings Filter Workers on Request Content Types they handle

Responses