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": "4aaee505-202a-4b43-bc2d-d2e33dc691c1",
  "jobs_id": "6ec8de6f-b2cf-4028-8c3e-446737f37c30",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "80aca19c-7729-4359-a503-6589613ff72f",
    "_parent_id": "a18e7f17-0e5d-4f43-96a8-26f417823846",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "9a68ad0c-58cc-4ae8-bb10-2be01653f4f5",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "4c2d1313-0748-480a-a633-ce1f8da3fffd",
      "_parent_id": "f0229741-d158-417c-955f-e8f4f1352ea4",
      "root_parent_id": "381d4394-0e36-48e3-a4ad-af48a1cb5758",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "83040af6-09ba-471d-b8b1-47a9be5888cd",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "ca864883-c8fb-41e9-8832-03680b1bfe8d",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "d1c6c407-76fe-470d-9104-3c470b3ec60b",
        "_parent_code": "sample string 6",
        "sales_organization_id": "a3d13106-0630-42e3-a64c-b3f5047dd478",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "fe5b12f6-05d2-49bf-995a-3698c415ec36",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "eb07c913-8440-42ed-91c5-934367568b37",
          "db_currency_id": "9ef2f1a2-3bb1-437d-957e-aeeeb98dd5d3",
          "db_language_id": "29ed1e7a-c1e2-40a4-b817-246c03824ae3",
          "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-19T00:01:57.0202093+00:00"
        },
        "modified_dateutc": "2025-07-19T00:01:57.0202093+00:00"
      },
      "equipment_model_id": "38656d8c-11e1-44cc-8590-44cdf7df7729",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "a3079924-11f1-4e76-8fab-9311c25f7ca4",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "e6dc8fb2-3ca6-436b-acff-a2b449fc4854",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "a69037bb-7482-4348-8062-a884c34aae24",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "9196786d-3837-4f5a-aabc-7b0e8ba9c737",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "fe5b12f6-05d2-49bf-995a-3698c415ec36",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "eb07c913-8440-42ed-91c5-934367568b37",
            "db_currency_id": "9ef2f1a2-3bb1-437d-957e-aeeeb98dd5d3",
            "db_language_id": "29ed1e7a-c1e2-40a4-b817-246c03824ae3",
            "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-19T00:01:57.0202093+00:00"
          },
          "modified_dateutc": "2025-07-19T00:01:57.0202093+00:00"
        },
        "equipment_family_id": "a49d70d5-8b6b-4d6a-88d6-9a1ba94bf250",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "ca864883-c8fb-41e9-8832-03680b1bfe8d",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "d1c6c407-76fe-470d-9104-3c470b3ec60b",
          "_parent_code": "sample string 6",
          "sales_organization_id": "a3d13106-0630-42e3-a64c-b3f5047dd478",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "fe5b12f6-05d2-49bf-995a-3698c415ec36",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "eb07c913-8440-42ed-91c5-934367568b37",
            "db_currency_id": "9ef2f1a2-3bb1-437d-957e-aeeeb98dd5d3",
            "db_language_id": "29ed1e7a-c1e2-40a4-b817-246c03824ae3",
            "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-19T00:01:57.0202093+00:00"
          },
          "modified_dateutc": "2025-07-19T00:01:57.0202093+00:00"
        },
        "date_in_production_since": "2025-07-19T00:01:57.0202093+00:00",
        "date_out_of_production_since": "2025-07-19T00:01:57.0202093+00:00",
        "date_end_support": "2025-07-19T00:01:57.0202093+00:00",
        "sales_organization_id": "820fc789-9a15-404c-a9c2-8e80be3f5129",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "fe5b12f6-05d2-49bf-995a-3698c415ec36",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "eb07c913-8440-42ed-91c5-934367568b37",
          "db_currency_id": "9ef2f1a2-3bb1-437d-957e-aeeeb98dd5d3",
          "db_language_id": "29ed1e7a-c1e2-40a4-b817-246c03824ae3",
          "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-19T00:01:57.0202093+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-19T00:01:57.0358343+00:00"
      },
      "project_status_id": "b810d29f-ff54-4fe3-832f-e96e11835446",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "bf367c21-b53e-40a5-aaf4-6f33a3a6a608",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "1c1078e7-f54f-413d-aa04-89aed560b61f",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "fe5b12f6-05d2-49bf-995a-3698c415ec36",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "eb07c913-8440-42ed-91c5-934367568b37",
          "db_currency_id": "9ef2f1a2-3bb1-437d-957e-aeeeb98dd5d3",
          "db_language_id": "29ed1e7a-c1e2-40a4-b817-246c03824ae3",
          "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-19T00:01:57.0202093+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2025-07-19T00:01:57.0358343+00:00"
      },
      "company_id": "9dcb5b5f-9a31-4b62-9695-dd99db73fe51",
      "company_code": "sample string 12",
      "db_address_id": "a0a27a24-3e93-498e-bbf4-5bc82c883231",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "65751c44-2d14-430b-92a5-2ae7b1003999",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "0665ce03-6aa0-4a93-b645-431c71af29b9",
      "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-19T00:01:57.0358343+00:00",
      "date_create": "2025-07-19T00:01:57.0358343+00:00",
      "date_update": "2025-07-19T00:01:57.0358343+00:00",
      "updated_by_user_id": "8040eb09-a485-4aa8-ad1a-57374d0a728d",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2025-07-19T00:01:57.0358343+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-19T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2025-07-19T00:01:57.0358343+00:00",
      "date_last_job": "2025-07-19T00:01:57.0358343+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2025-07-19T00:01:57.0358343+00:00",
      "modified_dateutc": "2025-07-19T00:01:57.0358343+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "2a39ac62-7fa5-41cb-850f-986b633e5f94",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "081c1795-6237-4168-925a-bb6962d04609",
      "name": "sample string 2",
      "sales_organization_id": "d0c893b0-5407-4cca-87b0-b9cd1f48292c",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2025-07-19T00:01:57.0358343+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "e709c1bb-05b6-4afe-bf1f-216774dba002",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "34efe11c-0289-4fc1-8a09-c45def116d9f",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "68eb587e-9fbf-4c74-b922-1a5f7caba20c",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "fe5b12f6-05d2-49bf-995a-3698c415ec36",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "eb07c913-8440-42ed-91c5-934367568b37",
        "db_currency_id": "9ef2f1a2-3bb1-437d-957e-aeeeb98dd5d3",
        "db_language_id": "29ed1e7a-c1e2-40a4-b817-246c03824ae3",
        "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-19T00:01:57.0202093+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2025-07-19T00:01:57.0358343+00:00"
    },
    "job_status_id": "fa25a44e-50f9-4659-a14f-9524c5346786",
    "job_status_code": "sample string 11",
    "db_address_id": "d6117b1f-187d-4bd0-92ee-5d33e62ad8f9",
    "contact_id": "4ca94104-cbdd-4299-8bfc-d5c4152bb4ae",
    "requested_by_company_id": "1b9d482d-8e1a-4027-8396-129a56263014",
    "requested_by_contact_id": "5cdd0a47-6311-479e-ab27-935528e3aeed",
    "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-19T00:01:57.0358343+00:00",
    "due_date": "2025-07-19T00:01:57.0358343+00:00",
    "date_create": "2025-07-19T00:01:57.0358343+00:00",
    "date_update": "2025-07-19T00:01:57.0358343+00:00",
    "date_closed": "2025-07-19T00:01:57.0358343+00:00",
    "suggested_user_id": "363259d9-e832-4bf7-8ff5-76b7552e95cd",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "aec43bbe-f01d-469e-b0a3-a172ca2b3be9",
      "db_language_id": "237cec21-a3ce-4436-b949-ba3275698b33",
      "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-19T00:01:57.0358343+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "d130fa8c-b275-440f-8ef7-4ed8855ec77d",
      "sales_organization": {
        "id": "fe5b12f6-05d2-49bf-995a-3698c415ec36",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "eb07c913-8440-42ed-91c5-934367568b37",
        "db_currency_id": "9ef2f1a2-3bb1-437d-957e-aeeeb98dd5d3",
        "db_language_id": "29ed1e7a-c1e2-40a4-b817-246c03824ae3",
        "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-19T00:01:57.0202093+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "efcc0f4c-9429-4228-a148-4ad40a4b848b",
      "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": "a1b1a28c-5c0f-44c9-957a-0efc77eb8571",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2025-07-19T00:01:57.0358343+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "3f4d3488-4cb4-4759-83e5-058b9dbfff1d"
    },
    "suggested_date_start": "2025-07-19T00:01:57.0358343+00:00",
    "skill_id": "3c2c500d-0d0a-4dd6-84d4-6e1102731835",
    "skill_code": "sample string 32",
    "skill": {
      "id": "3d6f412e-4c3a-4cfd-a5a9-80567b3e8074",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "c82c4356-c91c-4275-8c59-226844aaa223",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "fe5b12f6-05d2-49bf-995a-3698c415ec36",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "eb07c913-8440-42ed-91c5-934367568b37",
        "db_currency_id": "9ef2f1a2-3bb1-437d-957e-aeeeb98dd5d3",
        "db_language_id": "29ed1e7a-c1e2-40a4-b817-246c03824ae3",
        "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-19T00:01:57.0202093+00:00"
      },
      "modified_dateutc": "2025-07-19T00:01:57.0358343+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "c6bfbcf8-d438-45cc-b833-982ebb76f7a4",
    "date_reported_by_company": "2025-07-19T00:01:57.0358343+00:00",
    "id2": 36,
    "company_id": "c22858c8-6b71-497a-bfbf-1c9326836406",
    "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": "6e9e1a2a-daa1-4d62-84ff-2a88f7a2c144",
    "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-19T00:01:57.0358343+00:00"
  },
  "work_instruction_details_id": "1389a2ff-0898-4742-b271-641f8511d78a",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "18e76d07-6233-4bf7-a896-c1c05d9200d8",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "b2f6a5c7-4af1-43c5-ae02-0f4623137101",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2025-07-19T00:01:57.0358343+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": "184afdd6-f500-4ede-8ab5-758c7c8d76c9",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2025-07-19T00:01:57.0515283+00:00"
}