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": "0571f1cd-dbb8-4bb9-88bb-7021f71ea68d",
  "jobs_id": "6c499f29-8ad5-42d5-812c-eec4b74ab214",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "96b2fb48-d409-47cb-b932-a3d4282dfd6e",
    "_parent_id": "1344e839-2fe8-40cf-b4e5-8dff87dab434",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "d87204c4-be1d-4408-b438-60a269f21dea",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "f9548e31-da20-4b18-956b-8141fc818f90",
      "_parent_id": "c8f88c4b-5db6-4d61-87a5-2684148ef2b1",
      "root_parent_id": "202a6848-6ec8-4730-8444-6060d6a33212",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "c7f73421-3bc2-44dd-8f21-8c0e28c9544f",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "7a8d0799-25cf-4bc1-bc02-52d7cd8793f2",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "ba530e63-9ef1-4e16-b6da-fd482ca649f9",
        "_parent_code": "sample string 6",
        "sales_organization_id": "5a3e508b-4d4a-4232-be07-cc411fc889c0",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "4a510b34-602e-497e-8300-61722d2deff1",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "9e49decc-7a8d-448a-8d6a-52cfaabf81f9",
          "db_currency_id": "9c865f57-d246-46bb-90c9-fb3b92910a37",
          "db_language_id": "cd3e7d45-88d7-4c47-b6c4-1606b9a54954",
          "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": "2025-12-19T01:10:32.6730845+00:00"
        },
        "modified_dateutc": "2025-12-19T01:10:32.6730845+00:00"
      },
      "equipment_model_id": "ef9f19e9-8871-44d7-9b20-54a5d1bd9ac7",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "fbd53021-8302-4e4c-b666-bf7cd022a486",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "07e415b5-a418-4953-a600-bdfd3037c0c9",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "81a1f5f9-3650-4253-842c-9922d7cd0e55",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "024d4d75-64d9-43bc-a8f8-e018cfd31335",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "4a510b34-602e-497e-8300-61722d2deff1",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "9e49decc-7a8d-448a-8d6a-52cfaabf81f9",
            "db_currency_id": "9c865f57-d246-46bb-90c9-fb3b92910a37",
            "db_language_id": "cd3e7d45-88d7-4c47-b6c4-1606b9a54954",
            "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": "2025-12-19T01:10:32.6730845+00:00"
          },
          "modified_dateutc": "2025-12-19T01:10:32.6730845+00:00"
        },
        "equipment_family_id": "fe778412-f832-496e-b3d5-b4d5c3280151",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "7a8d0799-25cf-4bc1-bc02-52d7cd8793f2",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "ba530e63-9ef1-4e16-b6da-fd482ca649f9",
          "_parent_code": "sample string 6",
          "sales_organization_id": "5a3e508b-4d4a-4232-be07-cc411fc889c0",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "4a510b34-602e-497e-8300-61722d2deff1",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "9e49decc-7a8d-448a-8d6a-52cfaabf81f9",
            "db_currency_id": "9c865f57-d246-46bb-90c9-fb3b92910a37",
            "db_language_id": "cd3e7d45-88d7-4c47-b6c4-1606b9a54954",
            "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": "2025-12-19T01:10:32.6730845+00:00"
          },
          "modified_dateutc": "2025-12-19T01:10:32.6730845+00:00"
        },
        "date_in_production_since": "2025-12-19T01:10:32.6730845+00:00",
        "date_out_of_production_since": "2025-12-19T01:10:32.6730845+00:00",
        "date_end_support": "2025-12-19T01:10:32.6730845+00:00",
        "sales_organization_id": "e54bf490-b689-49f3-bd10-f148fae98ed6",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "4a510b34-602e-497e-8300-61722d2deff1",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "9e49decc-7a8d-448a-8d6a-52cfaabf81f9",
          "db_currency_id": "9c865f57-d246-46bb-90c9-fb3b92910a37",
          "db_language_id": "cd3e7d45-88d7-4c47-b6c4-1606b9a54954",
          "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": "2025-12-19T01:10:32.6730845+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": "2025-12-19T01:10:32.6730845+00:00"
      },
      "project_status_id": "82433b53-34db-459a-8b17-87d0abc0d61b",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "dd17de0a-763f-413c-9a04-b90b802f482e",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "a14a4d17-f9be-4691-b3a9-20dd07e44fc9",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "4a510b34-602e-497e-8300-61722d2deff1",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "9e49decc-7a8d-448a-8d6a-52cfaabf81f9",
          "db_currency_id": "9c865f57-d246-46bb-90c9-fb3b92910a37",
          "db_language_id": "cd3e7d45-88d7-4c47-b6c4-1606b9a54954",
          "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": "2025-12-19T01:10:32.6730845+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2025-12-19T01:10:32.6730845+00:00"
      },
      "company_id": "1ec14794-3a78-4316-9725-60b9a318f9b0",
      "company_code": "sample string 12",
      "db_address_id": "f9a7e0b5-89dc-4960-82be-165b39b5c9b0",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "0ea1558f-8864-4f2d-8ad1-007f8f9ec42e",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "339a9d54-7329-48cb-87fb-48b6edbc76a2",
      "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": "2025-12-19T01:10:32.6730845+00:00",
      "date_create": "2025-12-19T01:10:32.6730845+00:00",
      "date_update": "2025-12-19T01:10:32.6730845+00:00",
      "updated_by_user_id": "4d30be4e-9a89-46c9-bddb-05b51080dbe2",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2025-12-19T01:10:32.6730845+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": "2025-12-19T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2025-12-19T01:10:32.6730845+00:00",
      "date_last_job": "2025-12-19T01:10:32.6730845+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2025-12-19T01:10:32.6730845+00:00",
      "modified_dateutc": "2025-12-19T01:10:32.6730845+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "1063985b-0902-49ec-87c1-6efe71d5ebf0",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "40b8cd19-5ae3-4ab8-a55c-14eb10b3fa45",
      "name": "sample string 2",
      "sales_organization_id": "663f8df0-a281-4c62-8c0a-fef74fb5f4ce",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2025-12-19T01:10:32.6730845+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "9f90afbd-7920-45a3-9f4e-9cbe2650580f",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "ab17e76a-cf2a-47ff-bc86-e85909f9ca52",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "f63f1a0f-b541-4201-9599-a84113c935f4",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "4a510b34-602e-497e-8300-61722d2deff1",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "9e49decc-7a8d-448a-8d6a-52cfaabf81f9",
        "db_currency_id": "9c865f57-d246-46bb-90c9-fb3b92910a37",
        "db_language_id": "cd3e7d45-88d7-4c47-b6c4-1606b9a54954",
        "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": "2025-12-19T01:10:32.6730845+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2025-12-19T01:10:32.6730845+00:00"
    },
    "job_status_id": "65873872-ba8e-4691-9a0d-7c76662da64b",
    "job_status_code": "sample string 11",
    "db_address_id": "848eed02-1ace-4323-a6c1-357600809343",
    "contact_id": "cc9223c6-7efb-4de9-9c65-4e4a91decc12",
    "requested_by_company_id": "e5d16aff-cf2b-4b03-995e-65f837218e1b",
    "requested_by_contact_id": "8a7a3939-0b0e-4f3e-99ee-db2853001068",
    "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": "2025-12-19T01:10:32.6730845+00:00",
    "due_date": "2025-12-19T01:10:32.6730845+00:00",
    "date_create": "2025-12-19T01:10:32.6730845+00:00",
    "date_update": "2025-12-19T01:10:32.6730845+00:00",
    "date_closed": "2025-12-19T01:10:32.6730845+00:00",
    "suggested_user_id": "385dc185-1081-4393-884a-842441da7cb2",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "1f4d8821-3797-467e-808c-00cac41840fa",
      "db_language_id": "e9d8bdff-3b90-430a-aa17-7788f558a481",
      "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": "2025-12-19T01:10:32.6730845+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "765e7588-8432-4a25-ac4a-6b897f04fd7d",
      "sales_organization": {
        "id": "4a510b34-602e-497e-8300-61722d2deff1",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "9e49decc-7a8d-448a-8d6a-52cfaabf81f9",
        "db_currency_id": "9c865f57-d246-46bb-90c9-fb3b92910a37",
        "db_language_id": "cd3e7d45-88d7-4c47-b6c4-1606b9a54954",
        "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": "2025-12-19T01:10:32.6730845+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "23aaf0f6-921b-42ce-9e1e-b990df81c97e",
      "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": "075c0545-6b0e-41ee-b339-eae875b312c4",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2025-12-19T01:10:32.6730845+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "4f15baa9-1e89-4c10-bc00-274df1a29310"
    },
    "suggested_date_start": "2025-12-19T01:10:32.6730845+00:00",
    "skill_id": "4f47cd83-e4c1-4e09-8626-eb940d023a7b",
    "skill_code": "sample string 32",
    "skill": {
      "id": "61b56062-9685-4fcc-bc2a-921c28adc7e5",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "03aae028-5d9c-4032-8653-6b6355743ec9",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "4a510b34-602e-497e-8300-61722d2deff1",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "9e49decc-7a8d-448a-8d6a-52cfaabf81f9",
        "db_currency_id": "9c865f57-d246-46bb-90c9-fb3b92910a37",
        "db_language_id": "cd3e7d45-88d7-4c47-b6c4-1606b9a54954",
        "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": "2025-12-19T01:10:32.6730845+00:00"
      },
      "modified_dateutc": "2025-12-19T01:10:32.6730845+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "e1eba8c5-f2d8-4cfc-861b-dffb72594524",
    "date_reported_by_company": "2025-12-19T01:10:32.6730845+00:00",
    "id2": 36,
    "company_id": "f4c4174d-da89-442f-885f-4bf51aab1381",
    "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": "51c68446-cd89-4889-8fac-c22bc2e781d4",
    "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": "2025-12-19T01:10:32.6730845+00:00"
  },
  "work_instruction_details_id": "65873cd2-aaba-4592-a3e8-a12c995f8058",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "9eddbfbd-5570-475e-bdf6-1bb77e69f087",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "7be74ba1-ad46-4d9f-a8db-c24a1506c356",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2025-12-19T01:10:32.6730845+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": "89a9cb3e-cecf-4dbd-b1d1-8eaa5bdb239e",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2025-12-19T01:10:32.6730845+00:00"
}