Retrieves the job work instruction list with the specified key.

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

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": "0b30e6ba-5e35-4b9b-9bf1-a252135518f5",
  "jobs_id": "b81ac9cf-1174-4765-9890-2980af992ceb",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "db244116-c774-44ce-8188-f3b1b2feed19",
    "_parent_id": "d7fbdb2d-9887-46c2-974c-a7e480e4b158",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "28dc6bbe-0a5e-4b84-8d2c-876892ac756a",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "c365fc4d-186d-4b63-8f85-ad6b51cb1f65",
      "_parent_id": "d31cffbf-1080-4fb5-a0f9-45175d10d2a5",
      "root_parent_id": "0cbf0fbb-b946-4540-ac7c-ca7998e63562",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "04287a3c-2b94-4c90-818e-313475ee9227",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "6810e507-0edb-4809-8955-37d4a551965f",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "60a301be-918a-4203-8b65-65aa029bbf42",
        "_parent_code": "sample string 6",
        "sales_organization_id": "cf6c3026-1201-4e16-b166-d52abc8446dd",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "bf8ddf5b-9f48-43d4-abcf-05f0bc12c990",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "2da06e50-18e1-4d35-b27e-e0669c75f0f2",
          "db_currency_id": "e3b7b0b3-91cc-4bd6-b85d-2de0e0d8cc10",
          "db_language_id": "126df76e-1fca-422a-ac3f-654d23fd53a0",
          "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": "2024-06-17T23:22:06.4844064+00:00"
        },
        "modified_dateutc": "2024-06-17T23:22:06.4844064+00:00"
      },
      "equipment_model_id": "3447a372-334f-4511-9460-0301e74a62cf",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "55b788ed-9a3f-4db0-af62-560384810607",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "be7f2d40-3b58-4bf6-a165-99c1cd167fcb",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "6f43a9ba-f2e2-4b5f-8668-df47817e3547",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "92780c1e-a13f-4926-aa3a-0003d363815e",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "bf8ddf5b-9f48-43d4-abcf-05f0bc12c990",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "2da06e50-18e1-4d35-b27e-e0669c75f0f2",
            "db_currency_id": "e3b7b0b3-91cc-4bd6-b85d-2de0e0d8cc10",
            "db_language_id": "126df76e-1fca-422a-ac3f-654d23fd53a0",
            "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": "2024-06-17T23:22:06.4844064+00:00"
          },
          "modified_dateutc": "2024-06-17T23:22:06.4844064+00:00"
        },
        "equipment_family_id": "49fec9de-e6aa-4e8c-85ab-42e759d45858",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "6810e507-0edb-4809-8955-37d4a551965f",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "60a301be-918a-4203-8b65-65aa029bbf42",
          "_parent_code": "sample string 6",
          "sales_organization_id": "cf6c3026-1201-4e16-b166-d52abc8446dd",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "bf8ddf5b-9f48-43d4-abcf-05f0bc12c990",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "2da06e50-18e1-4d35-b27e-e0669c75f0f2",
            "db_currency_id": "e3b7b0b3-91cc-4bd6-b85d-2de0e0d8cc10",
            "db_language_id": "126df76e-1fca-422a-ac3f-654d23fd53a0",
            "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": "2024-06-17T23:22:06.4844064+00:00"
          },
          "modified_dateutc": "2024-06-17T23:22:06.4844064+00:00"
        },
        "date_in_production_since": "2024-06-17T23:22:06.4844064+00:00",
        "date_out_of_production_since": "2024-06-17T23:22:06.4844064+00:00",
        "date_end_support": "2024-06-17T23:22:06.4844064+00:00",
        "sales_organization_id": "f9dd185c-12e6-4b9e-b6e1-496a09f92ced",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "bf8ddf5b-9f48-43d4-abcf-05f0bc12c990",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "2da06e50-18e1-4d35-b27e-e0669c75f0f2",
          "db_currency_id": "e3b7b0b3-91cc-4bd6-b85d-2de0e0d8cc10",
          "db_language_id": "126df76e-1fca-422a-ac3f-654d23fd53a0",
          "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": "2024-06-17T23:22:06.4844064+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": "2024-06-17T23:22:06.4844064+00:00"
      },
      "project_status_id": "c38baa5f-ae69-4b5b-9715-10f05194275d",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "2e75259d-53fa-4d68-8b8b-20e8cb3d04f5",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "4c473bd1-d02f-4119-8312-2285d930485a",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "bf8ddf5b-9f48-43d4-abcf-05f0bc12c990",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "2da06e50-18e1-4d35-b27e-e0669c75f0f2",
          "db_currency_id": "e3b7b0b3-91cc-4bd6-b85d-2de0e0d8cc10",
          "db_language_id": "126df76e-1fca-422a-ac3f-654d23fd53a0",
          "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": "2024-06-17T23:22:06.4844064+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2024-06-17T23:22:06.4844064+00:00"
      },
      "company_id": "c5bbbc07-4732-4925-adfa-f65153cfad0c",
      "company_code": "sample string 12",
      "db_address_id": "3137b982-a2bc-4afd-a676-98f01a1453e0",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "7d5f6e07-2c18-4d95-b46f-c18e464bb8ab",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "8410c6e8-6db0-4be0-9f5d-3ff435a875f1",
      "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": "2024-06-17T23:22:06.4844064+00:00",
      "date_create": "2024-06-17T23:22:06.4844064+00:00",
      "date_update": "2024-06-17T23:22:06.4844064+00:00",
      "updated_by_user_id": "1fad18b1-d323-4ffc-966d-b76096559946",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2024-06-17T23:22:06.4844064+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": "2024-06-17T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2024-06-17T23:22:06.4844064+00:00",
      "date_last_job": "2024-06-17T23:22:06.4844064+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2024-06-17T23:22:06.4844064+00:00",
      "modified_dateutc": "2024-06-17T23:22:06.4844064+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "a01b61eb-3e27-4d87-a1fe-258cdc5bde27",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "e9755cae-8e83-49e6-b743-3d45683ac68a",
      "name": "sample string 2",
      "sales_organization_id": "270c000d-6662-49cc-a5f5-9a8c1bfb4785",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2024-06-17T23:22:06.4844064+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "1860bf2f-5182-413d-b811-c4f8e9a95c60",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "46fc7b2a-e710-462d-b491-6563acf6f555",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "449172df-6d63-4325-867a-6e7a7a840bda",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "bf8ddf5b-9f48-43d4-abcf-05f0bc12c990",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "2da06e50-18e1-4d35-b27e-e0669c75f0f2",
        "db_currency_id": "e3b7b0b3-91cc-4bd6-b85d-2de0e0d8cc10",
        "db_language_id": "126df76e-1fca-422a-ac3f-654d23fd53a0",
        "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": "2024-06-17T23:22:06.4844064+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2024-06-17T23:22:06.4844064+00:00"
    },
    "job_status_id": "6e40a20e-27df-40a0-8137-e721b095558d",
    "job_status_code": "sample string 11",
    "db_address_id": "139d36cc-9fc9-4d98-b2ad-296a61919101",
    "contact_id": "37757727-2a1e-4c61-99fe-499c63916561",
    "requested_by_company_id": "afc32254-e97f-4add-8bb5-0720b1af7823",
    "requested_by_contact_id": "2405cee0-05d7-4a87-842e-64bd55fecbaa",
    "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": "2024-06-17T23:22:06.4844064+00:00",
    "due_date": "2024-06-17T23:22:06.4844064+00:00",
    "date_create": "2024-06-17T23:22:06.4844064+00:00",
    "date_update": "2024-06-17T23:22:06.4844064+00:00",
    "date_closed": "2024-06-17T23:22:06.4844064+00:00",
    "suggested_user_id": "ff96c3bc-05a2-42c3-92b9-1738de12be24",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "bbe331d6-11a4-436c-b104-23e084a52e0e",
      "db_language_id": "51211bc0-8eee-4a2d-b0a2-b6a9da6aa623",
      "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": "2024-06-17T23:22:06.4844064+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "5bdbfc30-f340-4e51-bec5-0e3e129e4c39",
      "sales_organization": {
        "id": "bf8ddf5b-9f48-43d4-abcf-05f0bc12c990",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "2da06e50-18e1-4d35-b27e-e0669c75f0f2",
        "db_currency_id": "e3b7b0b3-91cc-4bd6-b85d-2de0e0d8cc10",
        "db_language_id": "126df76e-1fca-422a-ac3f-654d23fd53a0",
        "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": "2024-06-17T23:22:06.4844064+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "41efb439-4321-42bd-843e-22f2e641bcd0",
      "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": "19b8975b-4070-4688-8cc8-95e518863028",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2024-06-17T23:22:06.4844064+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "6544e895-2803-4c4e-8dd8-77f9589f2476"
    },
    "suggested_date_start": "2024-06-17T23:22:06.4844064+00:00",
    "skill_id": "1e301277-08b6-41a3-a03d-17df5a2a6858",
    "skill_code": "sample string 32",
    "skill": {
      "id": "140958bf-a6d6-4e7c-aa84-9e4656f90c96",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "f9b03cf9-19ee-4d11-b0ab-1c124ab8a7c8",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "bf8ddf5b-9f48-43d4-abcf-05f0bc12c990",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "2da06e50-18e1-4d35-b27e-e0669c75f0f2",
        "db_currency_id": "e3b7b0b3-91cc-4bd6-b85d-2de0e0d8cc10",
        "db_language_id": "126df76e-1fca-422a-ac3f-654d23fd53a0",
        "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": "2024-06-17T23:22:06.4844064+00:00"
      },
      "modified_dateutc": "2024-06-17T23:22:06.4844064+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "3888e7e9-97b8-4354-9042-fe0e93a67d19",
    "date_reported_by_company": "2024-06-17T23:22:06.4844064+00:00",
    "id2": 36,
    "company_id": "a656a86e-a1cb-479e-bef0-c271434b78ef",
    "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": "8692218a-26a7-462e-8d02-05da30040226",
    "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": "2024-06-17T23:22:06.4844064+00:00"
  },
  "work_instruction_details_id": "aecba88e-369f-4fd5-828c-3555c2f90fa2",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "4b2321a5-47ff-4b6a-8af0-24e2d23f3f52",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "84a1d178-5db7-4b1a-94b7-e49ea2d55624",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2024-06-17T23:22:06.4844064+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": "54b1be07-55c4-411c-8276-a1d331672988",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2024-06-17T23:22:06.4844064+00:00"
}