getICollections

Getting all collections.

IntegrationCollections?.getICollections( langCode?, userQuery? );

Minimal example

const result = await IntegrationCollections.getICollections();

Schema

langCode: string
Language code. Default: "en_US"
example: "en_US"

userQuery: object
Optional set query parameters

Get all collections.

Example response

[
  {
    "id": 1,
    "identifier": "test_collection",
    "formId": 2,
    "localizeInfos": {
      "title": "test_collection"
    },
    "attributeSetId": null,
    "selectedAttributeMarkers": null
  }
]

Schema

id: number
Object identifier.
example: 1

identifier: string | null
Text identifier for record field.
example: "collection1"

formId: number | null
Identifier for the form used by the order storage.
example: 1234

localizeInfos: ILocalizeInfo
Localized information about the collection.
example:

{
  "title": "Admins text"
}

attributeSetId: string | null
Identifier of the set of attributes used by the form attached to the collection.
example: "attributeSet1" or null if not applicable

selectedAttributeMarkers: string | null
Text identifiers of form object attributes for display in the data table.
example: "collection_marker"

---