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": "a2d9bfcd-f449-49dd-bb74-351878460cc7",
  "jobs_id": "597ddc35-8090-4cd1-bdd4-72f3c109874d",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "05f4c01e-5b5e-49e3-a8e6-0f4ddaecc7e1",
    "_parent_id": "8b6b6b99-468f-4018-ac0d-611b7a0a60ab",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "7afd40c8-0fd1-43a6-a7fd-a9e4994d6567",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "472ff733-1da9-4ff5-b519-776607e4a69d",
      "_parent_id": "12150eb0-8d46-4127-9366-8e6d9436bf57",
      "root_parent_id": "a5b62d8b-9a77-4e6f-a9dc-193cc4074d70",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "f747f9fe-7401-4b65-b2dc-29e6f250a1a8",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "6b150fc2-09bc-446f-82a3-907af4c468e0",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "3c299a9f-c3b6-4cdd-8951-e781dde6b1f6",
        "_parent_code": "sample string 6",
        "sales_organization_id": "41f60a88-aa94-4cbb-acd4-17f8c721b380",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "e7764d19-dd88-487b-bd8b-6022410fa573",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "d0c5602b-3e8f-4c97-a9f9-7ab43653bb39",
          "db_currency_id": "e2aa9a11-c3b5-43b0-862a-025a5e244941",
          "db_language_id": "9569dcd4-b2a9-4a40-bb3f-8b7a68e2c308",
          "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": "2022-12-06T04:43:08.726873+01:00"
        },
        "modified_dateutc": "2022-12-06T04:43:08.726873+01:00"
      },
      "equipment_model_id": "a4876c58-1807-4b76-972b-ef7d0f5c852d",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "ed098641-4f53-48fd-a114-47fc4f558aaa",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "52a571ce-0ea9-43d0-8141-1b3f924b636c",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "cbefb0b3-624d-43e6-b263-7d8762d0228b",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "155df6ad-60cc-4bab-9564-363394a1e570",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "e7764d19-dd88-487b-bd8b-6022410fa573",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "d0c5602b-3e8f-4c97-a9f9-7ab43653bb39",
            "db_currency_id": "e2aa9a11-c3b5-43b0-862a-025a5e244941",
            "db_language_id": "9569dcd4-b2a9-4a40-bb3f-8b7a68e2c308",
            "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": "2022-12-06T04:43:08.726873+01:00"
          },
          "modified_dateutc": "2022-12-06T04:43:08.726873+01:00"
        },
        "equipment_family_id": "3d5eb50f-9108-40ad-a2b2-0ffc4c297bc0",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "6b150fc2-09bc-446f-82a3-907af4c468e0",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "3c299a9f-c3b6-4cdd-8951-e781dde6b1f6",
          "_parent_code": "sample string 6",
          "sales_organization_id": "41f60a88-aa94-4cbb-acd4-17f8c721b380",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "e7764d19-dd88-487b-bd8b-6022410fa573",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "d0c5602b-3e8f-4c97-a9f9-7ab43653bb39",
            "db_currency_id": "e2aa9a11-c3b5-43b0-862a-025a5e244941",
            "db_language_id": "9569dcd4-b2a9-4a40-bb3f-8b7a68e2c308",
            "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": "2022-12-06T04:43:08.726873+01:00"
          },
          "modified_dateutc": "2022-12-06T04:43:08.726873+01:00"
        },
        "date_in_production_since": "2022-12-06T04:43:08.726873+01:00",
        "date_out_of_production_since": "2022-12-06T04:43:08.726873+01:00",
        "date_end_support": "2022-12-06T04:43:08.726873+01:00",
        "sales_organization_id": "cf920f36-497d-47ed-b545-0435973d3773",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "e7764d19-dd88-487b-bd8b-6022410fa573",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "d0c5602b-3e8f-4c97-a9f9-7ab43653bb39",
          "db_currency_id": "e2aa9a11-c3b5-43b0-862a-025a5e244941",
          "db_language_id": "9569dcd4-b2a9-4a40-bb3f-8b7a68e2c308",
          "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": "2022-12-06T04:43:08.726873+01: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": "2022-12-06T04:43:08.726873+01:00"
      },
      "project_status_id": "137eb0ad-28ed-4538-b309-0ea8630732c3",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "dbe34969-6297-4a66-849a-9931fd3b123c",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "68375dae-659a-4f3d-afce-733932db4f6c",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "e7764d19-dd88-487b-bd8b-6022410fa573",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "d0c5602b-3e8f-4c97-a9f9-7ab43653bb39",
          "db_currency_id": "e2aa9a11-c3b5-43b0-862a-025a5e244941",
          "db_language_id": "9569dcd4-b2a9-4a40-bb3f-8b7a68e2c308",
          "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": "2022-12-06T04:43:08.726873+01:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2022-12-06T04:43:08.726873+01:00"
      },
      "company_id": "2f945928-bc0e-4191-8fed-84fb9939c1c9",
      "company_code": "sample string 12",
      "db_address_id": "c4e44cc3-4204-436e-ba27-f41a788e5a98",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "6a269151-f9c9-492d-8fcf-f1f73a6a3dad",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "426b2dcd-247f-4dee-a65d-694633081bf6",
      "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": "2022-12-06T04:43:08.726873+01:00",
      "date_create": "2022-12-06T04:43:08.726873+01:00",
      "date_update": "2022-12-06T04:43:08.726873+01:00",
      "updated_by_user_id": "d6b8e301-1f79-444e-85b8-20e0f1b2c9eb",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2022-12-06T04:43:08.726873+01: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": "2022-12-06T00:00:00+01:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2022-12-06T04:43:08.726873+01:00",
      "date_last_job": "2022-12-06T04:43:08.726873+01:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2022-12-06T04:43:08.726873+01:00",
      "modified_dateutc": "2022-12-06T04:43:08.726873+01:00",
      "is_mobile_installation": true
    },
    "job_type_id": "43aaf453-f336-4746-add0-6118d91ab4ee",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "cc718cdc-6905-4a4a-a9d2-25e5a287e99e",
      "name": "sample string 2",
      "sales_organization_id": "b9ebef03-bfe7-4f79-87e5-d66996932f02",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2022-12-06T04:43:08.726873+01:00",
      "code": "sample string 7"
    },
    "job_priority_id": "dd412931-f164-47cc-bd7d-630c324ce375",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "ff1506e3-c4a8-4482-8410-fa4b0111de28",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "76ba0417-b302-4e0d-8ace-da0e591bc39f",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "e7764d19-dd88-487b-bd8b-6022410fa573",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "d0c5602b-3e8f-4c97-a9f9-7ab43653bb39",
        "db_currency_id": "e2aa9a11-c3b5-43b0-862a-025a5e244941",
        "db_language_id": "9569dcd4-b2a9-4a40-bb3f-8b7a68e2c308",
        "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": "2022-12-06T04:43:08.726873+01:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2022-12-06T04:43:08.726873+01:00"
    },
    "job_status_id": "aee5d9d8-f954-46d8-a6c7-d3ded6749312",
    "job_status_code": "sample string 11",
    "db_address_id": "438ae15a-4205-4372-ae7f-1adb529b4647",
    "contact_id": "d7292350-cf3c-4a61-9a72-39972a4ecf23",
    "requested_by_company_id": "b2c84c04-d730-423a-8c8c-2d4028ec3380",
    "requested_by_contact_id": "31d4553b-d864-4121-b419-46619c15336b",
    "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": "2022-12-06T04:43:08.726873+01:00",
    "due_date": "2022-12-06T04:43:08.726873+01:00",
    "date_create": "2022-12-06T04:43:08.726873+01:00",
    "date_update": "2022-12-06T04:43:08.726873+01:00",
    "date_closed": "2022-12-06T04:43:08.726873+01:00",
    "suggested_user_id": "dc2f6be1-947b-4010-b659-0eabd32b3169",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "c6513c26-654e-4b28-8b2b-189a45e73f86",
      "db_language_id": "e9399dc1-b56c-4dbf-acfb-9928b5a76607",
      "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": "2022-12-06T04:43:08.726873+01:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "1f99fb85-0445-4e8d-bd56-85916cd6359c",
      "sales_organization": {
        "id": "e7764d19-dd88-487b-bd8b-6022410fa573",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "d0c5602b-3e8f-4c97-a9f9-7ab43653bb39",
        "db_currency_id": "e2aa9a11-c3b5-43b0-862a-025a5e244941",
        "db_language_id": "9569dcd4-b2a9-4a40-bb3f-8b7a68e2c308",
        "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": "2022-12-06T04:43:08.726873+01:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "2f893e6c-7406-4b7f-a1ae-1b9fbb0c580b",
      "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": "689a5a8f-a0da-45de-a1a7-eb0e79dd794f",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2022-12-06T04:43:08.726873+01:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "4441d179-b761-4f62-b1fc-9f9d4c9f70d0"
    },
    "suggested_date_start": "2022-12-06T04:43:08.726873+01:00",
    "skill_id": "2bf9a755-8879-4808-af07-daa3c8a933a6",
    "skill_code": "sample string 32",
    "skill": {
      "id": "635cff82-8a99-4da4-861f-a31d9c6c3003",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "b8149431-bede-4ea7-b653-1ea9e2a54aab",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "e7764d19-dd88-487b-bd8b-6022410fa573",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "d0c5602b-3e8f-4c97-a9f9-7ab43653bb39",
        "db_currency_id": "e2aa9a11-c3b5-43b0-862a-025a5e244941",
        "db_language_id": "9569dcd4-b2a9-4a40-bb3f-8b7a68e2c308",
        "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": "2022-12-06T04:43:08.726873+01:00"
      },
      "modified_dateutc": "2022-12-06T04:43:08.726873+01:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "b4ca8dcd-c3e9-4280-9732-dae6a60203e6",
    "date_reported_by_company": "2022-12-06T04:43:08.726873+01:00",
    "id2": 36,
    "company_id": "d031c8b5-5783-4a64-bc31-4b3f041845fb",
    "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": "2ee056f4-f375-4c03-9340-a69acc836075",
    "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": "2022-12-06T04:43:08.726873+01:00"
  },
  "work_instruction_details_id": "20cd24c9-4e04-4898-a254-e61fba635e3f",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "a18e0ba3-0956-409a-a558-4522a80e6f6c",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "25f9efa4-f796-413b-8a05-20205df86d78",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2022-12-06T04:43:08.726873+01: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": "33bf3fe4-ca08-4b37-9ed0-352d526a0dba",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2022-12-06T04:43:08.726873+01:00"
}