Документация / API / Json / Проверки / GetOrCreateUnitTest

---

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

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

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

{
    "Token": {
        "SecretKey": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
    },
    "Data": {
        "ComponentId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "UnitTestTypeId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "SystemName": "UnittestSystemName",
        "DisplayName": "UnittestDisplayName"
    }
}

Здесь:

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

{
    "Data": {
        "Id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "TypeId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
        "SystemName": "UnittestSystemName",
        "DisplayName": "UnittestDisplayName"
    },
    "Code": 10
}

Здесь:

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

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