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": "e678d29b-03fa-4749-803a-aa5ef05b8db5",
  "jobs_id": "03abb9e9-a439-407a-ae7d-8096a396c866",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "06e7d1f4-8c0f-4779-8b1b-f08731f60d3f",
    "_parent_id": "d59d344f-7264-4b47-ad89-892c8da6ddd4",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "0f18d067-bdf2-402b-8f97-90983a84dd07",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "5ca3c74b-cceb-4711-9c1d-673a0616e91e",
      "_parent_id": "84cb8ab9-7e46-474e-a33b-77add0ac255c",
      "root_parent_id": "056e0072-6cbf-42e3-851f-385bc3b74c0c",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "431e98c8-a712-40c5-a5af-6de4f0c8f055",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "472634ff-a2d9-4e9c-a8b3-b42b31a769c5",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "270f8333-76ab-4f7f-a929-26fde1e4e52b",
        "_parent_code": "sample string 6",
        "sales_organization_id": "2de31817-288d-4843-a204-c4ab81b281a9",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "4f46d6ec-5d21-4b8a-bca0-108a2f7eda44",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "1fc128bf-64ee-4a0a-949f-b5dd4a3eb8e5",
          "db_currency_id": "9800815d-cf4b-4130-8cc8-d161f21be487",
          "db_language_id": "8853e893-2722-4bab-998b-97bffa946316",
          "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-18T23:39:00.2149317+00:00"
        },
        "modified_dateutc": "2025-07-18T23:39:00.2149317+00:00"
      },
      "equipment_model_id": "33ff3cb7-1032-4c92-a71a-736d949461a4",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "466c1c59-611e-407b-a52f-28e9d32f2c2e",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "3c6b867b-8a12-479d-a206-0f9274723799",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "c6bc28ec-4dfc-4d73-87e3-5e6f11e5fbe2",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "db5e1ec0-867f-4e04-9679-f1d748129438",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "4f46d6ec-5d21-4b8a-bca0-108a2f7eda44",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "1fc128bf-64ee-4a0a-949f-b5dd4a3eb8e5",
            "db_currency_id": "9800815d-cf4b-4130-8cc8-d161f21be487",
            "db_language_id": "8853e893-2722-4bab-998b-97bffa946316",
            "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-18T23:39:00.2149317+00:00"
          },
          "modified_dateutc": "2025-07-18T23:39:00.2149317+00:00"
        },
        "equipment_family_id": "cce4cc5e-6bd2-49eb-a7b3-89ee7b427933",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "472634ff-a2d9-4e9c-a8b3-b42b31a769c5",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "270f8333-76ab-4f7f-a929-26fde1e4e52b",
          "_parent_code": "sample string 6",
          "sales_organization_id": "2de31817-288d-4843-a204-c4ab81b281a9",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "4f46d6ec-5d21-4b8a-bca0-108a2f7eda44",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "1fc128bf-64ee-4a0a-949f-b5dd4a3eb8e5",
            "db_currency_id": "9800815d-cf4b-4130-8cc8-d161f21be487",
            "db_language_id": "8853e893-2722-4bab-998b-97bffa946316",
            "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-18T23:39:00.2149317+00:00"
          },
          "modified_dateutc": "2025-07-18T23:39:00.2149317+00:00"
        },
        "date_in_production_since": "2025-07-18T23:39:00.2149317+00:00",
        "date_out_of_production_since": "2025-07-18T23:39:00.2149317+00:00",
        "date_end_support": "2025-07-18T23:39:00.2149317+00:00",
        "sales_organization_id": "0058fddd-bf34-44a6-bf57-9505795dbf84",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "4f46d6ec-5d21-4b8a-bca0-108a2f7eda44",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "1fc128bf-64ee-4a0a-949f-b5dd4a3eb8e5",
          "db_currency_id": "9800815d-cf4b-4130-8cc8-d161f21be487",
          "db_language_id": "8853e893-2722-4bab-998b-97bffa946316",
          "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-18T23:39:00.2149317+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-18T23:39:00.2149317+00:00"
      },
      "project_status_id": "a36497f4-4577-4bff-84cc-a639f88a0e6f",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "a8420299-93fb-4cf7-b9c0-ba90a4784fe1",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "1c94eb14-a4c3-4bae-9b23-cbd5c6b9aae7",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "4f46d6ec-5d21-4b8a-bca0-108a2f7eda44",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "1fc128bf-64ee-4a0a-949f-b5dd4a3eb8e5",
          "db_currency_id": "9800815d-cf4b-4130-8cc8-d161f21be487",
          "db_language_id": "8853e893-2722-4bab-998b-97bffa946316",
          "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-18T23:39:00.2149317+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2025-07-18T23:39:00.2149317+00:00"
      },
      "company_id": "057f8fc8-491e-46ff-9a84-5d26755df416",
      "company_code": "sample string 12",
      "db_address_id": "266217ae-506c-435d-9e06-9624628c57e7",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "26c856d7-3bc5-4e51-b52d-fbabcb66c262",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "dbe79898-1ae9-405c-9768-90d9f9c57b15",
      "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-18T23:39:00.2149317+00:00",
      "date_create": "2025-07-18T23:39:00.2149317+00:00",
      "date_update": "2025-07-18T23:39:00.2149317+00:00",
      "updated_by_user_id": "eb785adb-52e3-4192-88ae-c88458397bac",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2025-07-18T23:39:00.2149317+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-18T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2025-07-18T23:39:00.2149317+00:00",
      "date_last_job": "2025-07-18T23:39:00.2149317+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2025-07-18T23:39:00.2149317+00:00",
      "modified_dateutc": "2025-07-18T23:39:00.2149317+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "a80f8806-8dce-42a5-a1d2-0474781271c0",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "c399d989-92d1-4976-adbc-c585e43cb3fd",
      "name": "sample string 2",
      "sales_organization_id": "d493dd81-95f3-4f3c-a51d-6792460f4414",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2025-07-18T23:39:00.2149317+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "4ccbdbbf-5925-4d22-a250-76a43e74787d",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "2168c962-2ed3-43aa-8a38-7a6b3fb795c6",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "eab15bd7-8c7c-4643-91b5-5bba418e62c8",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "4f46d6ec-5d21-4b8a-bca0-108a2f7eda44",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "1fc128bf-64ee-4a0a-949f-b5dd4a3eb8e5",
        "db_currency_id": "9800815d-cf4b-4130-8cc8-d161f21be487",
        "db_language_id": "8853e893-2722-4bab-998b-97bffa946316",
        "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-18T23:39:00.2149317+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2025-07-18T23:39:00.2149317+00:00"
    },
    "job_status_id": "0ae25996-ef0e-4878-9ae5-bd446a845f30",
    "job_status_code": "sample string 11",
    "db_address_id": "d889fbaa-f432-4b66-98de-8cedec8f78da",
    "contact_id": "d2dddf2a-b648-404d-8f9c-b06296cd6b85",
    "requested_by_company_id": "e0b7f3cd-8d23-4437-a008-f5f6c3496552",
    "requested_by_contact_id": "12168323-a1bd-4966-847b-bea5e8779ebd",
    "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-18T23:39:00.2149317+00:00",
    "due_date": "2025-07-18T23:39:00.2149317+00:00",
    "date_create": "2025-07-18T23:39:00.2149317+00:00",
    "date_update": "2025-07-18T23:39:00.2149317+00:00",
    "date_closed": "2025-07-18T23:39:00.2149317+00:00",
    "suggested_user_id": "fe5dea96-f45e-44ca-a21b-5b3c77b94950",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "042d2543-8d5c-4f3b-8e2d-c3bf4937388a",
      "db_language_id": "1d851aec-b56d-403f-8a91-ce1e95cf7c44",
      "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-18T23:39:00.2149317+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "816743d0-c388-4df8-aee6-ecb6367b3014",
      "sales_organization": {
        "id": "4f46d6ec-5d21-4b8a-bca0-108a2f7eda44",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "1fc128bf-64ee-4a0a-949f-b5dd4a3eb8e5",
        "db_currency_id": "9800815d-cf4b-4130-8cc8-d161f21be487",
        "db_language_id": "8853e893-2722-4bab-998b-97bffa946316",
        "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-18T23:39:00.2149317+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "cf6101b0-0ef7-430a-b73f-4a54621b86fa",
      "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": "4ae4663e-db9d-4809-8619-939cfceb41de",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2025-07-18T23:39:00.2149317+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "6c12eff2-f76d-48a0-a1a0-dd60bd7d961b"
    },
    "suggested_date_start": "2025-07-18T23:39:00.2149317+00:00",
    "skill_id": "51d29b2c-c828-4ab1-b39b-b7de048e0633",
    "skill_code": "sample string 32",
    "skill": {
      "id": "d9a13754-367f-4b5d-ac1e-fce7e9f20c1d",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "f3431a6a-cd41-41d5-a119-af7da06c435e",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "4f46d6ec-5d21-4b8a-bca0-108a2f7eda44",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "1fc128bf-64ee-4a0a-949f-b5dd4a3eb8e5",
        "db_currency_id": "9800815d-cf4b-4130-8cc8-d161f21be487",
        "db_language_id": "8853e893-2722-4bab-998b-97bffa946316",
        "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-18T23:39:00.2149317+00:00"
      },
      "modified_dateutc": "2025-07-18T23:39:00.2149317+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "d979b2fc-395c-4d36-9ff2-807f33cf055d",
    "date_reported_by_company": "2025-07-18T23:39:00.2149317+00:00",
    "id2": 36,
    "company_id": "e96e7ab0-4b68-4eba-85ba-a3a2bb053bf4",
    "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": "40c880dc-ac4b-4987-bae4-5a4d5c5effc8",
    "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-18T23:39:00.2149317+00:00"
  },
  "work_instruction_details_id": "d5d7ee3e-4646-48d0-990e-e4f60eaf74ea",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "9b9fdc1b-9803-4164-9777-587287db9d0c",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "f03eefa9-b6a8-4b3e-b601-6f742681dfa4",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2025-07-18T23:39:00.2149317+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": "929792dd-6c16-4a68-9c55-fbe135c0c057",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2025-07-18T23:39:00.2149317+00:00"
}