CategoryServiceImpl

string

Die Spring-Bean-ID des aufzurufenden Services.categoryServiceImpl

string

Standard:"PROTOTYPE"

Bean-Scope. Für Serviceaufrufe wird PROTOTYPE verwendet.

string

Der öffentliche Methodenname des Services, der in der Signatur angegeben ist.

object[]

Das Argument-Array der Methode. Jedes Argument wird mit dem Index 0, 1 usw. übergeben; der Wert muss dem Java-Parametertyp entsprechen.

Headers

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

Senden Sie Lang-Context und Site-Context mit jeder Anfrage. Für geschützte Methoden senden Sie das JWT im Header Authorization im Format Bearer <token>. Zugriff: ADMIN. Bearer Token: bedingt für USER/ADMIN.

GUEST — nicht angemeldete Benutzer; nur Whitelist-Services sind verfügbar.
USER — Authentifizierung erforderlich; Methoden mit USER-Prüfung sind verfügbar.
ADMIN — vollständiger Zugriff auf öffentliche Methoden aller Services.
Wenn eine Methode intern eine Rolle prüft, kann GUEST null erhalten.

Methoden

CategoryRepository

Argument	Typ	Beschreibung
—	—	Diese Methode akzeptiert keine Argumente.

getRepository

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

Deque<Map<String, Object>>

Argument	Typ	Beschreibung
`requestJson`	`String`	Übergeben über `args[0].0`.

getPaginationFilter

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "getPaginationFilter",
  "args": [
    {
      "0": null
    }
  ]
}

SearchResponse

Argument	Typ	Beschreibung
`requestJson`	`LinkedHashMap<String, Object>`	Übergeben über `args[0].0`.

searchCategories

Beispiel für das JSON-Anfrageobjekt:

{
    "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": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchCategories",
  "args": [
    {
      "0": null
    }
  ]
}

SearchResponse

Argument	Typ	Beschreibung
`requestJson`	`LinkedHashMap<String, Object>`	Übergeben über `args[0].0`.

searchCategoriesLightweight

Beispiel für das JSON-Anfrageobjekt:

{
    "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": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchCategoriesLightweight",
  "args": [
    {
      "0": null
    }
  ]
}

LinkedHashSet<CategoryDTO>

Argument	Typ	Beschreibung
`requestJson`	`String`	Übergeben über `args[0].0`.

searchCategories

Beispiel für das JSON-Anfrageobjekt:

{
    "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": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchCategories",
  "args": [
    {
      "0": null
    }
  ]
}

Page<Category>

Argument	Typ	Beschreibung
`requestJson`	`String`	Übergeben über `args[0].0`.

searchCategoriesPaged

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchCategoriesPaged",
  "args": [
    {
      "0": null
    }
  ]
}

List<Category>

Argument	Typ	Beschreibung
`query`	`String`	Übergeben über `args[0].0`.
`from`	`String`	Übergeben über `args[1].1`.
`to`	`String`	Übergeben über `args[2].2`.

searchCategories

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "searchCategories",
  "args": [
    {
      "0": null,
      "1": null,
      "2": null
    }
  ]
}

Optional<Category>

Argument	Typ	Beschreibung
`categoryAsMap`	`LinkedHashMap<String, Object>`	Übergeben über `args[0].0`.

createCategory

Beispiel für das JSON-Anfrageobjekt:

{
    "id":  null,
    "name":  null,
    "parentId":  null,
    "description":  null,
    "active":  false,
    "keywords":  null,
    "searchTerms":  null,
    "translations":  null,
    "productsOfCategory":  null,
    "children":  null,
    "imageURLs":  null
}

Request:

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "createCategory",
  "args": [
    {
      "0": null
    }
  ]
}

addChildCategory

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "addChildCategory",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

Argument	Typ	Beschreibung
`parentId`	`String`	Übergeben über `args[0].0`.
`childId`	`String`	Übergeben über `args[1].1`.

removeChildCategory

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeChildCategory",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

updateCategory

Beispiel für das JSON-Anfrageobjekt:

{
    "id":  null,
    "name":  null,
    "parentId":  null,
    "description":  null,
    "active":  false,
    "keywords":  null,
    "searchTerms":  null,
    "translations":  null,
    "productsOfCategory":  null,
    "children":  null,
    "imageURLs":  null
}

Request:

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "updateCategory",
  "args": [
    {
      "0": null
    }
  ]
}

void

Argument	Typ	Beschreibung
`categoryId`	`String`	Übergeben über `args[0].0`.
`translationId`	`String`	Übergeben über `args[1].1`.

removeCategoryFromTranslation

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeCategoryFromTranslation",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

void

Argument	Typ	Beschreibung
`itemId`	`String`	Übergeben über `args[0].0`.

removeCategoryWithDescendants

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeCategoryWithDescendants",
  "args": [
    {
      "0": null
    }
  ]
}

void

Argument	Typ	Beschreibung
`categoriesIds`	`ArrayList<String>`	Übergeben über `args[0].0`.

removeCategoriesByIds

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "removeCategoriesByIds",
  "args": [
    {
      "0": null
    }
  ]
}

List<String>

Argument	Typ	Beschreibung
`categoryId`	`String`	Übergeben über `args[0].0`.
`result`	`List<String>`	Übergeben über `args[1].1`.

lookupToParents

{
  "beanId": "categoryServiceImpl",
  "scope": "PROTOTYPE",
  "functionName": "lookupToParents",
  "args": [
    {
      "0": null,
      "1": null
    }
  ]
}

Client-Integration

Clients

Services

REST API

Headers

Methoden

getRepository

getPaginationFilter

searchCategories

searchCategoriesLightweight

searchCategories

searchCategoriesPaged

searchCategories

createCategory

addChildCategory

removeChildCategory

updateCategory

removeCategoryFromTranslation

removeCategoryWithDescendants

removeCategoriesByIds

lookupToParents

​Headers

​Methoden

​getRepository

​getPaginationFilter

​searchCategories

​searchCategoriesLightweight

​searchCategories

​searchCategoriesPaged

​searchCategories

​createCategory

​addChildCategory

​removeChildCategory

​updateCategory

​removeCategoryFromTranslation

​removeCategoryWithDescendants

​removeCategoriesByIds

​lookupToParents

Headers

Methoden

getRepository

getPaginationFilter

searchCategories

searchCategoriesLightweight

searchCategories

searchCategoriesPaged

searchCategories

createCategory

addChildCategory

removeChildCategory

updateCategory

removeCategoryFromTranslation

removeCategoryWithDescendants

removeCategoriesByIds

lookupToParents