Job templates

Job creation is usually automated by using job templates. A template is a set of fields and values that are used as defaults when creating a new job.

Resource URL: https://api.planadoapp.com/v2/templates

List templates

Templates are order from oldest to newest.

$ 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,
      "created_at": "2016-05-29T17:31:01.419601Z",
      "updated_at": "2016-06-07T10:57:19.529209Z"
    },
    {
      "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"
      },
      "created_at": "2016-06-29T17:31:01.419601Z",
      "updated_at": "2016-07-07T10:57:19.529209Z"
    },
    {
      "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"
      },
      "created_at": "2016-07-29T17:31:01.419601Z",
      "updated_at": "2016-08-07T10:57:19.529209Z"
    },
    ...
  ]
}

Table 1. Fields of `templates` elements
Field	Type	JSON type	Can be `null`	Description
`uuid`	UUID	String	No	Unique identifier
`name`	String	String	No	Template name. Must be unique, limited to 500 characters. Since template names often used in the UI longer names can be truncated when displayed
`type_uuid`	UUID	String	No	Job type
`description`	String	String	Yes	Job description. Limited to 15000 characters
`scheduled_duration`	Duration	Object	Yes	Job duration
`assignee`	Assignee UUID	Object	Yes	Either a user or a team
`created_at`	Timestamp	String	No	Timestamp of creation
`updated_at`	Timestamp	String	No	Timestamp of last update

Filters

By `updated_at` value

$ curl -H "Authorization: Bearer api-key" "https://api.planadoapp.com/v2/templates?updated_at[before]=2019-10-01T10:30:10Z&updated_at[after]=2019-09-30T10:30:10Z" | jq
{
  "templates": [...]
}

before and after filters use strict comparison. Both values are optional.

By `name`

$ curl -H "Authorization: Bearer api-key" "https://api.planadoapp.com/v2/templates?name=Diagnostic" | jq
{
  "templates": [...]
}

Get template

$ 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": "Completed",
        "id": 8001,
        "successful": true
      },
      {
        "uuid": "19b30c02-371f-4da7-a24f-cf0dd840b793",
        "name": "Not completed",
        "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
      }
    ],
    "created_at": "2016-05-29T17:31:01.419601Z",
    "updated_at": "2016-06-07T10:57:19.529209Z"
  }
}

Table 2. Fields of `template` elements
Field	Type	JSON type	Can be `null`	Description
`uuid`	UUID	String	No	Unique identifier
`name`	String	String	No	Template name. Must be unique, up to 500 characters. Since template names often used in the UI longer names can be truncated when displayed
`description`	String	String	Yes	Job description. Up to 15000 characters
`type`	Job type	Object	Yes	Job type
`assignee`	Assignee	Object	Yes	Either a user or a team
`territory`	Territory	Object	Yes	Territory
`skills`	[Skill]	Array	No	List of skills required for the job
`custom_fields`	[Custom field]	Array	No	List of custom fields
`report_fields`	[Custom field]	Array	No	List of report fields
`possible_resolutions`	[Resolution]	Array	No	List of possible resolutions
`created_at`	Timestamp	String	No	Timestamp of creation
`updated_at`	Timestamp	String	No	Timestamp of last update

Job templates

List templates

Filters

By updated_at value

By name

See also

Get template

By `updated_at` value

By `name`