Retrieves all the job work instruction list.

Request Information

URI Parameters :

None.

Body Parameters :

None.

Response Information

Resource Description :

job_work_instruction_list
NameDescriptionTypeAdditional information
id

Primary Key

globally unique identifier

Required

jobs_id

Foreign key of the jobs

globally unique identifier

Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided

jobs_reference_back_office

Embedded entity "jobs" using ERP PK when adding/updating

string

Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided

jobs

Embedded entity "jobs" when adding/updating

jobs

Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided

work_instruction_details_id

work instruction details id

globally unique identifier
work_instruction_details_reference_back_office

Embedded code "work instruction details" when adding/updating

string
work_instruction_details

Embedded entity "work instruction details" when adding/updating

work_instruction_details
user_id

Filled by the person that completed that item on the checklist

globally unique identifier
work_instruction_action_type

Value from work_instruction_action_type.name

string
work_instruction_id

work instruction id

globally unique identifier

Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided

work_instruction_reference_back_office

Embedded code "work instruction" when adding/updating

string

Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided

work_instruction

Embedded entity "work instruction" when adding/updating

work_instruction

Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided

name

The "on what"

string

Required

Max length: 4000

status

Status can be Ok,NotOk,Replaced,NotApplicable

string

Max length: 50

date_done

Datetime filled when status goes to one valable status.

date
remark

Additional remark from the technician.

string

Max length: 255

advise

Additional advice from the technician.

string

Max length: 255

sequence

To order it.

integer
reference_back_office

The Id/Ref of the back office for this job work instruction. Used by Embedded entity

string

Max length: 255

group_name

Name of the group

string

Max length: 4000

group_sequence

Order of the group

integer
type

One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default

string
instruction_document_count

Specify how many documents/photos must be added if type is Picture

integer
db_report_type_id

When type is Form, you must specify which db_report_type must be filled

globally unique identifier
db_report_type_name

When type is Form, you must specify which db_report_type must be filled

string
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

date

Response Formats

application/json, text/json

Sample:
{
  "id": "cc1bd180-82ea-44dd-b6f5-768c0f19d821",
  "jobs_id": "1f39d48d-00f5-4ec1-99dd-739aba7d1c30",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "c0e27b91-1d90-4109-b1d1-ea7c97a5cc56",
    "_parent_id": "d2794d57-c7af-4ad6-adad-46a0f47d5803",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "c6198065-a151-4dfc-a480-32fb6d4ebe5f",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "da8101e9-9686-49b3-bbce-16b11273b3b1",
      "_parent_id": "fea230bd-9b43-4e49-bcc6-c444a821a8e1",
      "root_parent_id": "d53a4961-94ad-44a2-99f2-bbdc215a979b",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "ea7e43a6-ba62-48fe-a38d-132d7299ba98",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "29736ecd-4d66-42ef-8420-6560e1cd020c",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "083f57d5-e11a-4333-81a2-956e642f6475",
        "_parent_code": "sample string 6",
        "sales_organization_id": "e7b5efcb-7f2a-45be-8b40-6cf88b4c901e",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "f3343f05-7377-45dd-b78c-9bd5783e89cb",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "3793ed9f-b560-453d-9499-7e7c8c4f1fcd",
          "db_currency_id": "a5146bb6-5adf-49f3-9032-df18c00232d5",
          "db_language_id": "299b9ad5-ef42-4fc7-b03d-6ece6ee2a342",
          "accountancy_code": "sample string 8",
          "archived": true,
          "default_unit_of_measure_system_type": "sample string 10",
          "street": "sample string 11",
          "street2": "sample string 12",
          "street_number": "sample string 13",
          "zip": "sample string 14",
          "city": "sample string 15",
          "email": "sample string 16",
          "phone": "sample string 17",
          "fax": "sample string 18",
          "url": "sample string 19",
          "vat_reg_code": "sample string 20",
          "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00"
        },
        "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00"
      },
      "equipment_model_id": "200a5b28-006c-43d3-8289-cea434cb78bb",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "144e7b0f-844c-4f04-a441-197c1ebfb3d0",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "fa3a5290-9580-434c-8357-2ae5a45f9a23",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "eb24af8e-62fa-417b-8af2-39e62f3dc0c8",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "c1b09794-7206-4d4e-8d8c-3b26f781ad91",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "f3343f05-7377-45dd-b78c-9bd5783e89cb",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "3793ed9f-b560-453d-9499-7e7c8c4f1fcd",
            "db_currency_id": "a5146bb6-5adf-49f3-9032-df18c00232d5",
            "db_language_id": "299b9ad5-ef42-4fc7-b03d-6ece6ee2a342",
            "accountancy_code": "sample string 8",
            "archived": true,
            "default_unit_of_measure_system_type": "sample string 10",
            "street": "sample string 11",
            "street2": "sample string 12",
            "street_number": "sample string 13",
            "zip": "sample string 14",
            "city": "sample string 15",
            "email": "sample string 16",
            "phone": "sample string 17",
            "fax": "sample string 18",
            "url": "sample string 19",
            "vat_reg_code": "sample string 20",
            "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00"
          },
          "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00"
        },
        "equipment_family_id": "9640d339-0417-4b48-ab13-ca3a71a723bc",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "29736ecd-4d66-42ef-8420-6560e1cd020c",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "083f57d5-e11a-4333-81a2-956e642f6475",
          "_parent_code": "sample string 6",
          "sales_organization_id": "e7b5efcb-7f2a-45be-8b40-6cf88b4c901e",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "f3343f05-7377-45dd-b78c-9bd5783e89cb",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "3793ed9f-b560-453d-9499-7e7c8c4f1fcd",
            "db_currency_id": "a5146bb6-5adf-49f3-9032-df18c00232d5",
            "db_language_id": "299b9ad5-ef42-4fc7-b03d-6ece6ee2a342",
            "accountancy_code": "sample string 8",
            "archived": true,
            "default_unit_of_measure_system_type": "sample string 10",
            "street": "sample string 11",
            "street2": "sample string 12",
            "street_number": "sample string 13",
            "zip": "sample string 14",
            "city": "sample string 15",
            "email": "sample string 16",
            "phone": "sample string 17",
            "fax": "sample string 18",
            "url": "sample string 19",
            "vat_reg_code": "sample string 20",
            "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00"
          },
          "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00"
        },
        "date_in_production_since": "2026-11-19T22:04:45.1854513+00:00",
        "date_out_of_production_since": "2026-11-19T22:04:45.1854513+00:00",
        "date_end_support": "2026-11-19T22:04:45.1854513+00:00",
        "sales_organization_id": "b0b75c01-0629-476f-bd1d-d1c0628ef469",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "f3343f05-7377-45dd-b78c-9bd5783e89cb",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "3793ed9f-b560-453d-9499-7e7c8c4f1fcd",
          "db_currency_id": "a5146bb6-5adf-49f3-9032-df18c00232d5",
          "db_language_id": "299b9ad5-ef42-4fc7-b03d-6ece6ee2a342",
          "accountancy_code": "sample string 8",
          "archived": true,
          "default_unit_of_measure_system_type": "sample string 10",
          "street": "sample string 11",
          "street2": "sample string 12",
          "street_number": "sample string 13",
          "zip": "sample string 14",
          "city": "sample string 15",
          "email": "sample string 16",
          "phone": "sample string 17",
          "fax": "sample string 18",
          "url": "sample string 19",
          "vat_reg_code": "sample string 20",
          "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00"
        },
        "replacement_period_nb_months": 14,
        "warranty_period_nb_months": 15,
        "translations": [
          {
            "field_name": "sample string 1",
            "language_code": "sample string 2",
            "value_translated": "sample string 3"
          },
          {
            "field_name": "sample string 1",
            "language_code": "sample string 2",
            "value_translated": "sample string 3"
          }
        ],
        "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00"
      },
      "project_status_id": "0b3ffb1a-7fe6-43d4-bbf1-f8666cfe01c5",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "72f93ba8-10e4-4052-9e65-5243f47faf0f",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "cd493081-ca28-4643-9d47-833b8166d9c4",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "f3343f05-7377-45dd-b78c-9bd5783e89cb",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "3793ed9f-b560-453d-9499-7e7c8c4f1fcd",
          "db_currency_id": "a5146bb6-5adf-49f3-9032-df18c00232d5",
          "db_language_id": "299b9ad5-ef42-4fc7-b03d-6ece6ee2a342",
          "accountancy_code": "sample string 8",
          "archived": true,
          "default_unit_of_measure_system_type": "sample string 10",
          "street": "sample string 11",
          "street2": "sample string 12",
          "street_number": "sample string 13",
          "zip": "sample string 14",
          "city": "sample string 15",
          "email": "sample string 16",
          "phone": "sample string 17",
          "fax": "sample string 18",
          "url": "sample string 19",
          "vat_reg_code": "sample string 20",
          "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00"
      },
      "company_id": "4a55611c-8d5e-4865-b7cf-6950196d5a9b",
      "company_code": "sample string 12",
      "db_address_id": "1295ca34-0800-49c9-8772-c8b61e5764f5",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "7dc7708b-6e53-4e15-904b-39b340ba6cd6",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "1730edc4-57c5-4c0c-b76c-b92f66baa14c",
      "name": "sample string 19",
      "description": "sample string 20",
      "reference_back_office": "sample string 21",
      "serial_number": "sample string 22",
      "barcode": "sample string 23",
      "date_start_production": "2026-11-19T22:04:45.1854513+00:00",
      "date_create": "2026-11-19T22:04:45.1854513+00:00",
      "date_update": "2026-11-19T22:04:45.1854513+00:00",
      "updated_by_user_id": "9e97d82b-5153-4417-b761-07dde5a72682",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-11-19T22:04:45.1854513+00:00",
      "last_standard_result_score_1": "sample string 30",
      "last_standard_result_score_2": "sample string 31",
      "target_standard_result_score_1": "sample string 32",
      "target_standard_result_score_2": "sample string 33",
      "date_built": "2026-11-19T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-11-19T22:04:45.1854513+00:00",
      "date_last_job": "2026-11-19T22:04:45.1854513+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-11-19T22:04:45.1854513+00:00",
      "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "e9613cb3-9a9e-4698-aff3-a781a791561a",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "d7fe7f89-3556-438f-8c43-2bdb7a2a240e",
      "name": "sample string 2",
      "sales_organization_id": "f02227f6-aabc-4332-b64a-d5debc869ec8",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "d932fe4e-cb69-4e7a-a1bd-1d032a455943",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "bcd949ce-c286-4198-b9a5-e4d586d68f8c",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "622f44ba-cf67-4b79-981c-bb70b6a6c7c6",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "f3343f05-7377-45dd-b78c-9bd5783e89cb",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "3793ed9f-b560-453d-9499-7e7c8c4f1fcd",
        "db_currency_id": "a5146bb6-5adf-49f3-9032-df18c00232d5",
        "db_language_id": "299b9ad5-ef42-4fc7-b03d-6ece6ee2a342",
        "accountancy_code": "sample string 8",
        "archived": true,
        "default_unit_of_measure_system_type": "sample string 10",
        "street": "sample string 11",
        "street2": "sample string 12",
        "street_number": "sample string 13",
        "zip": "sample string 14",
        "city": "sample string 15",
        "email": "sample string 16",
        "phone": "sample string 17",
        "fax": "sample string 18",
        "url": "sample string 19",
        "vat_reg_code": "sample string 20",
        "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00"
    },
    "job_status_id": "ef81dbe3-7f7d-4deb-b2c9-56cdcab8a740",
    "job_status_code": "sample string 11",
    "db_address_id": "cbb0dc85-dfb2-467c-93f5-c01f8816a6de",
    "contact_id": "dbb305d9-908d-4445-aa19-f3e58b52f139",
    "requested_by_company_id": "53f3ad77-722f-40cf-874d-49a8c24a5dd5",
    "requested_by_contact_id": "8430d976-42f0-43e8-a725-7432bd8cfcee",
    "reference_back_office": "sample string 16",
    "name": "sample string 17",
    "description": "sample string 18",
    "working_sequence": 19,
    "internal_memo": "sample string 20",
    "prejob_information": "sample string 21",
    "estimated_time": 22,
    "earliest_date_plannable": "2026-11-19T22:04:45.1854513+00:00",
    "due_date": "2026-11-19T22:04:45.1854513+00:00",
    "date_create": "2026-11-19T22:04:45.1854513+00:00",
    "date_update": "2026-11-19T22:04:45.1854513+00:00",
    "date_closed": "2026-11-19T22:04:45.1854513+00:00",
    "suggested_user_id": "cace32ae-167d-4ac8-9341-fcf7b06880b3",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "3e141c66-447e-4384-8ea0-a6d861f22e7c",
      "db_language_id": "1668b533-8794-4d7e-9c77-e961c9fe16d9",
      "username": "sample string 3",
      "firstname": "sample string 4",
      "lastname": "sample string 5",
      "code": "sample string 6",
      "archived": true,
      "disabled": true,
      "emergency_contact": "sample string 9",
      "bankaccount": "sample string 10",
      "social_security": "sample string 11",
      "place_of_birth": "sample string 12",
      "nationality": "sample string 13",
      "functions": "sample string 14",
      "birthdate": "2026-11-19T22:04:45.1854513+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "d0925b74-1cc3-4b0d-8785-5968a824f6f9",
      "sales_organization": {
        "id": "f3343f05-7377-45dd-b78c-9bd5783e89cb",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "3793ed9f-b560-453d-9499-7e7c8c4f1fcd",
        "db_currency_id": "a5146bb6-5adf-49f3-9032-df18c00232d5",
        "db_language_id": "299b9ad5-ef42-4fc7-b03d-6ece6ee2a342",
        "accountancy_code": "sample string 8",
        "archived": true,
        "default_unit_of_measure_system_type": "sample string 10",
        "street": "sample string 11",
        "street2": "sample string 12",
        "street_number": "sample string 13",
        "zip": "sample string 14",
        "city": "sample string 15",
        "email": "sample string 16",
        "phone": "sample string 17",
        "fax": "sample string 18",
        "url": "sample string 19",
        "vat_reg_code": "sample string 20",
        "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "a4a8808b-2b0b-4599-a5a8-dadc10fa0946",
      "email": "sample string 22",
      "phone": "sample string 23",
      "fax": "sample string 24",
      "mobile": "sample string 25",
      "private_email": "sample string 26",
      "private_phone": "sample string 27",
      "private_fax": "sample string 28",
      "private_mobile": "sample string 29",
      "private_street": "sample string 30",
      "private_street_number": "sample string 31",
      "private_city": "sample string 32",
      "private_zip": "sample string 33",
      "private_db_country_id": "592664c5-0570-4df7-88a5-2deb9d43ee59",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "7384e508-9fd9-4dd1-a6f7-341bed3a0a72"
    },
    "suggested_date_start": "2026-11-19T22:04:45.1854513+00:00",
    "skill_id": "b0a6df45-deff-4db9-939f-def9080016b7",
    "skill_code": "sample string 32",
    "skill": {
      "id": "42d98f58-1abc-4343-9da8-ce3a1b11e174",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "957a3cb2-d3a3-422a-9712-f954d541caa6",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "f3343f05-7377-45dd-b78c-9bd5783e89cb",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "3793ed9f-b560-453d-9499-7e7c8c4f1fcd",
        "db_currency_id": "a5146bb6-5adf-49f3-9032-df18c00232d5",
        "db_language_id": "299b9ad5-ef42-4fc7-b03d-6ece6ee2a342",
        "accountancy_code": "sample string 8",
        "archived": true,
        "default_unit_of_measure_system_type": "sample string 10",
        "street": "sample string 11",
        "street2": "sample string 12",
        "street_number": "sample string 13",
        "zip": "sample string 14",
        "city": "sample string 15",
        "email": "sample string 16",
        "phone": "sample string 17",
        "fax": "sample string 18",
        "url": "sample string 19",
        "vat_reg_code": "sample string 20",
        "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00"
      },
      "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "a38cc1ee-de3c-450d-a901-f08ee7b21858",
    "date_reported_by_company": "2026-11-19T22:04:45.1854513+00:00",
    "id2": 36,
    "company_id": "83164b20-d948-4990-8dba-29df7a73c4f0",
    "company_code": "sample string 38",
    "db_address_name": "sample string 39",
    "db_address_street": "sample string 40",
    "db_address_street2": "sample string 41",
    "db_address_street_number": "sample string 42",
    "db_address_city": "sample string 43",
    "db_address_zip": "sample string 44",
    "db_address_db_country_id": "76bc79c8-cb45-41bc-9406-2111f6e0bf14",
    "db_address_db_country_code": "sample string 46",
    "db_address_phone": "sample string 47",
    "db_address_email": "sample string 48",
    "db_address_latitude_decimal": 49.0,
    "db_address_longitude_decimal": 50.0,
    "estimated_quantity_remark": "sample string 51",
    "modified_dateutc": "2026-11-19T22:04:45.1854513+00:00"
  },
  "work_instruction_details_id": "cc1b74b6-a432-4acb-8611-5052cb374124",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "53f28bed-29f3-4395-b9fd-e78fa1c50190",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "b28102e4-379c-4f15-8136-73d03a4545ee",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-11-19T22:04:45.2047457+00:00",
  "remark": "sample string 13",
  "advise": "sample string 14",
  "sequence": 1,
  "reference_back_office": "sample string 15",
  "group_name": "sample string 16",
  "group_sequence": 1,
  "type": "sample string 17",
  "instruction_document_count": 1,
  "db_report_type_id": "5789ea2c-b3e8-4aaa-80e8-8335bbc3bd41",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-11-19T22:04:45.2047457+00:00"
}