Retrieves the job work instruction list with the specified key.

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

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": "3b800b55-dcc2-4908-8844-fcf141b048f3",
  "jobs_id": "bd94bed4-6842-4cfd-8e1e-1fd94a18a742",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "2ea7c66a-ae09-45cd-bf1e-3ce599d42a42",
    "_parent_id": "fa16534e-1c74-45a2-bd75-57c42a925bf3",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "273012a0-e23a-4c3d-b800-893addb44b95",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "e3bf515c-6a30-463a-a961-bb1865b703bf",
      "_parent_id": "e50be8fd-4977-4273-8123-7dbf0d8ac597",
      "root_parent_id": "a5e3bb21-4d49-4a9e-8a27-7ea15b526228",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "4025115c-5b93-432d-9d1b-65931a455b2c",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "9e5ab27d-bb84-4725-8004-ddee3c0a1105",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "392fffc0-9d32-4a90-9bb1-e987b445d982",
        "_parent_code": "sample string 6",
        "sales_organization_id": "ae70d296-db49-4e99-a9fd-dd0ab0283965",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "bc4ccfa9-07ad-44c3-9c03-ca1d666425ad",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "4f40e46f-1734-4368-a350-91ceb723788f",
          "db_currency_id": "e2b3bf84-24f0-46d1-b95b-32d1d2497ad3",
          "db_language_id": "6ddde658-4e04-479a-85f3-ecea8c473227",
          "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-16T16:30:33.4663713+00:00"
        },
        "modified_dateutc": "2026-11-16T16:30:33.4663713+00:00"
      },
      "equipment_model_id": "85c8da45-45ba-4cb7-800c-0ce4e00075a8",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "f2346716-e887-4e1e-b15e-f99fd0a16e9a",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "bae70c2a-2dfb-4ab5-aa84-0c2deec99122",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "cd848cb4-4e95-4325-9108-81dbc044e732",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "8a911f9b-b76e-4daa-ad70-3ddad5374d00",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "bc4ccfa9-07ad-44c3-9c03-ca1d666425ad",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "4f40e46f-1734-4368-a350-91ceb723788f",
            "db_currency_id": "e2b3bf84-24f0-46d1-b95b-32d1d2497ad3",
            "db_language_id": "6ddde658-4e04-479a-85f3-ecea8c473227",
            "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-16T16:30:33.4663713+00:00"
          },
          "modified_dateutc": "2026-11-16T16:30:33.4663713+00:00"
        },
        "equipment_family_id": "249ab3d6-dba8-4b39-97cc-7f2720b255bc",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "9e5ab27d-bb84-4725-8004-ddee3c0a1105",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "392fffc0-9d32-4a90-9bb1-e987b445d982",
          "_parent_code": "sample string 6",
          "sales_organization_id": "ae70d296-db49-4e99-a9fd-dd0ab0283965",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "bc4ccfa9-07ad-44c3-9c03-ca1d666425ad",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "4f40e46f-1734-4368-a350-91ceb723788f",
            "db_currency_id": "e2b3bf84-24f0-46d1-b95b-32d1d2497ad3",
            "db_language_id": "6ddde658-4e04-479a-85f3-ecea8c473227",
            "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-16T16:30:33.4663713+00:00"
          },
          "modified_dateutc": "2026-11-16T16:30:33.4663713+00:00"
        },
        "date_in_production_since": "2026-11-16T16:30:33.4663713+00:00",
        "date_out_of_production_since": "2026-11-16T16:30:33.4663713+00:00",
        "date_end_support": "2026-11-16T16:30:33.4663713+00:00",
        "sales_organization_id": "59bb3bd9-e2f2-4e82-9586-6927c97a3bde",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "bc4ccfa9-07ad-44c3-9c03-ca1d666425ad",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "4f40e46f-1734-4368-a350-91ceb723788f",
          "db_currency_id": "e2b3bf84-24f0-46d1-b95b-32d1d2497ad3",
          "db_language_id": "6ddde658-4e04-479a-85f3-ecea8c473227",
          "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-16T16:30:33.4663713+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-16T16:30:33.4663713+00:00"
      },
      "project_status_id": "3d48fad7-0776-4b8c-a718-4980a5502ae0",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "23fb4620-c5e8-4916-9f80-de5ee102b397",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "f7d2b7d7-7da4-4112-a547-73c11ccfabfd",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "bc4ccfa9-07ad-44c3-9c03-ca1d666425ad",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "4f40e46f-1734-4368-a350-91ceb723788f",
          "db_currency_id": "e2b3bf84-24f0-46d1-b95b-32d1d2497ad3",
          "db_language_id": "6ddde658-4e04-479a-85f3-ecea8c473227",
          "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-16T16:30:33.4663713+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-11-16T16:30:33.4663713+00:00"
      },
      "company_id": "4005b122-9361-431a-98de-c07f41da59cb",
      "company_code": "sample string 12",
      "db_address_id": "92b6ba36-eb68-4303-ad45-ea9a930f5193",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "d35a1f39-4fa5-4ece-91b8-276ceef60f31",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "a26f819b-c0e9-4768-b41d-b92e628d4e5e",
      "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-16T16:30:33.4663713+00:00",
      "date_create": "2026-11-16T16:30:33.4663713+00:00",
      "date_update": "2026-11-16T16:30:33.4663713+00:00",
      "updated_by_user_id": "d15c2f17-d676-46a0-b1ab-01e034304208",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-11-16T16:30:33.4663713+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-16T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-11-16T16:30:33.4663713+00:00",
      "date_last_job": "2026-11-16T16:30:33.4663713+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-11-16T16:30:33.4663713+00:00",
      "modified_dateutc": "2026-11-16T16:30:33.4663713+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "eddcdced-513c-4b1a-827b-ea98171ae83b",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "7771a2c4-e5b4-4439-bcdf-26f225ee4544",
      "name": "sample string 2",
      "sales_organization_id": "c8ee5768-c641-4bf2-af37-f9903444612f",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-11-16T16:30:33.4663713+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "125008fb-8c29-4389-9e0c-639878d0d9b8",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "c121d3e7-df5d-4f8e-829b-026aa8a99094",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "953ba036-214c-43bb-8236-54d10c3cc0d0",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "bc4ccfa9-07ad-44c3-9c03-ca1d666425ad",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "4f40e46f-1734-4368-a350-91ceb723788f",
        "db_currency_id": "e2b3bf84-24f0-46d1-b95b-32d1d2497ad3",
        "db_language_id": "6ddde658-4e04-479a-85f3-ecea8c473227",
        "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-16T16:30:33.4663713+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-11-16T16:30:33.4663713+00:00"
    },
    "job_status_id": "d3441f32-04c9-4b00-8439-7426095f3aba",
    "job_status_code": "sample string 11",
    "db_address_id": "bf01ffce-7770-446a-8a1b-54564df202bf",
    "contact_id": "bcf220d6-2123-4ac7-94d2-d9bf49cd5d10",
    "requested_by_company_id": "4e5ec100-d0e5-48f3-9d20-bd46b456da33",
    "requested_by_contact_id": "ef34b8d6-59ec-483f-905e-8dc5232acd71",
    "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-16T16:30:33.4663713+00:00",
    "due_date": "2026-11-16T16:30:33.4663713+00:00",
    "date_create": "2026-11-16T16:30:33.4663713+00:00",
    "date_update": "2026-11-16T16:30:33.4663713+00:00",
    "date_closed": "2026-11-16T16:30:33.4663713+00:00",
    "suggested_user_id": "3b15ff74-7e3c-492a-981c-09189a82be7b",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "519ee536-0700-4142-b7c0-bb0d3177ea60",
      "db_language_id": "b5380dd0-10f0-4f52-b3e5-33289bbf3d94",
      "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-16T16:30:33.4663713+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "9268ff26-b41b-4e35-a38c-7beb31072b05",
      "sales_organization": {
        "id": "bc4ccfa9-07ad-44c3-9c03-ca1d666425ad",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "4f40e46f-1734-4368-a350-91ceb723788f",
        "db_currency_id": "e2b3bf84-24f0-46d1-b95b-32d1d2497ad3",
        "db_language_id": "6ddde658-4e04-479a-85f3-ecea8c473227",
        "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-16T16:30:33.4663713+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "d53341ea-dc8a-4aac-a325-52dc731ce42e",
      "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": "0bb9431a-0efe-42f0-8393-ce421af511d6",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-11-16T16:30:33.4663713+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "7b9db21d-bde3-4658-b5c9-e9c8fcf9c49b"
    },
    "suggested_date_start": "2026-11-16T16:30:33.4663713+00:00",
    "skill_id": "99ad5a58-38f5-42ab-a4b6-ec35c92ed8c8",
    "skill_code": "sample string 32",
    "skill": {
      "id": "0ab209f1-057a-47cf-9044-f24081af14c0",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "03b5bf61-39de-4325-9812-42dcba86d563",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "bc4ccfa9-07ad-44c3-9c03-ca1d666425ad",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "4f40e46f-1734-4368-a350-91ceb723788f",
        "db_currency_id": "e2b3bf84-24f0-46d1-b95b-32d1d2497ad3",
        "db_language_id": "6ddde658-4e04-479a-85f3-ecea8c473227",
        "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-16T16:30:33.4663713+00:00"
      },
      "modified_dateutc": "2026-11-16T16:30:33.4663713+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "374cc9d6-a65c-4b7e-aa4f-90beba2c6dc6",
    "date_reported_by_company": "2026-11-16T16:30:33.4663713+00:00",
    "id2": 36,
    "company_id": "ffc9afc7-1d7f-43dd-b282-1057ae714080",
    "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": "82e78187-f0a6-4df1-8d9a-1ed1870baff4",
    "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-16T16:30:33.4663713+00:00"
  },
  "work_instruction_details_id": "8ae4ef29-9ed4-4131-9666-1be160524d25",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "772397b4-9d8a-41e4-a7fd-08f4b5c1dd0d",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "ebfe76f7-4aaf-4e72-b435-b3bfc0b597b9",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-11-16T16:30:33.4663713+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": "ccac07c9-a1f3-4a6a-901e-f1bfcdd97ee0",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-11-16T16:30:33.4663713+00:00"
}