Шаблоны нарядов

Создание нарядов обычно происходит по заранее введенным шаблонам. Помимо названия, шаблон наряда содержит информацию, которая не меняется существенно для определенного типа наряда. Например, наряд на ремонт, должен всегда содержать фотографию неисправности. Тогда шаблон наряда на ремонт будет содержать поле отчета с изображением, обязательное для заполнения.

Список шаблонов

Шаблоны упорядочены от самых старых к самым новым.

Список шаблонов
$ curl -H "Authorization: Bearer api-key" https://api.planadoapp.com/v2/templates | jq
{
  "templates": [
    {
      "uuid": "137e2ad5-8b09-68f0-d77f-6a19c8f707ca",
      "name": "Repair",
      "type_uuid": "8d5f2415-fce3-45a6-b417-ad939a63f70d",
      "description": "This description will be used when new a job is created",
      "scheduled_duration": {
        "minutes": 60
      },
      "assignee": null
    },
    {
      "uuid": "137dea7a-6dd3-6ee0-6977-021af57d7a4b",
      "name": "Delivery",
      "type_uuid": "8d5f2415-fce3-45a6-b417-ad939a63f70d",
      "description": null,
      "scheduled_duration": {
        "minutes": 60
      },
      "assignee": {
        "worker_uuid": "4132ed05-3b6d-456c-b3ef-ee1cc6af1e90"
      }
    },
    {
      "uuid": "137dea7a-6dd3-6ee0-6977-021af57d7a4b",
      "name": "Diagnostic",
      "type_uuid": "8d5f2415-fce3-45a6-b417-ad939a63f70d",
      "description": null,
      "scheduled_duration": {
        "minutes": 60
      },
      "assignee": {
        "team_uuid": "6a610dc0-2828-41e1-a1c2-35aeb600bdcc"
      }
    },
    ...
  ]
}
Table 1. Поля элементов templates
Поле Тип JSON-тип Может быть null Описание

uuid

UUID

Строка

Нет

Уникальный идентификатор

name

Строка

Строка

Нет

Название шаблона.
Должно быть уникальным, ограничено 500 символами

type_uuid

UUID

Строка

Нет

Тип наряда

description

Строка

Строка

Да

Описание наряда.
Ограничено 15000 символов

scheduled_duration

Длительность

Объект

Да

Длительность наряда

assignee

UUID исполнителя

Объект

Да

Исполнитель — пользователь или бригада

См. также

Получение шаблона

$ curl -H "Authorization: Bearer api-key" https://api.planadoapp.com/v2/templates/137e2ad5-8b09-68f0-d77f-6a19c8f707ca | jq
{
  "template": {
    "uuid": "137e2ad5-8b09-68f0-d77f-6a19c8f707ca",
    "name": "Network diagnostic",
    "type": {
      "uuid": "8d5f2415-fce3-45a6-b417-ad939a63f70d",
      "code": "Diagnostic"
    },
    "description": "Eris is the most distant dwarf planet from the Sun and has the greatest mass. Eris is the second largest dwarf planet (very a close second to Pluto) and at one point was considered for the position of the 10th planet. Eris’ discovery promoted discussion that eventually lead to the classification of ‘Dwarf Planets’.",
    "scheduled_duration": {
      "minutes": 60
    },
    "assignee": {
      "worker": {
        "uuid": "8ebd12cc-b2d9-407c-a4f4-5943263d54a4",
        "email": "john@doe"
      }
    },
    "skills": [
      {
        "uuid": "8d486972-28de-4216-8957-bbfffe0a8d77",
        "name": "Installation"
      },
      {
        "uuid": "173ab190-acf0-42e5-aa4e-4beecd941137",
        "name": "Diagnostic"
      }
    ],
    "territory": {
      "uuid": "d528336e-c310-4485-a80f-580b3b4cb6f1",
      "name": "Manhattan"
    },
    "possible_resolutions": [
      {
        "uuid": "f74c80bd-e21c-4d11-a036-84126004088b",
        "name": "Выполнено",
        "id": 8001,
        "successful": true
      },
      {
        "uuid": "19b30c02-371f-4da7-a24f-cf0dd840b793",
        "name": "4) Неуспешная",
        "id": 19277433001,
        "successful": false
      }
    ],
    "custom_fields": [
      {
        "uuid": "137e2ad5-8d02-6360-d77f-6a19c8f707ca",
        "name": "Instructions",
        "field_type": "file",
        "data_type": "attachment",
        "required": false,
        "value": "https://www.cs.virginia.edu/~robins/Turing_Paper_1936.pdf"
      },
      {
        "uuid": "137e2ad5-8d2e-6a00-d77f-6a19c8f707ca",
        "name": "Order #",
        "field_type": "input",
        "data_type": "string",
        "required": true
      },
      {
        "uuid": "137e81d2-c3e3-6b20-78b2-2e6e183cc868",
        "name": "Diagnostic type",
        "field_type": "dictionary",
        "data_type": "dictionary",
        "required": true,
        "value": "bcbde93e-7fc4-4ce9-bc69-501b58e3f2c9",
        "dictionary": {
          "uuid": "0bd6395c-1668-4cf2-bdab-1cde5d3eecd9",
          "name": "Diagnostic type",
          "values": [
            {
              "uuid": "14e164c2-252a-4a5c-8aed-bfd87ea76eac",
              "name": "Cable diagnostic"
            },
            {
              "uuid": "bcbde93e-7fc4-4ce9-bc69-501b58e3f2c9",
              "name": "Speed diagnostic"
            }
          ]
        }
      }
    ],
    "report_fields": [
      {
        "uuid": "a3d0136f-db10-4b70-a092-d27841c94345",
        "name": "Greetings",
        "field_type": "action",
        "data_type": "boolean",
        "required": true
      },
      {
        "uuid": "137e9b14-9ca2-64a0-b9b6-5eb27cb176c4",
        "name": "Photo of issue",
        "field_type": "file",
        "data_type": "image",
        "required": true
      },
      {
        "uuid": "a3d0136f-db10-4b70-a092-d27841c94345",
        "name": "Issue solved?",
        "field_type": "checkbox",
        "data_type": "boolean",
        "required": true
      },
      {
        "uuid": "354e9542-e706-4fa1-a52b-175ca7d8081e",
        "name": "Installed equipment",
        "field_type": "barcode",
        "data_type": "string",
        "required": false
      },
      {
        "uuid": "1824094e-fa43-43a2-8f6f-c94f201d035c"
        "name": "Actual severity of damage",
        "field_type": "dictionary",
        "data_type": "dictionary",
        "required": true,
        "dictionary": {
          "uuid": "e88d66e2-82e3-4699-ab39-e59fe2b902ed",
          "name": "Damage severity"
        }
      },
      {
        "uuid": "127bdd39-efad-4be3-9e07-c5238b78e68d",
        "name": "Notes",
        "field_type": "textarea",
        "data_type": "string",
        "required": false
      }
    ]
  }
}
Table 2. Поля template
Поле Тип JSON-тип Может быть null Описание

uuid

UUID

Строка

Нет

Уникальный идентификатор

name

Строка

Строка

Нет

Название шаблона.
Должно быть уникальным, ограничено 500 символами

description

Строка

Строка

Да

Описание наряда.
Ограничено 15000 символов

type

Тип наряда

Объект

Да

Тип наряда

assignee

Исполнитель

Объект

Да

Исполнитель — пользователь или бригада

territory

Участок

Объект

Да

Участок

skills

[Навык]

Массив

Нет

Список навыков, требуемых для выполенния наряда

custom_fields

[Доп. поле]

Массив

Нет

Список дополнительных полей наряда

report_fields

[Доп. поле]

Массив

Нет

Список полей отчета

possible_resolutions

[Резолюция]

Массив

Нет

Список возможных резолюций при завершении наряда