JobsManagementServiceImpl

string

Идентификатор Spring bean, который содержит вызываемый сервис.jobsManagementServiceImpl

string

по умолчанию:"PROTOTYPE"

Область действия bean. Для вызовов сервисов используется PROTOTYPE.

string

Имя публичного метода сервиса, указанное в сигнатуре ниже.

object[]

Массив аргументов метода. Каждый аргумент передаётся объектом с индексом 0, 1 и т. д.; значение должно соответствовать Java-типу параметра.

Headers

POST /api/v1/bean/request
Content-Type: application/json
Lang-Context: ru
Site-Context: my-site
Authorization: Bearer <token>

Заголовки Lang-Context и Site-Context необходимо передавать в каждом запросе. Для защищённых методов передавайте JWT в заголовке Authorization в формате Bearer <token>. Доступ: ADMIN. Bearer Token: требуется.

GUEST — без логина; доступен только whitelist.
USER — требуется авторизация; доступны методы с проверкой USER.
ADMIN — полный доступ к public-методам всех сервисов.
Если метод проверяет роль внутри логики, GUEST может получить null.

Методы

JobRepository

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

getRepository

{
  "beanId": "jobsManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getRepository",
  "args": []
}

void

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

init

{
  "beanId": "jobsManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "init",
  "args": []
}

SearchResponse

Аргумент	Тип	Описание
`requestMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

searchJobs

Пример JSON объекта запроса:

{
    "type":  "SellerSKU",
    "searchTerm":  "",
    "query":  {
                  "isPublishedForSale":  true
              },
    "ignoreRegexWrap":  [
                            "id",
                            "name",
                            "embeddedSku",
                            "productsRef",
                            "isPublishedForSale"
                        ],
    "offset":  0,
    "limit":  10,
    "visiblePages":  10,
    "page":  1,
    "sortName":  "createdDate",
    "sortDirection":  "DESC"
}

Request:

{
  "beanId": "jobsManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchJobs",
  "args": [
    {
      "0": null
    }
  ]
}

Job

Аргумент	Тип	Описание
`jobAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

createJob

Пример JSON объекта запроса:

{
    "id":  null,
    "status":  null,
    "type":  null,
    "description":  null,
    "current":  0,
    "total":  0,
    "progress":  0
}

Request:

{
  "beanId": "jobsManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createJob",
  "args": [
    {
      "0": null
    }
  ]
}

Job

Аргумент	Тип	Описание
`jobAsMap`	`LinkedHashMap<String, Object>`	Передаётся через `args[0].0`.

saveJob

Пример JSON объекта запроса:

{
    "id":  null,
    "status":  null,
    "type":  null,
    "description":  null,
    "current":  0,
    "total":  0,
    "progress":  0
}

Request:

{
  "beanId": "jobsManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "saveJob",
  "args": [
    {
      "0": null
    }
  ]
}

Job

Аргумент	Тип	Описание
`type`	`String`	Передаётся через `args[0].0`.
`total`	`int`	Передаётся через `args[1].1`.

startJob

{
  "beanId": "jobsManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "startJob",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

Аргумент	Тип	Описание
`jobId`	`String`	Передаётся через `args[0].0`.

cancelJob

{
  "beanId": "jobsManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "cancelJob",
  "args": [
    {
      "0": null
    }
  ]
}

Job

Аргумент	Тип	Описание
`jobId`	`String`	Передаётся через `args[0].0`.

toCanceled

{
  "beanId": "jobsManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "toCanceled",
  "args": [
    {
      "0": null
    }
  ]
}

Job

Аргумент	Тип	Описание
`jobId`	`String`	Передаётся через `args[0].0`.

toDone

{
  "beanId": "jobsManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "toDone",
  "args": [
    {
      "0": null
    }
  ]
}

Job

Аргумент	Тип	Описание
`jobId`	`String`	Передаётся через `args[0].0`.
`progress`	`int`	Передаётся через `args[1].1`.

updateProgress

{
  "beanId": "jobsManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "updateProgress",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Job

Аргумент	Тип	Описание
`jobId`	`String`	Передаётся через `args[0].0`.
`step`	`int`	Передаётся через `args[1].1`.

incrementJob

{
  "beanId": "jobsManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "incrementJob",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Job

Аргумент	Тип	Описание
`jobId`	`String`	Передаётся через `args[0].0`.
`step`	`int`	Передаётся через `args[1].1`.

decrementJob

{
  "beanId": "jobsManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "decrementJob",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Job

Аргумент	Тип	Описание
`jobId`	`String`	Передаётся через `args[0].0`.

toFailed

{
  "beanId": "jobsManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "toFailed",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
—	—	Метод не принимает аргументы.

setUnfinishedJobsToFailed

{
  "beanId": "jobsManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "setUnfinishedJobsToFailed",
  "args": []
}

void

Аргумент	Тип	Описание
`jobsIds`	`ArrayList<String>`	Передаётся через `args[0].0`.

removeJobsByIds

{
  "beanId": "jobsManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeJobsByIds",
  "args": [
    {
      "0": null
    }
  ]
}

void

Аргумент	Тип	Описание
`jobId`	`String`	Передаётся через `args[0].0`.

removeJobAndClean

{
  "beanId": "jobsManagementServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeJobAndClean",
  "args": [
    {
      "0": null
    }
  ]
}

Клиенты для интеграции

Клиенты

Сервисы

REST API

Headers

Методы

getRepository

init

searchJobs

createJob

saveJob

startJob

cancelJob

toCanceled

toDone

updateProgress

incrementJob

decrementJob

toFailed

setUnfinishedJobsToFailed

removeJobsByIds

removeJobAndClean

​Headers

​Методы

​getRepository

​init

​searchJobs

​createJob

​saveJob

​startJob

​cancelJob

​toCanceled

​toDone

​updateProgress

​incrementJob

​decrementJob

​toFailed

​setUnfinishedJobsToFailed

​removeJobsByIds

​removeJobAndClean

Headers

Методы

getRepository

init

searchJobs

createJob

saveJob

startJob

cancelJob

toCanceled

toDone

updateProgress

incrementJob

decrementJob

toFailed

setUnfinishedJobsToFailed

removeJobsByIds

removeJobAndClean