Updates the job work instruction list with the specified key

Request Information

URI Parameters :

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters :

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

Request Formats :

application/json, text/json

Sample:
{
  "id": "51911a39-008f-497c-ab79-85b28ed64936",
  "jobs_id": "85001a8c-06be-4b67-a77b-260c6e95040a",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "3a52dcb5-9d67-48c8-9689-193d1f22d8a5",
    "_parent_id": "5d9bf15a-f1e7-4f66-9a66-4eb18b906187",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "f375c4cb-6c53-429a-aad0-5b74e51a9e33",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "bf61688a-2fed-4973-a858-c8c4b286ab58",
      "_parent_id": "76bd5bd1-defe-405f-985a-23e34d73c013",
      "root_parent_id": "b0a744ff-e9db-41f7-bf1e-d5feb729f07b",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "202aa8eb-21af-4935-8c26-0e863b7ed1b6",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "5d7962b1-246e-4329-b103-3dc5bd235349",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "fbd8d988-17fe-4c7a-9f20-0a65e14ed665",
        "_parent_code": "sample string 6",
        "sales_organization_id": "f7570f39-065b-4121-a80f-6781349fbb6e",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "d914fc3e-7177-48e2-a458-30a81855d823",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "f08938b6-2e33-44a2-a3bc-3368d387206c",
          "db_currency_id": "0e048242-3c05-4479-93df-4c8db28ed3d9",
          "db_language_id": "ec440211-55d5-4a98-ac5e-a6a52959f015",
          "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": "2026-05-21T15:29:33.3057149+00:00"
        },
        "modified_dateutc": "2026-05-21T15:29:33.3057149+00:00"
      },
      "equipment_model_id": "b4c7a2f4-79ee-4b35-89f6-4626d3a22f63",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "f6812e82-0a4d-417d-8cb7-11fdab7d6e22",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "fc083de5-50e8-40f7-bead-d3e91174f32d",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "6bb28b2e-3008-4ab9-b0bd-c48bb08dac8e",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "5341bff0-bb07-4c7b-a47e-2a0512689a55",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "d914fc3e-7177-48e2-a458-30a81855d823",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "f08938b6-2e33-44a2-a3bc-3368d387206c",
            "db_currency_id": "0e048242-3c05-4479-93df-4c8db28ed3d9",
            "db_language_id": "ec440211-55d5-4a98-ac5e-a6a52959f015",
            "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": "2026-05-21T15:29:33.3057149+00:00"
          },
          "modified_dateutc": "2026-05-21T15:29:33.3057149+00:00"
        },
        "equipment_family_id": "504e7c0a-3190-4c3d-962e-f6eef9055241",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "5d7962b1-246e-4329-b103-3dc5bd235349",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "fbd8d988-17fe-4c7a-9f20-0a65e14ed665",
          "_parent_code": "sample string 6",
          "sales_organization_id": "f7570f39-065b-4121-a80f-6781349fbb6e",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "d914fc3e-7177-48e2-a458-30a81855d823",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "f08938b6-2e33-44a2-a3bc-3368d387206c",
            "db_currency_id": "0e048242-3c05-4479-93df-4c8db28ed3d9",
            "db_language_id": "ec440211-55d5-4a98-ac5e-a6a52959f015",
            "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": "2026-05-21T15:29:33.3057149+00:00"
          },
          "modified_dateutc": "2026-05-21T15:29:33.3057149+00:00"
        },
        "date_in_production_since": "2026-05-21T15:29:33.3057149+00:00",
        "date_out_of_production_since": "2026-05-21T15:29:33.3057149+00:00",
        "date_end_support": "2026-05-21T15:29:33.3057149+00:00",
        "sales_organization_id": "ba8949e0-0b61-48d0-a7a1-dc97b61da62d",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "d914fc3e-7177-48e2-a458-30a81855d823",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "f08938b6-2e33-44a2-a3bc-3368d387206c",
          "db_currency_id": "0e048242-3c05-4479-93df-4c8db28ed3d9",
          "db_language_id": "ec440211-55d5-4a98-ac5e-a6a52959f015",
          "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": "2026-05-21T15:29:33.3057149+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": "2026-05-21T15:29:33.3057149+00:00"
      },
      "project_status_id": "aff0fb1c-4d69-4145-a5bc-f5d806a14727",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "7a2589b8-8861-4061-b31c-b0ce96eb3be2",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "38d7575a-474a-480a-87a5-abe87b682eab",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "d914fc3e-7177-48e2-a458-30a81855d823",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "f08938b6-2e33-44a2-a3bc-3368d387206c",
          "db_currency_id": "0e048242-3c05-4479-93df-4c8db28ed3d9",
          "db_language_id": "ec440211-55d5-4a98-ac5e-a6a52959f015",
          "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": "2026-05-21T15:29:33.3057149+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-05-21T15:29:33.3057149+00:00"
      },
      "company_id": "ac37df6e-a095-4e1c-bea3-61c9e2b986c7",
      "company_code": "sample string 12",
      "db_address_id": "8b5cdf38-036f-4e2f-ab1e-86ef234d2780",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "3522ee58-400b-4fd9-828d-4e8fd2bc9a09",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "5b471b10-0c7e-43f7-a570-c633e59876c2",
      "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": "2026-05-21T15:29:33.3057149+00:00",
      "date_create": "2026-05-21T15:29:33.3057149+00:00",
      "date_update": "2026-05-21T15:29:33.3057149+00:00",
      "updated_by_user_id": "c90836e1-f3c2-4ce5-8c8e-6a406ac87067",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-05-21T15:29:33.3057149+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": "2026-05-21T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-05-21T15:29:33.3057149+00:00",
      "date_last_job": "2026-05-21T15:29:33.3057149+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-05-21T15:29:33.3057149+00:00",
      "modified_dateutc": "2026-05-21T15:29:33.3057149+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "ab51241e-c574-47e2-a863-80a3404c80f2",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "9adc97de-8107-4bbd-80d5-8cad7d2c3090",
      "name": "sample string 2",
      "sales_organization_id": "26f968e4-d95e-46e5-af21-11391de0647f",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-05-21T15:29:33.3057149+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "57c6632b-8d46-4555-9132-2086c537b3b6",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "d39ddd3a-fd9f-4552-b071-b7a8fd85dd3b",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "d558c9cb-bb9e-4ebf-8865-119dd6aabc8b",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "d914fc3e-7177-48e2-a458-30a81855d823",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "f08938b6-2e33-44a2-a3bc-3368d387206c",
        "db_currency_id": "0e048242-3c05-4479-93df-4c8db28ed3d9",
        "db_language_id": "ec440211-55d5-4a98-ac5e-a6a52959f015",
        "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": "2026-05-21T15:29:33.3057149+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-05-21T15:29:33.3057149+00:00"
    },
    "job_status_id": "431df1c1-7db7-44a4-aac5-14e7e01d3dbf",
    "job_status_code": "sample string 11",
    "db_address_id": "9170624d-65d8-4008-8f71-9561d58b7df8",
    "contact_id": "4c6c4b7d-22f1-454a-a5e4-0dd32b74d779",
    "requested_by_company_id": "a9670f9d-c973-41f6-b262-1f8f79cd0f91",
    "requested_by_contact_id": "025e6e0d-d350-474a-894e-bead608a0c02",
    "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": "2026-05-21T15:29:33.3057149+00:00",
    "due_date": "2026-05-21T15:29:33.3057149+00:00",
    "date_create": "2026-05-21T15:29:33.3057149+00:00",
    "date_update": "2026-05-21T15:29:33.3057149+00:00",
    "date_closed": "2026-05-21T15:29:33.3057149+00:00",
    "suggested_user_id": "db99f843-5438-48c7-88b5-13a550c4c264",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "2aebb172-7cfa-4307-8326-979c9271344c",
      "db_language_id": "1d18277c-66e9-4b7a-ba8e-934b2dd8c8ea",
      "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": "2026-05-21T15:29:33.3057149+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "6daa575e-eace-4ab8-b6a4-f382e0558092",
      "sales_organization": {
        "id": "d914fc3e-7177-48e2-a458-30a81855d823",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "f08938b6-2e33-44a2-a3bc-3368d387206c",
        "db_currency_id": "0e048242-3c05-4479-93df-4c8db28ed3d9",
        "db_language_id": "ec440211-55d5-4a98-ac5e-a6a52959f015",
        "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": "2026-05-21T15:29:33.3057149+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "3ea9fb14-af88-4891-b870-6f55fa890d52",
      "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": "5b557864-8430-4456-956b-2f2f7698250b",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-05-21T15:29:33.3057149+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "15fcd96b-79fb-4f7a-9e24-87c9b6d1f389"
    },
    "suggested_date_start": "2026-05-21T15:29:33.3057149+00:00",
    "skill_id": "4789b8e2-63da-41d6-8112-a3544bf26570",
    "skill_code": "sample string 32",
    "skill": {
      "id": "69d482f1-65dd-4ce2-a111-39d700343341",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "285f7072-473c-437c-a928-fca297b72665",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "d914fc3e-7177-48e2-a458-30a81855d823",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "f08938b6-2e33-44a2-a3bc-3368d387206c",
        "db_currency_id": "0e048242-3c05-4479-93df-4c8db28ed3d9",
        "db_language_id": "ec440211-55d5-4a98-ac5e-a6a52959f015",
        "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": "2026-05-21T15:29:33.3057149+00:00"
      },
      "modified_dateutc": "2026-05-21T15:29:33.3057149+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "5801e68a-86f1-42bc-a15e-ee6d0312e0b1",
    "date_reported_by_company": "2026-05-21T15:29:33.3057149+00:00",
    "id2": 36,
    "company_id": "11ba930e-8963-461d-b334-630f529cf842",
    "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": "302dfa6d-e2a6-4664-935d-b1bb93a4b43c",
    "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": "2026-05-21T15:29:33.3057149+00:00"
  },
  "work_instruction_details_id": "7d418706-67db-4fcd-981b-0bf0db5b89b5",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "e8187c04-9b78-4767-bef3-e6e276ea168d",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "c4fe6868-5f7e-42ec-b77b-51f79f02c8ea",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-05-21T15:29:33.3057149+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": "b203ac61-e8c5-4caa-9529-b5f270da811e",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-05-21T15:29:33.3057149+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.