Документация / API / Json / Компоненты / GetChildComponents

---

Получение списка дочерних компонентов для указанного компонента

Ищутся компоненты только первого уровня вложенности, то есть поиск нерекурсивный.

АдресВашегоСервисаApi/GetChildComponents

{
    "Token": {
        "SecretKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    },
    "Data": {
        "ComponentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
    }
}

Здесь:

• Token — раздел с токеном авторизации. В нём:
  • SecretKey (string) — ключ доступа к Api, посмотрите в Личном кабинете в разделе Управление — Ключи доступа к Api
• ComponentId (guid) — Уникальный Id компонента-родителя.

{
    "Data": [
        {
            "Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "ParentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
            "SystemName": "ComponentSystemName",
            "DisplayName": "ComponentDisplayName",
            "CreatedDate": "2016-04-30T23:25:43.511Z",
            "Version": "1.0.0.0"
            "Type": {
                "Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
                "SystemName": "ComponentTypeSystemName",
                "DisplayName": "ComponentTypeDisplayName",
                "IsSystem": false
            },
            "Properties": [
                {
                    "Name": "Property1",
                    "Value": "10.0",
                    "Type": "double"
                },
                ...
            ]
        },
        ...
    ],
    "Code": 10
}

Здесь:

• Data — массив информации о дочерних компонентах:
  • Id (guid) — Уникальный Id компонента.
  • ParentId (guid) — Уникальный Id компонента-родителя.
  • SystemName (string) — Системное имя компонента.
  • DisplayName (string) — Отображаемое имя компонента.
  • CreatedDate (datetime) — Дата и время создания компонента.
  • Version (string) — Версия компонента.
  • Type — Информация о типе компонента:
    • Id (guid) — Уникальный Id типа компонента.
    • SystemName (string) — Системное имя типа компонента.
    • DisplayName (string) — Отображаемое имя типа компонента.
    • IsSystem (bool) — Является ли тип компонента системным (общим для всех аккаунтов).
  • Properties (array) — Массив дополнительных свойств компонента:
    • Name (string) — Название свойства.
    • Value — Значение свойства.
    • Type (string) — Тип свойства. Может быть одним из: Boolean, DateTime, Double, Int32, Int64, Binary, String, Guid.

Если компонента-родителя с указанным Id не существует, то Code будет равен 1100, а Data будет пустым.