Документация / API / Json / Типы компонентов / GetComponentType

---

Получение типа компонента по системному имени или по Id

Если в запросе указано системное имя, то выполняется поиск по системному имени.
Иначе выполняется поиск по Id.

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

{
    "Token": {
        "SecretKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    },
    "Data": {
        "SystemName": "ComponentTypeSystemName",
        "Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    }
}

Здесь:

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

{
    "Data": {
        "Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "SystemName": "ComponentTypeSystemName",
        "DisplayName": "ComponentTypeDisplayName",
        "IsSystem": false
    },
    "Code": 10
}

Здесь:

• Id (guid) — Уникальный Id типа компонента.
• SystemName (string) — Системное имя типа компонента.
• DisplayName (string) — Отображаемое имя типа компонента.
• IsSystem (bool) — Является ли тип компонента системным (общим для всех аккаунтов).

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

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