Retrieves all the job work instruction list.

Request Information

URI Parameters :

None.

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": "2ebbfa46-f8a0-4c9c-8442-2e979496ed8d",
  "jobs_id": "97b0f314-140c-4fc5-bcad-22955d0e0806",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "f8973651-8c14-4f92-a9f4-43bd53620430",
    "_parent_id": "a5280e33-81ba-47ae-8940-0d50e68e22f6",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "99fbd689-859a-46cb-ad98-019fa539ec5a",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "11e2c15b-fb05-4784-a23b-71f6cc58f802",
      "_parent_id": "d9e6d5b5-7c28-474c-b96f-1b93a6ac39e0",
      "root_parent_id": "44af96a5-5a8f-4c12-89a5-dc7a95b34e6c",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "84de412a-ae74-4e0b-9af6-c84aee5cf800",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "f0324833-5b3e-438f-b7aa-3e908dc2489f",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "5312a0be-2845-489f-9fd0-3ec9cff18e26",
        "_parent_code": "sample string 6",
        "sales_organization_id": "689ccc01-9c1c-4052-a6e8-9317b854ff5f",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "039c6ac1-98a5-492c-856b-b5f0728ebd7e",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "df2ae858-7317-4a3d-9deb-6f6a5218468b",
          "db_currency_id": "9ede8a6d-720a-4de4-9759-7cc9dd43fc2b",
          "db_language_id": "22b98547-0e4b-428d-b6a2-c9a3d6bc4217",
          "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-20T19:30:12.4393799+00:00"
        },
        "modified_dateutc": "2026-11-20T19:30:12.4393799+00:00"
      },
      "equipment_model_id": "678f0384-d3a8-474b-9d88-f07ee650ce3c",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "f5d8ce42-f867-4d6f-a407-e2c22f13b730",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "5bf5085e-e77e-4f2c-9cd1-b0dbc71cd21c",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "b5637f35-3f4d-454c-8d9a-73d0d48d9210",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "befc722f-4e65-4fd7-8959-ed8c2bf1b1db",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "039c6ac1-98a5-492c-856b-b5f0728ebd7e",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "df2ae858-7317-4a3d-9deb-6f6a5218468b",
            "db_currency_id": "9ede8a6d-720a-4de4-9759-7cc9dd43fc2b",
            "db_language_id": "22b98547-0e4b-428d-b6a2-c9a3d6bc4217",
            "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-20T19:30:12.4393799+00:00"
          },
          "modified_dateutc": "2026-11-20T19:30:12.4393799+00:00"
        },
        "equipment_family_id": "446b39a1-028c-4426-9384-5b2cb006996f",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "f0324833-5b3e-438f-b7aa-3e908dc2489f",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "5312a0be-2845-489f-9fd0-3ec9cff18e26",
          "_parent_code": "sample string 6",
          "sales_organization_id": "689ccc01-9c1c-4052-a6e8-9317b854ff5f",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "039c6ac1-98a5-492c-856b-b5f0728ebd7e",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "df2ae858-7317-4a3d-9deb-6f6a5218468b",
            "db_currency_id": "9ede8a6d-720a-4de4-9759-7cc9dd43fc2b",
            "db_language_id": "22b98547-0e4b-428d-b6a2-c9a3d6bc4217",
            "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-20T19:30:12.4393799+00:00"
          },
          "modified_dateutc": "2026-11-20T19:30:12.4393799+00:00"
        },
        "date_in_production_since": "2026-11-20T19:30:12.4393799+00:00",
        "date_out_of_production_since": "2026-11-20T19:30:12.4393799+00:00",
        "date_end_support": "2026-11-20T19:30:12.4393799+00:00",
        "sales_organization_id": "7f97d307-1a61-4c3e-b2c9-4f4f595263b2",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "039c6ac1-98a5-492c-856b-b5f0728ebd7e",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "df2ae858-7317-4a3d-9deb-6f6a5218468b",
          "db_currency_id": "9ede8a6d-720a-4de4-9759-7cc9dd43fc2b",
          "db_language_id": "22b98547-0e4b-428d-b6a2-c9a3d6bc4217",
          "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-20T19:30:12.4393799+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-20T19:30:12.4393799+00:00"
      },
      "project_status_id": "fe737e6a-081a-48ae-bb80-c18ad05bacd9",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "736ec29a-741f-4733-856b-fa96f76441a3",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "b838c19c-ca18-4af3-9f5c-07c00a273bb6",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "039c6ac1-98a5-492c-856b-b5f0728ebd7e",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "df2ae858-7317-4a3d-9deb-6f6a5218468b",
          "db_currency_id": "9ede8a6d-720a-4de4-9759-7cc9dd43fc2b",
          "db_language_id": "22b98547-0e4b-428d-b6a2-c9a3d6bc4217",
          "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-20T19:30:12.4393799+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-11-20T19:30:12.4393799+00:00"
      },
      "company_id": "e7138beb-bb41-49d1-965c-1790d5a36d46",
      "company_code": "sample string 12",
      "db_address_id": "9349413f-a12e-42de-b687-7a768a943f38",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "fda241d0-afe7-49f0-8782-77402971d49a",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "18858877-c4d5-4e6f-8eab-ceddd5e57a2d",
      "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-20T19:30:12.4393799+00:00",
      "date_create": "2026-11-20T19:30:12.4393799+00:00",
      "date_update": "2026-11-20T19:30:12.4393799+00:00",
      "updated_by_user_id": "702cadad-ddd0-4a14-9af2-1684f9ecec4d",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-11-20T19:30:12.4393799+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-20T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-11-20T19:30:12.4393799+00:00",
      "date_last_job": "2026-11-20T19:30:12.4393799+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-11-20T19:30:12.4393799+00:00",
      "modified_dateutc": "2026-11-20T19:30:12.4393799+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "23d4909a-206a-4a62-b4b4-419ce7a23e01",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "196d502e-815f-4890-aa0c-53f74da8d91c",
      "name": "sample string 2",
      "sales_organization_id": "44698d5c-b5c7-4593-89da-c29bbb9940eb",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-11-20T19:30:12.4393799+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "c2b0d42d-8e76-42d2-9962-18c51b60e4d2",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "ed44bba5-095d-4aed-987a-e583dea125cd",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "10171f3a-ef84-427b-9b43-bd2992271ab5",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "039c6ac1-98a5-492c-856b-b5f0728ebd7e",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "df2ae858-7317-4a3d-9deb-6f6a5218468b",
        "db_currency_id": "9ede8a6d-720a-4de4-9759-7cc9dd43fc2b",
        "db_language_id": "22b98547-0e4b-428d-b6a2-c9a3d6bc4217",
        "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-20T19:30:12.4393799+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-11-20T19:30:12.4393799+00:00"
    },
    "job_status_id": "848e4ff2-4a47-45bb-b294-55d77deceb41",
    "job_status_code": "sample string 11",
    "db_address_id": "f1dc3c04-91a4-4532-aeca-2913cea9c425",
    "contact_id": "60870e07-54e0-492e-909e-20c89dd505d9",
    "requested_by_company_id": "1c3f1d36-2fb6-4d7a-9fd1-947f3828f1d4",
    "requested_by_contact_id": "8aeb7e79-9266-4d0b-934a-f5b276c311c1",
    "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-20T19:30:12.4393799+00:00",
    "due_date": "2026-11-20T19:30:12.4393799+00:00",
    "date_create": "2026-11-20T19:30:12.4393799+00:00",
    "date_update": "2026-11-20T19:30:12.4393799+00:00",
    "date_closed": "2026-11-20T19:30:12.4393799+00:00",
    "suggested_user_id": "abcd6fd7-d22b-4623-8f10-15549857fbda",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "f6f960aa-06a6-4832-9841-b2a356f57df9",
      "db_language_id": "4c0a6fc3-6037-4623-b30c-ba9367d3b898",
      "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-20T19:30:12.4393799+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "b5e9addf-afa3-483c-aa82-b08f304d5a62",
      "sales_organization": {
        "id": "039c6ac1-98a5-492c-856b-b5f0728ebd7e",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "df2ae858-7317-4a3d-9deb-6f6a5218468b",
        "db_currency_id": "9ede8a6d-720a-4de4-9759-7cc9dd43fc2b",
        "db_language_id": "22b98547-0e4b-428d-b6a2-c9a3d6bc4217",
        "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-20T19:30:12.4393799+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "f0f54302-0602-4b07-9722-b86da7103088",
      "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": "d26749a7-9cf7-4f08-9310-4477ea981dca",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-11-20T19:30:12.4393799+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "f16b43b5-f97d-4701-af76-e5ed1ffcb81e"
    },
    "suggested_date_start": "2026-11-20T19:30:12.4393799+00:00",
    "skill_id": "8e198d64-bea9-4d87-a82e-50cbd0a81cbb",
    "skill_code": "sample string 32",
    "skill": {
      "id": "ae80a127-1319-44c6-93c3-556ba31047a0",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "4b54c7c6-5b56-4063-9741-76baab5703b2",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "039c6ac1-98a5-492c-856b-b5f0728ebd7e",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "df2ae858-7317-4a3d-9deb-6f6a5218468b",
        "db_currency_id": "9ede8a6d-720a-4de4-9759-7cc9dd43fc2b",
        "db_language_id": "22b98547-0e4b-428d-b6a2-c9a3d6bc4217",
        "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-20T19:30:12.4393799+00:00"
      },
      "modified_dateutc": "2026-11-20T19:30:12.4393799+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "9caaadc0-68e4-4bd6-8f95-91e4c94a4cd2",
    "date_reported_by_company": "2026-11-20T19:30:12.4393799+00:00",
    "id2": 36,
    "company_id": "1383c3c2-4207-4f21-9b1b-601944f7c556",
    "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": "ebe6dae5-a30a-43d7-b63b-300d9bdd95a9",
    "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-20T19:30:12.4393799+00:00"
  },
  "work_instruction_details_id": "fdc7d2eb-a025-4789-8ac2-14a0fb99d454",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "d1a586ad-a49a-4a10-9045-76b8f477d51d",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "8bdd2643-2107-4839-a903-1e152087a3e3",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-11-20T19:30:12.4393799+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": "2a94558e-07b8-4d01-a134-4b4858bc29e6",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-11-20T19:30:12.4393799+00:00"
}