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": "f1cbfdb3-ff68-42dc-a2b2-8eb417bcf485",
  "jobs_id": "fae08fce-5368-463a-b99f-ffbec9e08295",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "4b15b974-c648-4940-831f-5afbbbdaf770",
    "_parent_id": "ca9f22a0-2ba2-4680-8d07-525471d12761",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "b1fa7e36-1bfa-4ca2-9f5c-c71783e80a0e",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "94e06bf2-2cc0-4c00-a202-57249d0912ed",
      "_parent_id": "26382a5d-f5bd-4279-9bbe-3a72cc32f02d",
      "root_parent_id": "28379bb6-5c82-4c60-a593-d9805126fb0a",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "f36b9c22-2761-4109-904e-b3f5a513f0ec",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "c37ee181-a751-4f73-b753-0259a8b55d03",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "87b02b4d-b9d6-4a7e-895b-766d2d91d537",
        "_parent_code": "sample string 6",
        "sales_organization_id": "d6eb5d79-5282-48e7-b038-97f75a0af677",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "35a17400-68f7-46fa-942f-5bd1124b106d",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "3d45b574-63ee-4d89-9bc5-9e88ea05d5dd",
          "db_currency_id": "6862961b-ccac-49c1-9757-7734d758a6de",
          "db_language_id": "0d9b28ef-bb48-47ff-91fc-378a8154a2e3",
          "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-01-19T00:58:26.9428922+00:00"
        },
        "modified_dateutc": "2026-01-19T00:58:26.9428922+00:00"
      },
      "equipment_model_id": "d5270065-bd68-4375-9711-6941a9996dc8",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "b6c3b654-62c8-47e6-8e46-d2bd6a037e4e",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "cb291258-36bd-4b97-a566-e7518b5119c2",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "028053f2-7e3e-48c9-805f-28dae701e902",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "22effeea-0af6-4ccb-b30d-03a1c89246da",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "35a17400-68f7-46fa-942f-5bd1124b106d",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "3d45b574-63ee-4d89-9bc5-9e88ea05d5dd",
            "db_currency_id": "6862961b-ccac-49c1-9757-7734d758a6de",
            "db_language_id": "0d9b28ef-bb48-47ff-91fc-378a8154a2e3",
            "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-01-19T00:58:26.9428922+00:00"
          },
          "modified_dateutc": "2026-01-19T00:58:26.9428922+00:00"
        },
        "equipment_family_id": "45060fe5-e4df-4bbd-9c69-8803b6e13be2",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "c37ee181-a751-4f73-b753-0259a8b55d03",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "87b02b4d-b9d6-4a7e-895b-766d2d91d537",
          "_parent_code": "sample string 6",
          "sales_organization_id": "d6eb5d79-5282-48e7-b038-97f75a0af677",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "35a17400-68f7-46fa-942f-5bd1124b106d",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "3d45b574-63ee-4d89-9bc5-9e88ea05d5dd",
            "db_currency_id": "6862961b-ccac-49c1-9757-7734d758a6de",
            "db_language_id": "0d9b28ef-bb48-47ff-91fc-378a8154a2e3",
            "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-01-19T00:58:26.9428922+00:00"
          },
          "modified_dateutc": "2026-01-19T00:58:26.9428922+00:00"
        },
        "date_in_production_since": "2026-01-19T00:58:26.9428922+00:00",
        "date_out_of_production_since": "2026-01-19T00:58:26.9428922+00:00",
        "date_end_support": "2026-01-19T00:58:26.9428922+00:00",
        "sales_organization_id": "130120fe-ca33-4c24-a91c-7241346732ce",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "35a17400-68f7-46fa-942f-5bd1124b106d",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "3d45b574-63ee-4d89-9bc5-9e88ea05d5dd",
          "db_currency_id": "6862961b-ccac-49c1-9757-7734d758a6de",
          "db_language_id": "0d9b28ef-bb48-47ff-91fc-378a8154a2e3",
          "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-01-19T00:58:26.9428922+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-01-19T00:58:26.9428922+00:00"
      },
      "project_status_id": "0607c829-255c-4157-9c67-6e7993efe827",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "7d7e2476-0783-47ce-a572-d70372a6c05e",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "d66a25f5-4014-4ba0-a150-3ea39406009e",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "35a17400-68f7-46fa-942f-5bd1124b106d",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "3d45b574-63ee-4d89-9bc5-9e88ea05d5dd",
          "db_currency_id": "6862961b-ccac-49c1-9757-7734d758a6de",
          "db_language_id": "0d9b28ef-bb48-47ff-91fc-378a8154a2e3",
          "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-01-19T00:58:26.9428922+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-01-19T00:58:26.9428922+00:00"
      },
      "company_id": "bd5300fb-533a-435f-ba1c-c864b590ec64",
      "company_code": "sample string 12",
      "db_address_id": "39085ce9-b992-431a-a2ae-beb0c4fbb6ab",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "a771e1ef-0360-4bac-9f96-ca4a1787f004",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "0c66d377-90db-48f8-a7ed-0b98a45c8b9a",
      "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-01-19T00:58:26.9428922+00:00",
      "date_create": "2026-01-19T00:58:26.9428922+00:00",
      "date_update": "2026-01-19T00:58:26.9428922+00:00",
      "updated_by_user_id": "b74ee902-0fa1-493b-b213-5d01ee23a80d",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-01-19T00:58:26.9428922+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-01-19T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-01-19T00:58:26.9428922+00:00",
      "date_last_job": "2026-01-19T00:58:26.9428922+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-01-19T00:58:26.9428922+00:00",
      "modified_dateutc": "2026-01-19T00:58:26.9428922+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "ed4c4aca-77a9-4b10-b2a0-f19029c8b2b6",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "d865c8b6-4160-4548-bc02-d119a94fc8e1",
      "name": "sample string 2",
      "sales_organization_id": "2805889c-d9b7-449e-a7d4-655479960d5a",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-01-19T00:58:26.9428922+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "281a031d-f159-4bfc-97ca-84cb9f8f6544",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "e563f8d7-20c3-4fba-98d4-0bc4a8c68b94",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "abbf64bb-562d-4315-bab6-93d9fd3b1fbd",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "35a17400-68f7-46fa-942f-5bd1124b106d",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "3d45b574-63ee-4d89-9bc5-9e88ea05d5dd",
        "db_currency_id": "6862961b-ccac-49c1-9757-7734d758a6de",
        "db_language_id": "0d9b28ef-bb48-47ff-91fc-378a8154a2e3",
        "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-01-19T00:58:26.9428922+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-01-19T00:58:26.9428922+00:00"
    },
    "job_status_id": "2f2ab2df-237f-417b-b846-6c679b12effd",
    "job_status_code": "sample string 11",
    "db_address_id": "93f9b13f-5bfd-4090-8c93-61235eb7a3a8",
    "contact_id": "7de2ffe8-f4aa-40fa-bf35-1fbc7a974d9f",
    "requested_by_company_id": "891e3c22-328b-49c3-b648-5423430e18cd",
    "requested_by_contact_id": "ba58ab02-b4b7-4b8c-befb-6515b548ca38",
    "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-01-19T00:58:26.9428922+00:00",
    "due_date": "2026-01-19T00:58:26.9428922+00:00",
    "date_create": "2026-01-19T00:58:26.9428922+00:00",
    "date_update": "2026-01-19T00:58:26.9428922+00:00",
    "date_closed": "2026-01-19T00:58:26.9428922+00:00",
    "suggested_user_id": "56007389-41bd-4e67-b0ba-6397f0c75e17",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "ff62dca1-05f9-4645-99dd-cd9c9878dee1",
      "db_language_id": "3e648595-ac1b-47c8-9fde-e90283eddd07",
      "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-01-19T00:58:26.9428922+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "c8be54b9-9669-4f0b-b56d-7d00cc79d32f",
      "sales_organization": {
        "id": "35a17400-68f7-46fa-942f-5bd1124b106d",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "3d45b574-63ee-4d89-9bc5-9e88ea05d5dd",
        "db_currency_id": "6862961b-ccac-49c1-9757-7734d758a6de",
        "db_language_id": "0d9b28ef-bb48-47ff-91fc-378a8154a2e3",
        "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-01-19T00:58:26.9428922+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "b4c36905-b56b-4835-8307-ce30699d4503",
      "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": "dd6857c2-e445-445e-8d5f-a0662db5d305",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-01-19T00:58:26.9428922+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "1ea2a84e-8e52-40ea-b2ab-06243634876f"
    },
    "suggested_date_start": "2026-01-19T00:58:26.9428922+00:00",
    "skill_id": "f96546ad-84ca-4252-a3ca-c4a56b544de4",
    "skill_code": "sample string 32",
    "skill": {
      "id": "b4ae2bc9-c70b-48b6-a68b-1f00a22f287a",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "2708967c-4b12-419a-893c-f742234103f0",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "35a17400-68f7-46fa-942f-5bd1124b106d",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "3d45b574-63ee-4d89-9bc5-9e88ea05d5dd",
        "db_currency_id": "6862961b-ccac-49c1-9757-7734d758a6de",
        "db_language_id": "0d9b28ef-bb48-47ff-91fc-378a8154a2e3",
        "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-01-19T00:58:26.9428922+00:00"
      },
      "modified_dateutc": "2026-01-19T00:58:26.9428922+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "c6ef81a9-19e4-4d18-bb95-fb084eee0603",
    "date_reported_by_company": "2026-01-19T00:58:26.9428922+00:00",
    "id2": 36,
    "company_id": "da2f5557-38e6-492b-abea-e1ae34da849e",
    "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": "3a7e7880-1e82-414a-9bb7-626341a518e5",
    "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-01-19T00:58:26.9428922+00:00"
  },
  "work_instruction_details_id": "c661cec7-0251-4cbc-bf94-3f4b9ffe31e6",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "e03852d6-5b31-4306-8ca2-d993c4bf5701",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "2d7bc685-8db7-4a4d-86cf-0b7de5a2e90e",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-01-19T00:58:26.9428922+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": "c0cf3623-35b4-4bca-9f46-f67ba4a02db4",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-01-19T00:58:26.9428922+00:00"
}