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": "9143d6e2-92f5-4859-b457-a8a1fa4f0290",
  "jobs_id": "809fa15a-7eaa-4f10-9b5b-e38c83e5b5dc",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "e512a543-49de-4ca2-a0b9-b0b944bd8a6c",
    "_parent_id": "7d7612da-724b-4623-8ab4-4b5ca7974d5b",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "7b5c91c9-098f-437a-ba13-9c479de334a3",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "89060f47-08c3-40ee-88cb-a2b5b87e5b04",
      "_parent_id": "64541e46-8ff8-4602-ad7c-1c8c18e5dc15",
      "root_parent_id": "900dcc01-e25c-4d9a-9758-ab7ad4267848",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "f6e1eb56-9850-43eb-b226-6f10cece78f2",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "12e01229-736b-4d4e-9a08-ea7b6c266cd3",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "4ae08136-77f9-459e-8b95-48fe564aa10f",
        "_parent_code": "sample string 6",
        "sales_organization_id": "e996681d-d185-42aa-bfc8-ab9b0d49f283",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "25798a52-7ef3-4487-8ee7-2b8ba99ecfe0",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "bee1d39d-9fb3-4120-ac98-037d1357f68c",
          "db_currency_id": "2a766781-e046-48a3-a867-f881d103ba63",
          "db_language_id": "0b313855-1716-4383-bec2-6627e8322070",
          "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-07-08T06:47:24.0010222+00:00"
        },
        "modified_dateutc": "2025-07-08T06:47:24.0010222+00:00"
      },
      "equipment_model_id": "17b886fd-fea3-4460-b07a-68da472d9485",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "80112913-1abc-41cd-b91a-dcbe9b58ec58",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "9176dfef-c9f2-4d08-9ae4-88876ba9b248",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "9874d79f-ade5-4c57-a5a5-3ab5ee9d7575",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "f8828f00-5732-4faf-af1c-d332a5c9cc03",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "25798a52-7ef3-4487-8ee7-2b8ba99ecfe0",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "bee1d39d-9fb3-4120-ac98-037d1357f68c",
            "db_currency_id": "2a766781-e046-48a3-a867-f881d103ba63",
            "db_language_id": "0b313855-1716-4383-bec2-6627e8322070",
            "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-07-08T06:47:24.0010222+00:00"
          },
          "modified_dateutc": "2025-07-08T06:47:24.0010222+00:00"
        },
        "equipment_family_id": "42eb9c75-26e7-4fa8-bdec-5a6245d3f44d",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "12e01229-736b-4d4e-9a08-ea7b6c266cd3",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "4ae08136-77f9-459e-8b95-48fe564aa10f",
          "_parent_code": "sample string 6",
          "sales_organization_id": "e996681d-d185-42aa-bfc8-ab9b0d49f283",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "25798a52-7ef3-4487-8ee7-2b8ba99ecfe0",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "bee1d39d-9fb3-4120-ac98-037d1357f68c",
            "db_currency_id": "2a766781-e046-48a3-a867-f881d103ba63",
            "db_language_id": "0b313855-1716-4383-bec2-6627e8322070",
            "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-07-08T06:47:24.0010222+00:00"
          },
          "modified_dateutc": "2025-07-08T06:47:24.0010222+00:00"
        },
        "date_in_production_since": "2025-07-08T06:47:24.0010222+00:00",
        "date_out_of_production_since": "2025-07-08T06:47:24.0010222+00:00",
        "date_end_support": "2025-07-08T06:47:24.0010222+00:00",
        "sales_organization_id": "9b9008dd-867b-46dd-9e0b-4ae3794a22ff",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "25798a52-7ef3-4487-8ee7-2b8ba99ecfe0",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "bee1d39d-9fb3-4120-ac98-037d1357f68c",
          "db_currency_id": "2a766781-e046-48a3-a867-f881d103ba63",
          "db_language_id": "0b313855-1716-4383-bec2-6627e8322070",
          "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-07-08T06:47:24.0010222+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-07-08T06:47:24.0010222+00:00"
      },
      "project_status_id": "bd5fea94-c6ef-4097-aabd-56e3bb4eefe8",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "451282ee-7e9c-47ad-94df-cb5e26199013",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "251ae2b8-dedf-45a8-88d1-2acfda0a4041",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "25798a52-7ef3-4487-8ee7-2b8ba99ecfe0",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "bee1d39d-9fb3-4120-ac98-037d1357f68c",
          "db_currency_id": "2a766781-e046-48a3-a867-f881d103ba63",
          "db_language_id": "0b313855-1716-4383-bec2-6627e8322070",
          "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-07-08T06:47:24.0010222+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2025-07-08T06:47:24.0010222+00:00"
      },
      "company_id": "6cb58d1a-1643-41bb-b33d-7cafa53a5c7d",
      "company_code": "sample string 12",
      "db_address_id": "033f0daa-d2e7-4cfd-97db-74886c5630f3",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "1ba270e9-b95f-4aa1-a0eb-6181726e8ea4",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "3017b27d-252a-414a-9f80-adb0041fc524",
      "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-07-08T06:47:24.0010222+00:00",
      "date_create": "2025-07-08T06:47:24.0010222+00:00",
      "date_update": "2025-07-08T06:47:24.0010222+00:00",
      "updated_by_user_id": "8d060085-e4c2-4018-88b0-56aeacb5f220",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2025-07-08T06:47:24.0010222+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-07-08T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2025-07-08T06:47:24.0010222+00:00",
      "date_last_job": "2025-07-08T06:47:24.0010222+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2025-07-08T06:47:24.0010222+00:00",
      "modified_dateutc": "2025-07-08T06:47:24.0010222+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "636814fd-9b79-4687-a7a0-ef205db720d8",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "57d3522f-cdef-401f-bc67-bdd353ad22ef",
      "name": "sample string 2",
      "sales_organization_id": "f1a05dc4-69a9-470a-a301-38b0a0e8ec25",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2025-07-08T06:47:24.0010222+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "c8f99e74-d494-42bd-8253-bad8708e1be1",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "bb539836-ce7e-426d-8e6f-6e6e1592e5be",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "e3b75b40-f9af-4c20-8761-182da4ba4c94",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "25798a52-7ef3-4487-8ee7-2b8ba99ecfe0",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "bee1d39d-9fb3-4120-ac98-037d1357f68c",
        "db_currency_id": "2a766781-e046-48a3-a867-f881d103ba63",
        "db_language_id": "0b313855-1716-4383-bec2-6627e8322070",
        "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-07-08T06:47:24.0010222+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2025-07-08T06:47:24.0010222+00:00"
    },
    "job_status_id": "8ad692df-17af-4b5a-ac23-913fceece900",
    "job_status_code": "sample string 11",
    "db_address_id": "0e209b2e-f66f-43b1-bf54-3f6cb275b646",
    "contact_id": "9e94eb6e-eff8-45ec-ac61-a84c699380e2",
    "requested_by_company_id": "cea2bc96-97d3-4578-bb67-e6249d2f1e67",
    "requested_by_contact_id": "d1200ca6-1aea-46a3-8581-38c067333e14",
    "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-07-08T06:47:24.0010222+00:00",
    "due_date": "2025-07-08T06:47:24.0010222+00:00",
    "date_create": "2025-07-08T06:47:24.0010222+00:00",
    "date_update": "2025-07-08T06:47:24.0010222+00:00",
    "date_closed": "2025-07-08T06:47:24.0010222+00:00",
    "suggested_user_id": "524a76ba-0d9a-4c6f-a133-222e8221bf33",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "ec9dc10b-b65b-4c4d-a2c5-7c48b9d65b14",
      "db_language_id": "1fb35d7d-333f-4e20-aaea-424734a6140a",
      "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-07-08T06:47:24.0010222+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "443c1f76-44d8-4e0f-a95a-de2945a391fe",
      "sales_organization": {
        "id": "25798a52-7ef3-4487-8ee7-2b8ba99ecfe0",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "bee1d39d-9fb3-4120-ac98-037d1357f68c",
        "db_currency_id": "2a766781-e046-48a3-a867-f881d103ba63",
        "db_language_id": "0b313855-1716-4383-bec2-6627e8322070",
        "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-07-08T06:47:24.0010222+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "85a7d2d4-035f-495f-bb42-9ac88bfc4d88",
      "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": "8b9b3c4c-080f-4af1-ba2f-7e322599e556",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2025-07-08T06:47:24.0010222+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "941528cb-331e-417e-ae90-d83b21724697"
    },
    "suggested_date_start": "2025-07-08T06:47:24.0010222+00:00",
    "skill_id": "a88637f8-fe33-4cbc-a6e7-b114c66792c8",
    "skill_code": "sample string 32",
    "skill": {
      "id": "461d94df-83e1-4f1a-b518-3a812e4fb569",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "9a55d5b1-1601-4676-91bc-9233722ffbea",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "25798a52-7ef3-4487-8ee7-2b8ba99ecfe0",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "bee1d39d-9fb3-4120-ac98-037d1357f68c",
        "db_currency_id": "2a766781-e046-48a3-a867-f881d103ba63",
        "db_language_id": "0b313855-1716-4383-bec2-6627e8322070",
        "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-07-08T06:47:24.0010222+00:00"
      },
      "modified_dateutc": "2025-07-08T06:47:24.0010222+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "ec07f342-a138-43b6-84c2-c2fb6410582b",
    "date_reported_by_company": "2025-07-08T06:47:24.0010222+00:00",
    "id2": 36,
    "company_id": "de0e7a3f-9e36-459c-8fa8-2dbb28c47fab",
    "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": "82f6308c-4751-4cbc-9f3c-a9d5ad960bdd",
    "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-07-08T06:47:24.0010222+00:00"
  },
  "work_instruction_details_id": "24e6cd8d-2f02-41c3-8bb3-cc3b1f01e9c6",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "59c2fd46-9e80-4048-8467-ba5af4ebbdf4",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "8f1cfa4c-eb5b-4c7a-92ba-c745a3cef845",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2025-07-08T06:47:24.0010222+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": "14e46958-cf17-4171-bf0a-9816df6f3e15",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2025-07-08T06:47:24.0010222+00:00"
}