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": "0970a210-7e47-4ea8-8d6c-4ae0fed1e048",
  "jobs_id": "641c5274-288b-48a3-bbb3-468318ec680a",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "717dedeb-fc83-41a4-8440-8a8636abb95b",
    "_parent_id": "5ce5386a-3a2c-4e1e-8a9d-e7c22f602b0a",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "b6aeacb2-3f82-4a60-bd8a-1b33f67063c4",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "8e00a331-9caf-421d-a7dd-6aa2d3a18fc5",
      "_parent_id": "94d3160d-2cd8-472d-bb50-b788b4cf6eb6",
      "root_parent_id": "0a926817-222d-420d-a83c-a9157aa3a92d",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "48e1f3c3-c935-4664-94df-3eda13ec2338",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "3678b494-2df3-4462-aca7-aca616215897",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "c8529eb4-a1df-496e-b599-dd114e861476",
        "_parent_code": "sample string 6",
        "sales_organization_id": "293b36bc-f3cc-458c-aaaa-53a21dcf50bb",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "7a05bc4a-b79c-4767-8d51-fa2be126e227",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "d5f25098-bc65-4490-9158-cdfc75772d5f",
          "db_currency_id": "2347970d-1efa-47b4-b87d-d5ff40d0d140",
          "db_language_id": "b4b4f95f-7607-49e4-9aa3-45f2c61e16cc",
          "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-11-19T10:40:43.6999671+00:00"
        },
        "modified_dateutc": "2026-11-19T10:40:43.6999671+00:00"
      },
      "equipment_model_id": "a7fd1d93-1b84-42ee-8fdb-076f131d3f4f",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "71b50084-94be-4467-a1ee-7f0fce100b01",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "0056d5c4-38aa-47c2-89f5-b51f08f2fe48",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "710ecfce-974a-408d-b640-e7db71ea3f26",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "374a1a87-886d-4fae-8ca4-c46ac097af90",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "7a05bc4a-b79c-4767-8d51-fa2be126e227",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "d5f25098-bc65-4490-9158-cdfc75772d5f",
            "db_currency_id": "2347970d-1efa-47b4-b87d-d5ff40d0d140",
            "db_language_id": "b4b4f95f-7607-49e4-9aa3-45f2c61e16cc",
            "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-11-19T10:40:43.6999671+00:00"
          },
          "modified_dateutc": "2026-11-19T10:40:43.6999671+00:00"
        },
        "equipment_family_id": "ef6af19e-e01a-4c18-810c-8af799f4ad62",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "3678b494-2df3-4462-aca7-aca616215897",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "c8529eb4-a1df-496e-b599-dd114e861476",
          "_parent_code": "sample string 6",
          "sales_organization_id": "293b36bc-f3cc-458c-aaaa-53a21dcf50bb",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "7a05bc4a-b79c-4767-8d51-fa2be126e227",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "d5f25098-bc65-4490-9158-cdfc75772d5f",
            "db_currency_id": "2347970d-1efa-47b4-b87d-d5ff40d0d140",
            "db_language_id": "b4b4f95f-7607-49e4-9aa3-45f2c61e16cc",
            "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-11-19T10:40:43.6999671+00:00"
          },
          "modified_dateutc": "2026-11-19T10:40:43.6999671+00:00"
        },
        "date_in_production_since": "2026-11-19T10:40:43.6999671+00:00",
        "date_out_of_production_since": "2026-11-19T10:40:43.6999671+00:00",
        "date_end_support": "2026-11-19T10:40:43.6999671+00:00",
        "sales_organization_id": "555536d6-14d9-4b6b-984a-ef85f357592e",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "7a05bc4a-b79c-4767-8d51-fa2be126e227",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "d5f25098-bc65-4490-9158-cdfc75772d5f",
          "db_currency_id": "2347970d-1efa-47b4-b87d-d5ff40d0d140",
          "db_language_id": "b4b4f95f-7607-49e4-9aa3-45f2c61e16cc",
          "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-11-19T10:40:43.6999671+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-11-19T10:40:43.6999671+00:00"
      },
      "project_status_id": "01153bcd-6408-4cbe-9161-196a82b021dd",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "a65009b4-aef7-4ce7-afcb-45fb218dc164",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "c256031f-20f4-48cc-b917-fc0a67dff701",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "7a05bc4a-b79c-4767-8d51-fa2be126e227",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "d5f25098-bc65-4490-9158-cdfc75772d5f",
          "db_currency_id": "2347970d-1efa-47b4-b87d-d5ff40d0d140",
          "db_language_id": "b4b4f95f-7607-49e4-9aa3-45f2c61e16cc",
          "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-11-19T10:40:43.6999671+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-11-19T10:40:43.6999671+00:00"
      },
      "company_id": "c4780b26-8818-4bbe-9a2a-ebeb404c15c5",
      "company_code": "sample string 12",
      "db_address_id": "7b21958d-64d4-414b-a2f2-5ace4b498ace",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "0248c918-6d83-4519-a04e-43e6bab15733",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "389b47e8-5dd3-4462-b654-11c7b626341e",
      "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-11-19T10:40:43.6999671+00:00",
      "date_create": "2026-11-19T10:40:43.6999671+00:00",
      "date_update": "2026-11-19T10:40:43.6999671+00:00",
      "updated_by_user_id": "6d37e4f0-cec9-49c6-bf7d-781441777adf",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-11-19T10:40:43.6999671+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-11-19T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-11-19T10:40:43.6999671+00:00",
      "date_last_job": "2026-11-19T10:40:43.6999671+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-11-19T10:40:43.6999671+00:00",
      "modified_dateutc": "2026-11-19T10:40:43.6999671+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "a95e758a-9109-4b69-a2bd-25234f574104",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "7500f460-c1dc-4349-8b43-89e3cf5450fe",
      "name": "sample string 2",
      "sales_organization_id": "0e8feb61-6a72-40eb-9a65-8cfa46e1048e",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-11-19T10:40:43.6999671+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "f23b3cb2-9099-461a-8516-744a38a91257",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "554da410-218d-4991-8197-d79673240c1e",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "d976acad-2a1c-47d3-b595-1e024a08cd8b",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "7a05bc4a-b79c-4767-8d51-fa2be126e227",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "d5f25098-bc65-4490-9158-cdfc75772d5f",
        "db_currency_id": "2347970d-1efa-47b4-b87d-d5ff40d0d140",
        "db_language_id": "b4b4f95f-7607-49e4-9aa3-45f2c61e16cc",
        "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-11-19T10:40:43.6999671+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-11-19T10:40:43.6999671+00:00"
    },
    "job_status_id": "2886bf5d-e84b-494a-9068-a42bb26fae71",
    "job_status_code": "sample string 11",
    "db_address_id": "c5251cf5-d007-41e7-9b48-e976a300b61b",
    "contact_id": "89907a9d-94c3-4b53-a262-9442d27a33d4",
    "requested_by_company_id": "4e491e8c-af8d-43fb-89d7-5f691235631d",
    "requested_by_contact_id": "7d2e28fb-8616-42a6-b192-a5a965c2cdb7",
    "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-11-19T10:40:43.6999671+00:00",
    "due_date": "2026-11-19T10:40:43.6999671+00:00",
    "date_create": "2026-11-19T10:40:43.6999671+00:00",
    "date_update": "2026-11-19T10:40:43.6999671+00:00",
    "date_closed": "2026-11-19T10:40:43.6999671+00:00",
    "suggested_user_id": "b51dc8ae-9fdc-4841-bb0b-779793d979fc",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "a5e3d6c0-ff90-4a5d-8941-20142e4473d5",
      "db_language_id": "24878664-7f22-4915-ba33-cd0d1917b91b",
      "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-11-19T10:40:43.6999671+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "01711a0a-1c0b-4875-8109-3bf80b73080e",
      "sales_organization": {
        "id": "7a05bc4a-b79c-4767-8d51-fa2be126e227",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "d5f25098-bc65-4490-9158-cdfc75772d5f",
        "db_currency_id": "2347970d-1efa-47b4-b87d-d5ff40d0d140",
        "db_language_id": "b4b4f95f-7607-49e4-9aa3-45f2c61e16cc",
        "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-11-19T10:40:43.6999671+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "002bbdcd-5847-45f3-910e-24b4a71020a6",
      "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": "0aeced01-c133-49ef-bd31-13372ff491f8",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-11-19T10:40:43.6999671+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "f370cdcf-09f6-41ad-b95a-25045f8a2b9d"
    },
    "suggested_date_start": "2026-11-19T10:40:43.6999671+00:00",
    "skill_id": "ee2d124a-9c5b-4f03-a47f-619ac2db8c29",
    "skill_code": "sample string 32",
    "skill": {
      "id": "f71839dc-96c7-44f9-a004-a096d10593d6",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "54d589c1-0a25-43b9-94f9-54a2836f9a33",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "7a05bc4a-b79c-4767-8d51-fa2be126e227",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "d5f25098-bc65-4490-9158-cdfc75772d5f",
        "db_currency_id": "2347970d-1efa-47b4-b87d-d5ff40d0d140",
        "db_language_id": "b4b4f95f-7607-49e4-9aa3-45f2c61e16cc",
        "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-11-19T10:40:43.6999671+00:00"
      },
      "modified_dateutc": "2026-11-19T10:40:43.6999671+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "cf903b78-c5d6-40c3-9e3d-f2f9289872c3",
    "date_reported_by_company": "2026-11-19T10:40:43.6999671+00:00",
    "id2": 36,
    "company_id": "56caf914-8fc0-4b72-be38-15963c2eec75",
    "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": "4c80e85d-acdb-47d0-b7c2-960675b1fe2a",
    "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-11-19T10:40:43.6999671+00:00"
  },
  "work_instruction_details_id": "f3d3c640-6680-40f9-a641-83bc1322d82f",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "2a67741d-bf3f-40b2-b86c-7385ce0a1911",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "39bfe8e7-b3fe-4860-808d-1f7e7206abeb",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-11-19T10:40:43.6999671+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": "e797fff5-6be7-4e32-93dd-5ca58d2af2a2",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-11-19T10:40:43.7128143+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.