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": "571d8c54-ecad-4e08-bfff-f3fb2c244bdb",
  "jobs_id": "883ddefd-d2dd-4769-9333-b74925c447e5",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "622844ac-98db-4830-828d-5c45ed39b03b",
    "_parent_id": "7a5fddc4-c8a7-493c-b0a0-104fafa51567",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "21166b76-ecfa-4263-b101-3e53ddb09c7d",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "905c4765-805f-4362-a624-5e6d505981c0",
      "_parent_id": "7e591d4f-719b-49fb-a210-b7a821af94f4",
      "root_parent_id": "5ce46f7d-00e0-4a77-8213-1261607b1125",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "d9998485-7412-4ffe-a347-5a8928ecb146",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "6adb26c5-2dc5-42aa-928b-e7423fa4faac",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "d318328b-a336-4cf8-bf3d-2f08bfed79f0",
        "_parent_code": "sample string 6",
        "sales_organization_id": "7e2e0b36-bd8b-42ed-8602-53d19c8ed017",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "416b9764-5f0d-47c7-b703-c387e1cad1b5",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "86e47d95-3e60-4b48-92bc-eda47c50ac2f",
          "db_currency_id": "75194eec-1b73-4f96-bea9-5ecca3e521e4",
          "db_language_id": "1e0479fb-44c3-4ce4-8d3a-9383f54e7c06",
          "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-10-17T02:40:17.2044062+00:00"
        },
        "modified_dateutc": "2025-10-17T02:40:17.2044062+00:00"
      },
      "equipment_model_id": "432ee57c-7303-4ff1-8e4d-135c5e77a813",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "8fa393ce-2dfa-441e-86b2-3ca0d36dd80b",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "2109df41-bafe-4f22-83e7-8b6a009dde89",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "85ec215c-3e8b-484a-9c41-6915d0ddcaaa",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "7527bcd0-8163-49cb-9fa0-cea4ac56f4fc",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "416b9764-5f0d-47c7-b703-c387e1cad1b5",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "86e47d95-3e60-4b48-92bc-eda47c50ac2f",
            "db_currency_id": "75194eec-1b73-4f96-bea9-5ecca3e521e4",
            "db_language_id": "1e0479fb-44c3-4ce4-8d3a-9383f54e7c06",
            "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-10-17T02:40:17.2044062+00:00"
          },
          "modified_dateutc": "2025-10-17T02:40:17.2044062+00:00"
        },
        "equipment_family_id": "7d7ef588-d717-4958-beb4-3f8c51541b72",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "6adb26c5-2dc5-42aa-928b-e7423fa4faac",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "d318328b-a336-4cf8-bf3d-2f08bfed79f0",
          "_parent_code": "sample string 6",
          "sales_organization_id": "7e2e0b36-bd8b-42ed-8602-53d19c8ed017",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "416b9764-5f0d-47c7-b703-c387e1cad1b5",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "86e47d95-3e60-4b48-92bc-eda47c50ac2f",
            "db_currency_id": "75194eec-1b73-4f96-bea9-5ecca3e521e4",
            "db_language_id": "1e0479fb-44c3-4ce4-8d3a-9383f54e7c06",
            "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-10-17T02:40:17.2044062+00:00"
          },
          "modified_dateutc": "2025-10-17T02:40:17.2044062+00:00"
        },
        "date_in_production_since": "2025-10-17T02:40:17.2044062+00:00",
        "date_out_of_production_since": "2025-10-17T02:40:17.2044062+00:00",
        "date_end_support": "2025-10-17T02:40:17.2044062+00:00",
        "sales_organization_id": "864b1e13-e01b-4a40-88d6-3b45dbb85a8c",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "416b9764-5f0d-47c7-b703-c387e1cad1b5",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "86e47d95-3e60-4b48-92bc-eda47c50ac2f",
          "db_currency_id": "75194eec-1b73-4f96-bea9-5ecca3e521e4",
          "db_language_id": "1e0479fb-44c3-4ce4-8d3a-9383f54e7c06",
          "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-10-17T02:40:17.2044062+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-10-17T02:40:17.2044062+00:00"
      },
      "project_status_id": "bda1bbab-79eb-410e-98de-825e558ad356",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "bfeec146-8dbf-4847-9d59-3bcd1145267b",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "88be62b0-7a40-4c81-99d7-5268d3fd5ee2",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "416b9764-5f0d-47c7-b703-c387e1cad1b5",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "86e47d95-3e60-4b48-92bc-eda47c50ac2f",
          "db_currency_id": "75194eec-1b73-4f96-bea9-5ecca3e521e4",
          "db_language_id": "1e0479fb-44c3-4ce4-8d3a-9383f54e7c06",
          "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-10-17T02:40:17.2044062+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2025-10-17T02:40:17.2044062+00:00"
      },
      "company_id": "4fc8bef2-ee32-444e-afb8-600c42260ee9",
      "company_code": "sample string 12",
      "db_address_id": "d533820c-df2e-4766-9553-ffbf03507037",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "f123c48e-8ad1-4b8e-80d8-1e176d53226d",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "af289e7e-3ce2-43de-9528-f9d98a1b2a92",
      "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-10-17T02:40:17.2044062+00:00",
      "date_create": "2025-10-17T02:40:17.2044062+00:00",
      "date_update": "2025-10-17T02:40:17.2044062+00:00",
      "updated_by_user_id": "d9f94ada-5bcc-4ab4-98b0-3e1415ef0235",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2025-10-17T02:40:17.2044062+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-10-17T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2025-10-17T02:40:17.2044062+00:00",
      "date_last_job": "2025-10-17T02:40:17.2044062+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2025-10-17T02:40:17.2044062+00:00",
      "modified_dateutc": "2025-10-17T02:40:17.2044062+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "c18f0dd1-ae41-40e2-b00b-d1897c2405b5",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "8a3ce151-c9bd-43c0-a4c0-66747bf7d17b",
      "name": "sample string 2",
      "sales_organization_id": "8fd9ed69-e6ff-4b05-bdcb-a4f9b3e8ef90",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2025-10-17T02:40:17.2044062+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "ec5c95b6-fa90-46cf-b90e-d21582411459",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "c7b2f270-a8ba-4bb5-bfda-db8eb5ca4a65",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "8b5369fd-7629-46ee-852f-d1e443e1bddb",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "416b9764-5f0d-47c7-b703-c387e1cad1b5",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "86e47d95-3e60-4b48-92bc-eda47c50ac2f",
        "db_currency_id": "75194eec-1b73-4f96-bea9-5ecca3e521e4",
        "db_language_id": "1e0479fb-44c3-4ce4-8d3a-9383f54e7c06",
        "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-10-17T02:40:17.2044062+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2025-10-17T02:40:17.2044062+00:00"
    },
    "job_status_id": "fd46929e-779a-485a-889c-3255fd6e447b",
    "job_status_code": "sample string 11",
    "db_address_id": "f7ccad69-8d56-407a-807d-b637fb4d6916",
    "contact_id": "fae5acad-4417-4f67-b6c0-3961afddc1a5",
    "requested_by_company_id": "ac97045c-b661-4b10-8bae-7bbac2f65e75",
    "requested_by_contact_id": "ecb784f7-9f0b-4b04-9835-86213d8053ae",
    "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-10-17T02:40:17.2044062+00:00",
    "due_date": "2025-10-17T02:40:17.2044062+00:00",
    "date_create": "2025-10-17T02:40:17.2044062+00:00",
    "date_update": "2025-10-17T02:40:17.2044062+00:00",
    "date_closed": "2025-10-17T02:40:17.2044062+00:00",
    "suggested_user_id": "b0edb5ac-f456-41ab-a585-2c728b5325f0",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "2601f083-534a-4138-8746-c178a03d9a85",
      "db_language_id": "a3ee1718-ca08-4921-a5d7-49c34ad99516",
      "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-10-17T02:40:17.2044062+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "62b473a9-94fb-4ae3-b340-4e8972b5f01f",
      "sales_organization": {
        "id": "416b9764-5f0d-47c7-b703-c387e1cad1b5",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "86e47d95-3e60-4b48-92bc-eda47c50ac2f",
        "db_currency_id": "75194eec-1b73-4f96-bea9-5ecca3e521e4",
        "db_language_id": "1e0479fb-44c3-4ce4-8d3a-9383f54e7c06",
        "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-10-17T02:40:17.2044062+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "2e9e7cb4-61a6-4786-8231-ff5d173904b7",
      "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": "076fb09e-f652-4411-ae2e-58c051a235a9",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2025-10-17T02:40:17.2044062+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "1fbe47f7-99fa-4694-b60e-a46166e53a6d"
    },
    "suggested_date_start": "2025-10-17T02:40:17.2044062+00:00",
    "skill_id": "49a8070b-7bb7-4f10-9485-78b930bc7a3d",
    "skill_code": "sample string 32",
    "skill": {
      "id": "a3b8be27-56c1-46a1-bbec-7975e3540677",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "8dba0d07-da85-4004-8c6d-3b25728c1f41",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "416b9764-5f0d-47c7-b703-c387e1cad1b5",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "86e47d95-3e60-4b48-92bc-eda47c50ac2f",
        "db_currency_id": "75194eec-1b73-4f96-bea9-5ecca3e521e4",
        "db_language_id": "1e0479fb-44c3-4ce4-8d3a-9383f54e7c06",
        "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-10-17T02:40:17.2044062+00:00"
      },
      "modified_dateutc": "2025-10-17T02:40:17.2044062+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "ce1a61ff-52be-4bce-a854-686d6d23cfeb",
    "date_reported_by_company": "2025-10-17T02:40:17.2044062+00:00",
    "id2": 36,
    "company_id": "2552f975-18a9-404e-9105-b4d94b319f51",
    "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": "a414c2e1-0c30-4a25-9f39-f5e4dacabcab",
    "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-10-17T02:40:17.2044062+00:00"
  },
  "work_instruction_details_id": "7915dc11-6cc7-46e7-8506-faa06171f2cd",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "b81e9451-86c1-42fa-8fe1-b24185c66cd5",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "4e1146f0-962e-44f4-8905-2336a669aa70",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2025-10-17T02:40:17.2044062+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": "2a14f65c-39aa-41fc-996c-0d1c36f3cd04",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2025-10-17T02:40:17.2044062+00:00"
}