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": "3f3e630c-8dc7-42e6-898d-6acb284ba254",
  "jobs_id": "461e74a3-9093-4b89-92ad-79fb39d20df9",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "adb0e554-7185-4cba-a5ae-fe680a2bc400",
    "_parent_id": "6843e886-6e7f-4871-b134-14ff99c2782d",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "2daf6584-26fb-4631-8ca4-e1d43e0d0023",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "92bc9aee-5d63-45bc-a1f7-4abf0daa7631",
      "_parent_id": "e89a4356-f7cf-4838-8801-dd27b5cbbbfd",
      "root_parent_id": "7e79aefd-5f8d-4b81-8706-5bb9f7bdf325",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "400131d0-3e28-4b87-a13c-2f58ef12250d",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "9a3c6580-23a9-44c9-bf4a-ffe218575e3a",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "60065fbf-62e2-4683-a5d6-1ca30305afcd",
        "_parent_code": "sample string 6",
        "sales_organization_id": "a62b2201-0900-421e-80a4-b0497c8b9495",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "fa9d6432-ec57-4f78-b75e-afc007c778df",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "2e045555-1e98-4176-906e-b7ca89401d34",
          "db_currency_id": "6d15ddda-08d6-4ce6-8c48-16c8024956a6",
          "db_language_id": "62356ed7-096e-4843-9f83-9d8fc0db0ccb",
          "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-21T12:33:12.6998107+00:00"
        },
        "modified_dateutc": "2026-11-21T12:33:12.6998107+00:00"
      },
      "equipment_model_id": "3a13d9fb-b660-490d-937a-417e748d6770",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "99a8bc9e-4cc8-4729-97ab-1d7644472e37",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "28bde1f9-ee63-4328-ad38-b613431e67e2",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "d17278c4-aed7-4831-83a1-f61d86fcb669",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "e6c40b26-b11e-4545-a760-daf125a76368",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "fa9d6432-ec57-4f78-b75e-afc007c778df",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "2e045555-1e98-4176-906e-b7ca89401d34",
            "db_currency_id": "6d15ddda-08d6-4ce6-8c48-16c8024956a6",
            "db_language_id": "62356ed7-096e-4843-9f83-9d8fc0db0ccb",
            "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-21T12:33:12.6998107+00:00"
          },
          "modified_dateutc": "2026-11-21T12:33:12.6998107+00:00"
        },
        "equipment_family_id": "0cd530ea-8b82-4c8f-86ca-059e26cdffeb",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "9a3c6580-23a9-44c9-bf4a-ffe218575e3a",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "60065fbf-62e2-4683-a5d6-1ca30305afcd",
          "_parent_code": "sample string 6",
          "sales_organization_id": "a62b2201-0900-421e-80a4-b0497c8b9495",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "fa9d6432-ec57-4f78-b75e-afc007c778df",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "2e045555-1e98-4176-906e-b7ca89401d34",
            "db_currency_id": "6d15ddda-08d6-4ce6-8c48-16c8024956a6",
            "db_language_id": "62356ed7-096e-4843-9f83-9d8fc0db0ccb",
            "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-21T12:33:12.6998107+00:00"
          },
          "modified_dateutc": "2026-11-21T12:33:12.6998107+00:00"
        },
        "date_in_production_since": "2026-11-21T12:33:12.6998107+00:00",
        "date_out_of_production_since": "2026-11-21T12:33:12.6998107+00:00",
        "date_end_support": "2026-11-21T12:33:12.6998107+00:00",
        "sales_organization_id": "34657fa4-3a73-4672-b401-da88091478e3",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "fa9d6432-ec57-4f78-b75e-afc007c778df",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "2e045555-1e98-4176-906e-b7ca89401d34",
          "db_currency_id": "6d15ddda-08d6-4ce6-8c48-16c8024956a6",
          "db_language_id": "62356ed7-096e-4843-9f83-9d8fc0db0ccb",
          "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-21T12:33:12.6998107+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-21T12:33:12.6998107+00:00"
      },
      "project_status_id": "757a400c-23f1-48d9-961a-2ce6ee526a3f",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "6597f515-5dde-408b-925d-65ef49978ddb",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "19a2dc3c-8790-4b61-b5df-ab88e4729d99",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "fa9d6432-ec57-4f78-b75e-afc007c778df",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "2e045555-1e98-4176-906e-b7ca89401d34",
          "db_currency_id": "6d15ddda-08d6-4ce6-8c48-16c8024956a6",
          "db_language_id": "62356ed7-096e-4843-9f83-9d8fc0db0ccb",
          "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-21T12:33:12.6998107+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-11-21T12:33:12.6998107+00:00"
      },
      "company_id": "c6025278-0e55-4273-b7b7-69c08cb9c00d",
      "company_code": "sample string 12",
      "db_address_id": "4c26fd8b-f76f-45b7-84a0-7bcb7a7268de",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "78d6f4a3-0af4-4752-bfbe-4efbcf3de228",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "9e495154-8b34-44d3-94c6-5387746d693e",
      "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-21T12:33:12.6998107+00:00",
      "date_create": "2026-11-21T12:33:12.6998107+00:00",
      "date_update": "2026-11-21T12:33:12.6998107+00:00",
      "updated_by_user_id": "fcbf9f14-fd71-4e70-b862-f4323e087cc5",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-11-21T12:33:12.6998107+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-21T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-11-21T12:33:12.6998107+00:00",
      "date_last_job": "2026-11-21T12:33:12.6998107+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-11-21T12:33:12.6998107+00:00",
      "modified_dateutc": "2026-11-21T12:33:12.6998107+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "5b0ab7cb-ebb2-4f41-a780-f5a79922a3e1",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "e4ed6346-9e01-40d6-aec3-e507198a3c54",
      "name": "sample string 2",
      "sales_organization_id": "d3e620a5-9778-4bb2-a28f-57d7da3dc605",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-11-21T12:33:12.6998107+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "e8b9607c-41d1-41b9-a116-06c758014a9c",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "3482b69c-50d2-488d-a825-201dda751dd2",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "a63d01a6-64e5-4dc9-8182-10055c29da39",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "fa9d6432-ec57-4f78-b75e-afc007c778df",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "2e045555-1e98-4176-906e-b7ca89401d34",
        "db_currency_id": "6d15ddda-08d6-4ce6-8c48-16c8024956a6",
        "db_language_id": "62356ed7-096e-4843-9f83-9d8fc0db0ccb",
        "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-21T12:33:12.6998107+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-11-21T12:33:12.6998107+00:00"
    },
    "job_status_id": "b5c91aee-ce77-4942-8da3-a08fb579a63f",
    "job_status_code": "sample string 11",
    "db_address_id": "3f703011-c58a-4603-a2a4-a8208cf5ce11",
    "contact_id": "fd1cd277-89b2-468d-953b-68a6b94c2f8a",
    "requested_by_company_id": "bb0d45db-2172-424f-8130-302c6797564d",
    "requested_by_contact_id": "f4de2e7b-ae3d-4268-90c3-0936e4358882",
    "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-21T12:33:12.6998107+00:00",
    "due_date": "2026-11-21T12:33:12.6998107+00:00",
    "date_create": "2026-11-21T12:33:12.6998107+00:00",
    "date_update": "2026-11-21T12:33:12.6998107+00:00",
    "date_closed": "2026-11-21T12:33:12.6998107+00:00",
    "suggested_user_id": "2fbefad3-0dff-4b3c-8f9c-91b747b9cfed",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "7da023c6-04ef-4c81-9bb4-4f50a4922a87",
      "db_language_id": "ef0d29d7-092f-4575-a9ca-8b8667bbf64f",
      "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-21T12:33:12.6998107+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "89fabe08-98d5-439e-b77c-91e9ed76a6e2",
      "sales_organization": {
        "id": "fa9d6432-ec57-4f78-b75e-afc007c778df",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "2e045555-1e98-4176-906e-b7ca89401d34",
        "db_currency_id": "6d15ddda-08d6-4ce6-8c48-16c8024956a6",
        "db_language_id": "62356ed7-096e-4843-9f83-9d8fc0db0ccb",
        "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-21T12:33:12.6998107+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "f7c0e718-b2cf-4d27-96cf-681558551b66",
      "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": "14aa505e-697c-41b3-a415-facaea39a48f",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-11-21T12:33:12.6998107+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "a5914ce0-4b22-4cef-843c-684a2fe4c367"
    },
    "suggested_date_start": "2026-11-21T12:33:12.6998107+00:00",
    "skill_id": "439a6322-b266-422f-b511-8958f2fad299",
    "skill_code": "sample string 32",
    "skill": {
      "id": "32268faf-89e8-480e-8db0-d34fc05acbe1",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "a6fa3469-3aed-4596-bfbb-0adeff3c5069",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "fa9d6432-ec57-4f78-b75e-afc007c778df",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "2e045555-1e98-4176-906e-b7ca89401d34",
        "db_currency_id": "6d15ddda-08d6-4ce6-8c48-16c8024956a6",
        "db_language_id": "62356ed7-096e-4843-9f83-9d8fc0db0ccb",
        "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-21T12:33:12.6998107+00:00"
      },
      "modified_dateutc": "2026-11-21T12:33:12.7196453+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "5bc3077a-a7aa-4ee6-a244-8cd4a16a8097",
    "date_reported_by_company": "2026-11-21T12:33:12.7196453+00:00",
    "id2": 36,
    "company_id": "5a57bf8e-61e7-4ae7-a6ae-deebeadb2e52",
    "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": "5faf9f5c-2b16-4cf3-a952-d4b0b8503c60",
    "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-21T12:33:12.7196453+00:00"
  },
  "work_instruction_details_id": "09ec08be-fcfe-4508-bdf5-05459375aeef",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "4a932a2f-ae87-41e2-891a-3e3ede692793",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "01786d93-9d0e-4490-b6a6-a9cf9fa6cad2",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-11-21T12:33:12.7196453+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": "25951ef3-3470-41c8-a4a0-3941f07bddab",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-11-21T12:33:12.7196453+00:00"
}