Field NationDeveloper Platform
Field NationDeveloper Platform
Overview

Work Orders

Resources

Get workorder template by id GETGet workorder templates GET
ConfigurationTemplates

Get workorder template by id


Retrieve a single work order template by template_id, including its tasks and configuration.

GET
/api/rest/v2/templates/{template_id}

Authorization

access_token
access_token<token>

OAuth 2.0 Access Token

In: query

Path Parameters

template_id*string

Template id

Query Parameters

columns?string

Columns

curl -X GET "https://api-sandbox.fndev.net/api/rest/v2/templates/string_value"
{
  "id": 123,
  "name": "Sample Name",
  "work_orders": 0,
  "created": {
    "utc": "string_value"
  },
  "updated": {
    "utc": "string_value"
  },
  "default": true,
  "company": {
    "id": 123,
    "name": "Sample Name"
  },
  "company_attributes": {
    "workorder_network_change_admin_only": 0
  },
  "actions": [],
  "client": {
    "id": 123,
    "name": "Sample Name"
  },
  "project": {
    "id": 123,
    "name": "Sample Name"
  },
  "author": {
    "id": 123,
    "first_name": "John",
    "last_name": "Doe",
    "thumbnail": "string_value",
    "phone": "555-0199",
    "email": "user@fieldnation.com"
  },
  "data": {
    "_v": 0,
    "_no_model_update": "string_value",
    "attachments": {
      "metadata": {
        "total": 100,
        "page": 0,
        "pages": 5,
        "per_page": 20
      },
      "results": []
    },
    "title": "string_value",
    "type_of_work": {
      "id": 123,
      "idv4": 0,
      "self_reported": 0,
      "name": "Sample Name"
    },
    "client": {
      "id": 123,
      "name": "Sample Name"
    },
    "project": {
      "id": 123,
      "name": "Sample Name"
    },
    "template": {
      "id": 123
    },
    "service_contract": [],
    "team": {
      "id": 123
    },
    "service_types": [],
    "additional_type_of_works": [],
    "site_device": [],
    "equipments": [],
    "networks": [],
    "printable": true,
    "allow_counter_offers": true,
    "require_gps": true,
    "w2": true,
    "manager": {
      "thumbnail": "string_value",
      "id": 123
    },
    "contacts": {
      "results": [],
      "actions": [],
      "metadata": {
        "total": 100,
        "page": 0,
        "pages": 5,
        "per_page": 20
      },
      "correlation_id": "string_value"
    },
    "description": {
      "html": "string_value"
    },
    "confidential": {
      "html": "string_value"
    },
    "custom_fields": {
      "results": [],
      "metadata": "string"
    },
    "location": {
      "mode": "string_value",
      "address1": "123 Main St",
      "address2": "Suite 100",
      "city": "Minneapolis",
      "state": "MN",
      "zip": "90210",
      "country": "USA",
      "type": 0,
      "saved_location": {
        "id": 123
      }
    },
    "pay": {
      "type": "fixed",
      "base": {
        "units": 0,
        "amount": 0
      },
      "additional": {
        "units": 0,
        "amount": 50
      },
      "hours": 0,
      "minimum_payment": 0,
      "range": {
        "min": 0,
        "max": 0
      },
      "total": 100,
      "calculated_total": {
        "total": {
          "min": 0,
          "max": 0
        }
      },
      "actions": [],
      "correlation_id": "string_value",
      "finance": {
        "id": 123
      },
      "funding": [],
      "expenses": {
        "results": []
      },
      "penalties": {
        "actions": [],
        "metadata": {
          "total": 100,
          "page": 0,
          "pages": 5,
          "per_page": 20,
          "columns": "string_value",
          "view": "string_value",
          "sort": "string_value",
          "order": "string_value",
          "list": "string_value",
          "company_columns": {
            "actions": []
          },
          "default_columns": "string_value",
          "available_columns": [],
          "available_filters": []
        },
        "params": [],
        "lists": [],
        "correlation_id": "string_value",
        "f_client": "string_value",
        "fs_client": true,
        "f_project": "string_value",
        "fs_project": true,
        "results": []
      },
      "bonuses": {
        "actions": [],
        "metadata": {
          "total": 100,
          "page": 0,
          "pages": 5,
          "per_page": 20,
          "columns": "string_value",
          "view": "string_value",
          "sort": "string_value",
          "order": "string_value",
          "list": "string_value",
          "company_columns": {
            "actions": []
          },
          "default_columns": "string_value",
          "available_columns": [],
          "available_filters": []
        },
        "params": [],
        "lists": [],
        "correlation_id": "string_value",
        "f_client": "string_value",
        "fs_client": true,
        "f_project": "string_value",
        "fs_project": true,
        "results": []
      }
    },
    "tasks": {
      "results": []
    },
    "actions": [],
    "tab": "string_value",
    "template_name": "string_value",
    "default_project": "string_value",
    "skills": [],
    "schedule": {
      "service_window": {
        "mode": "exact",
        "start": {
          "utc": "string_value",
          "local": {
            "date": "2025-01-01",
            "time": "12:00:00"
          }
        },
        "end": {
          "utc": "string_value",
          "local": {
            "date": "2025-01-01",
            "time": "12:00:00"
          }
        }
      },
      "correlation_id": "string_value",
      "time_zone": {
        "name": "Sample Name",
        "id": "string_value",
        "category": "string_value"
      },
      "relative": {
        "relative_schedule_date": "string_value",
        "relative_schedule_time": "string_value",
        "relative_schedule_range": "string_value",
        "mode": "string_value"
      },
      "actions": []
    },
    "has_qualifications": 0,
    "qualifications": {
      "actions": [],
      "selection_rule": {
        "id": 123,
        "name": "Sample Name",
        "total_selection_rule": "string_value",
        "actions": []
      }
    },
    "require_ontime": true,
    "special_skill": {
      "id": 123,
      "required": true,
      "certification_id": 0,
      "dynamic_term_id": 0,
      "name": "Sample Name",
      "feeReduction": 0,
      "fee": 0,
      "international": 0
    },
    "types_of_work": [],
    "survey_experiment": true,
    "advanced_qualifications": true,
    "id": 123,
    "name": "Sample Name",
    "default": true,
    "correlation_id": "string_value",
    "experiment_type": "string_value",
    "company": {
      "id": 123,
      "name": "Sample Name"
    },
    "service_types_legacy": []
  },
  "v3_pay_type": "string_value",
  "v2": {
    "survey_experiment": true,
    "advanced_qualifications": true,
    "actions": [],
    "id": 123,
    "title": "string_value",
    "name": "Sample Name",
    "client": {
      "id": 123,
      "name": "Sample Name"
    },
    "project": {
      "id": 123,
      "name": "Sample Name"
    },
    "type_of_work": {
      "id": 123,
      "idv4": 0,
      "name": "Sample Name"
    },
    "additional_type_of_works": [],
    "types_of_work": [],
    "service_types": [],
    "site_device": [],
    "service_contract": {
      "id": 123
    },
    "team": {
      "id": 123
    },
    "printable": true,
    "require_gps": true,
    "allow_counter_offers": true,
    "special_skill": {
      "id": 123,
      "required": true,
      "certification_id": 0,
      "dynamic_term_id": 0,
      "name": "Sample Name",
      "feeReduction": 0,
      "fee": 0,
      "international": 0
    },
    "equipments": [],
    "networks": {
      "metadata": {
        "total": 100,
        "page": 0,
        "pages": 5,
        "per_page": 20
      },
      "results": []
    },
    "w2": true,
    "smart_audit_rule_id": 0,
    "require_ontime": true,
    "manager": {
      "thumbnail": "string_value",
      "id": 123
    },
    "contacts": {
      "metadata": {
        "total": 100,
        "page": 0,
        "pages": 5,
        "per_page": 20
      },
      "results": [],
      "correlation_id": "string_value",
      "actions": []
    },
    "description": {
      "html": "string_value"
    },
    "confidential": {
      "html": "string_value"
    },
    "attachments": {
      "metadata": {
        "total": 100,
        "page": 0,
        "pages": 5,
        "per_page": 20
      },
      "results": []
    },
    "tasks": {
      "metadata": {
        "total": 100,
        "page": 0,
        "pages": 5,
        "per_page": 20
      },
      "results": [],
      "correlation_id": "string_value",
      "actions": []
    },
    "custom_fields": {
      "metadata": {
        "total": 100,
        "page": 0,
        "pages": 5,
        "per_page": 20
      },
      "actions": [],
      "results": []
    },
    "schedule": {
      "service_window": {
        "mode": "exact",
        "start": {
          "utc": "string_value",
          "local": {
            "date": "2025-01-01",
            "time": "12:00:00"
          }
        },
        "end": {
          "utc": "string_value",
          "local": {
            "date": "2025-01-01",
            "time": "12:00:00"
          }
        }
      },
      "correlation_id": "string_value",
      "time_zone": {
        "name": "Sample Name",
        "id": "string_value",
        "category": "string_value"
      },
      "relative": {
        "relative_schedule_date": "string_value",
        "relative_schedule_time": "string_value",
        "relative_schedule_range": "string_value",
        "mode": "string_value"
      },
      "actions": []
    },
    "pay": {
      "type": "fixed",
      "base": {
        "units": 0,
        "amount": 0
      },
      "additional": {
        "units": 0,
        "amount": 50
      },
      "hours": 0,
      "minimum_payment": 0,
      "range": {
        "min": 0,
        "max": 0
      },
      "total": 100,
      "calculated_total": {
        "total": {
          "min": 0,
          "max": 0
        }
      },
      "actions": [],
      "correlation_id": "string_value",
      "finance": {
        "id": 123
      },
      "funding": [],
      "expenses": {
        "results": []
      },
      "penalties": {
        "actions": [],
        "metadata": {
          "total": 100,
          "page": 0,
          "pages": 5,
          "per_page": 20,
          "columns": "string_value",
          "view": "string_value",
          "sort": "string_value",
          "order": "string_value",
          "list": "string_value",
          "company_columns": {
            "actions": []
          },
          "default_columns": "string_value",
          "available_columns": [],
          "available_filters": []
        },
        "params": [],
        "lists": [],
        "correlation_id": "string_value",
        "f_client": "string_value",
        "fs_client": true,
        "f_project": "string_value",
        "fs_project": true,
        "results": []
      },
      "bonuses": {
        "actions": [],
        "metadata": {
          "total": 100,
          "page": 0,
          "pages": 5,
          "per_page": 20,
          "columns": "string_value",
          "view": "string_value",
          "sort": "string_value",
          "order": "string_value",
          "list": "string_value",
          "company_columns": {
            "actions": []
          },
          "default_columns": "string_value",
          "available_columns": [],
          "available_filters": []
        },
        "params": [],
        "lists": [],
        "correlation_id": "string_value",
        "f_client": "string_value",
        "fs_client": true,
        "f_project": "string_value",
        "fs_project": true,
        "results": []
      }
    },
    "qualifications": {
      "actions": [],
      "selection_rule": {
        "id": 123,
        "name": "Sample Name",
        "total_selection_rule": "string_value",
        "actions": []
      }
    },
    "default": true,
    "company": {
      "id": 123,
      "name": "Sample Name"
    },
    "correlation_id": "string_value",
    "service_types_legacy": []
  }
}
{
  "status": 500,
  "message": "Operation successful."
}
{
  "status": 500,
  "message": "Operation successful."
}

Response Body

application/json

application/json

application/json

Last updated on

Create Location POST

Previous Page

Get workorder templates GET

Next Page

curl -X GET "https://api-sandbox.fndev.net/api/rest/v2/templates/string_value"