Zidium

Получение типа компонента по системному имени, при необходимости создание типа

Это основной рекомендуемый метод получения конкретного типа компонента.
Метод ищет тип компонента с указанным системным именем.
Если тип компонента не найден, он будет создан.
Таким образом, достигается уникальность системного имени типа компонента в рамках аккаунта.

Url запроса

http://ИмяВашегоАккаунта.api.zidium.net/1.0/GetOrCreateComponentType

Запрос
{
    "Token": {
        "SecretKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    },
    "Data": {
        "SystemName": "ComponentTypeSystemName",
        "DisplayName": "ComponentTypeDisplayName"
    }
}

Здесь:

  • Token — раздел с токеном авторизации. В нём:
    • SecretKey (string) — секретный ключ аккаунта, посмотрите в личном кабинете;
  • SystemName (string) — Системное имя, по которому будет искаться тип компонента.
  • DisplayName (string) — Отображаемое имя, с которым будет создан тип компонента, если его не удастся найти.

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

Здесь:

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