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": "a2a275f1-505f-4fac-b364-37e1838d7daa",
  "jobs_id": "a2df6aee-968b-4a74-957e-ecf606310662",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "d10753ae-cc53-4d18-b48a-c7ae7021fba6",
    "_parent_id": "7de2bbf5-d743-4f65-bf54-a0b2f391c511",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "7c77c5a7-7cf5-4f7c-bccd-aa3fcd6842c5",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "1e9b9e12-ba77-4749-b1df-000e8765f00f",
      "_parent_id": "851a5346-6365-4370-830f-c01336d76bd6",
      "root_parent_id": "df2848ce-d9da-429b-ac7f-ab5579bde10a",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "dab6b307-58b2-4200-99c5-109ca513c3a6",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "d8b78734-eb42-4628-9a0e-2ac535a573d7",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "e9dc79ad-f95b-4c6a-8a0a-c8b7d395dcbf",
        "_parent_code": "sample string 6",
        "sales_organization_id": "ffe15a5d-2358-47f4-afa8-6caf99af1cd6",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "65a0736d-570b-4416-b3d2-826231471403",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "1b3d91a4-f13a-43bf-b186-8b5d6c7b6830",
          "db_currency_id": "fffe1f64-fbd9-493c-a2a9-e85c3b105561",
          "db_language_id": "4dd72f65-3a6d-47b2-a4ca-46a511a8e7d8",
          "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": "2023-03-31T22:20:38.3562509+00:00"
        },
        "modified_dateutc": "2023-03-31T22:20:38.3562509+00:00"
      },
      "equipment_model_id": "a1619955-c422-496b-85ad-77d7b59d9830",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "2f6ca24c-5a59-4211-b0ab-60b64c2feb15",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "8b5e410b-f21c-4e5d-8da2-f69f178fbc47",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "6fe4d247-c186-44d6-ab7a-1eec54ee067c",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "007dc119-438b-4922-9b49-8ae2d1d14e0b",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "65a0736d-570b-4416-b3d2-826231471403",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "1b3d91a4-f13a-43bf-b186-8b5d6c7b6830",
            "db_currency_id": "fffe1f64-fbd9-493c-a2a9-e85c3b105561",
            "db_language_id": "4dd72f65-3a6d-47b2-a4ca-46a511a8e7d8",
            "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": "2023-03-31T22:20:38.3562509+00:00"
          },
          "modified_dateutc": "2023-03-31T22:20:38.3562509+00:00"
        },
        "equipment_family_id": "a7f23c2b-4641-4025-b499-e3f278d0ed6e",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "d8b78734-eb42-4628-9a0e-2ac535a573d7",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "e9dc79ad-f95b-4c6a-8a0a-c8b7d395dcbf",
          "_parent_code": "sample string 6",
          "sales_organization_id": "ffe15a5d-2358-47f4-afa8-6caf99af1cd6",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "65a0736d-570b-4416-b3d2-826231471403",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "1b3d91a4-f13a-43bf-b186-8b5d6c7b6830",
            "db_currency_id": "fffe1f64-fbd9-493c-a2a9-e85c3b105561",
            "db_language_id": "4dd72f65-3a6d-47b2-a4ca-46a511a8e7d8",
            "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": "2023-03-31T22:20:38.3562509+00:00"
          },
          "modified_dateutc": "2023-03-31T22:20:38.3562509+00:00"
        },
        "date_in_production_since": "2023-03-31T22:20:38.3562509+00:00",
        "date_out_of_production_since": "2023-03-31T22:20:38.3562509+00:00",
        "date_end_support": "2023-03-31T22:20:38.3562509+00:00",
        "sales_organization_id": "701cd114-d229-4363-887d-dc25f0e75bea",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "65a0736d-570b-4416-b3d2-826231471403",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "1b3d91a4-f13a-43bf-b186-8b5d6c7b6830",
          "db_currency_id": "fffe1f64-fbd9-493c-a2a9-e85c3b105561",
          "db_language_id": "4dd72f65-3a6d-47b2-a4ca-46a511a8e7d8",
          "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": "2023-03-31T22:20:38.3562509+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": "2023-03-31T22:20:38.3562509+00:00"
      },
      "project_status_id": "4e70407f-0481-413c-b98e-14f455cf52b8",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "1ec6cd9f-8ab6-4370-95af-9b643314d110",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "8734b9f9-99d5-4d97-a81b-204551842df4",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "65a0736d-570b-4416-b3d2-826231471403",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "1b3d91a4-f13a-43bf-b186-8b5d6c7b6830",
          "db_currency_id": "fffe1f64-fbd9-493c-a2a9-e85c3b105561",
          "db_language_id": "4dd72f65-3a6d-47b2-a4ca-46a511a8e7d8",
          "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": "2023-03-31T22:20:38.3562509+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2023-03-31T22:20:38.3562509+00:00"
      },
      "company_id": "f827df83-503c-4045-8ecf-5eebaeba9293",
      "company_code": "sample string 12",
      "db_address_id": "e4c8c4a8-2f05-4a78-b7ac-5fdc2c31cd9c",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "ae4ad272-ee6b-4111-b600-46a7ae4bf897",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "68751d0a-ed26-4eda-825c-83417a6370f4",
      "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": "2023-03-31T22:20:38.3562509+00:00",
      "date_create": "2023-03-31T22:20:38.3562509+00:00",
      "date_update": "2023-03-31T22:20:38.3562509+00:00",
      "updated_by_user_id": "1582e697-2853-4919-bfd6-f761c8c427e5",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2023-03-31T22:20:38.3562509+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": "2023-03-31T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2023-03-31T22:20:38.3562509+00:00",
      "date_last_job": "2023-03-31T22:20:38.3562509+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2023-03-31T22:20:38.3562509+00:00",
      "modified_dateutc": "2023-03-31T22:20:38.3562509+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "6f673b67-f8aa-4ee3-9464-f1d95e330f84",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "de8dc47a-ac83-4b85-87b2-025a46646420",
      "name": "sample string 2",
      "sales_organization_id": "51c89e6d-b954-4750-bfc6-2880e1d264cb",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2023-03-31T22:20:38.3562509+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "ec6887a6-92bd-4ac1-a6e6-1bc7cbebf5c0",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "aa806cb7-9d9c-4bcc-86ce-564d5a5f52b7",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "9d5a0c2b-6aae-49b4-87ba-bbe12b346e7e",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "65a0736d-570b-4416-b3d2-826231471403",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "1b3d91a4-f13a-43bf-b186-8b5d6c7b6830",
        "db_currency_id": "fffe1f64-fbd9-493c-a2a9-e85c3b105561",
        "db_language_id": "4dd72f65-3a6d-47b2-a4ca-46a511a8e7d8",
        "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": "2023-03-31T22:20:38.3562509+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2023-03-31T22:20:38.3562509+00:00"
    },
    "job_status_id": "6f205342-f095-48b3-a51c-3180d0d37d8f",
    "job_status_code": "sample string 11",
    "db_address_id": "2d9a8865-69ef-4749-98f8-dfa0c2711ce8",
    "contact_id": "9cdd6523-e85a-44f1-b5ff-548d0c7b0169",
    "requested_by_company_id": "850a0a4a-2d59-4d87-990c-985e729b7e14",
    "requested_by_contact_id": "0cc008eb-383e-4326-a05b-ce26f4263e5b",
    "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": "2023-03-31T22:20:38.3562509+00:00",
    "due_date": "2023-03-31T22:20:38.3562509+00:00",
    "date_create": "2023-03-31T22:20:38.3562509+00:00",
    "date_update": "2023-03-31T22:20:38.3562509+00:00",
    "date_closed": "2023-03-31T22:20:38.3562509+00:00",
    "suggested_user_id": "e6ce5a7b-dea8-41b9-961d-47180fb3abce",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "02b7e8aa-2864-4073-8ebb-7e23817232b0",
      "db_language_id": "633d1544-282b-44e2-accf-85998ff5f70b",
      "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": "2023-03-31T22:20:38.3562509+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "095dc8d5-d4a6-4e46-a821-b85efa2d4118",
      "sales_organization": {
        "id": "65a0736d-570b-4416-b3d2-826231471403",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "1b3d91a4-f13a-43bf-b186-8b5d6c7b6830",
        "db_currency_id": "fffe1f64-fbd9-493c-a2a9-e85c3b105561",
        "db_language_id": "4dd72f65-3a6d-47b2-a4ca-46a511a8e7d8",
        "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": "2023-03-31T22:20:38.3562509+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "34e65690-50c3-4428-8462-92af26742d12",
      "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": "aa4a6c6b-ff64-4dfd-b345-8a7c4c5ea494",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2023-03-31T22:20:38.3562509+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "72dce243-4614-4ad9-9bf2-923115767fa6"
    },
    "suggested_date_start": "2023-03-31T22:20:38.3562509+00:00",
    "skill_id": "6dc709f0-8b72-4633-818a-2eb7f9f3d3df",
    "skill_code": "sample string 32",
    "skill": {
      "id": "87e931b1-7532-4077-8ce2-c0440028c678",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "4f3a4e64-bb4c-4f1c-81a2-e01fc852db78",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "65a0736d-570b-4416-b3d2-826231471403",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "1b3d91a4-f13a-43bf-b186-8b5d6c7b6830",
        "db_currency_id": "fffe1f64-fbd9-493c-a2a9-e85c3b105561",
        "db_language_id": "4dd72f65-3a6d-47b2-a4ca-46a511a8e7d8",
        "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": "2023-03-31T22:20:38.3562509+00:00"
      },
      "modified_dateutc": "2023-03-31T22:20:38.3562509+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "1d2598f1-a386-4097-9b8e-33cb9d352c9d",
    "date_reported_by_company": "2023-03-31T22:20:38.3562509+00:00",
    "id2": 36,
    "company_id": "42cb977e-1de4-4dd4-a44b-f1dddae18606",
    "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": "a7bf5e83-399e-4a09-879f-bd0b4340e2b3",
    "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": "2023-03-31T22:20:38.3562509+00:00"
  },
  "work_instruction_details_id": "b773f753-8f1c-44f5-b1f2-dedc61a4c556",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "ac5529ca-6b50-4a86-a7f9-88236ac8ed8b",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "1cebcf9e-3073-498b-8557-9f25e75a8210",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2023-03-31T22:20:38.3562509+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": "4e70bdba-d73f-4beb-82ab-295d365eff20",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2023-03-31T22:20:38.3562509+00:00"
}