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": "db0b5dba-88ee-45e4-a4cd-eb2c878266a3",
  "jobs_id": "7d423575-6064-4449-936e-71e90f35ec52",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "2e1e8d67-5a56-4785-a7d1-9af57c2109f4",
    "_parent_id": "041a0981-a379-407b-9427-4fb9ccf21f95",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "4bdacbd3-c058-4347-8137-b913a93894ba",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "6652905f-295b-4a16-9dcd-55da3b825bb2",
      "_parent_id": "35ba68dc-f5b1-4001-86ee-fd8352958290",
      "root_parent_id": "7f59eb38-6f62-428f-a122-449e1320fb8b",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "6f911805-60b8-407d-a21d-e1f170210d5b",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "4b990de6-6d54-4816-bc83-1b8d2e4a007b",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "203ada71-9f8a-43c4-a03c-b9adc239c1e4",
        "_parent_code": "sample string 6",
        "sales_organization_id": "00bc6d60-bd24-4760-9ef2-22afa375fe3b",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "677a249e-df67-48e2-a809-fc545b8a138f",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "a96089a1-172a-4d63-a94b-c69687a31d2f",
          "db_currency_id": "258597b7-cb52-44a9-8383-05267306795f",
          "db_language_id": "131c46d9-e10d-4a1c-9ff0-c3e890edf4e2",
          "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-04-30T13:19:59.1728038+00:00"
        },
        "modified_dateutc": "2026-04-30T13:19:59.1728038+00:00"
      },
      "equipment_model_id": "697f943c-f3a9-4405-a3df-8c676d7478e9",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "874aa128-57bd-4ae3-955f-5d267af983da",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "9527cabd-e340-413f-a6ec-1d10fe49cfd9",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "9064b368-c7e8-490f-ab19-13258f7023c7",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "bb2b776e-72d9-488b-ab37-d28b7034b2a9",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "677a249e-df67-48e2-a809-fc545b8a138f",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "a96089a1-172a-4d63-a94b-c69687a31d2f",
            "db_currency_id": "258597b7-cb52-44a9-8383-05267306795f",
            "db_language_id": "131c46d9-e10d-4a1c-9ff0-c3e890edf4e2",
            "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-04-30T13:19:59.1728038+00:00"
          },
          "modified_dateutc": "2026-04-30T13:19:59.1728038+00:00"
        },
        "equipment_family_id": "e9339876-a2e2-4c73-b29a-c437cfb15e8c",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "4b990de6-6d54-4816-bc83-1b8d2e4a007b",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "203ada71-9f8a-43c4-a03c-b9adc239c1e4",
          "_parent_code": "sample string 6",
          "sales_organization_id": "00bc6d60-bd24-4760-9ef2-22afa375fe3b",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "677a249e-df67-48e2-a809-fc545b8a138f",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "a96089a1-172a-4d63-a94b-c69687a31d2f",
            "db_currency_id": "258597b7-cb52-44a9-8383-05267306795f",
            "db_language_id": "131c46d9-e10d-4a1c-9ff0-c3e890edf4e2",
            "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-04-30T13:19:59.1728038+00:00"
          },
          "modified_dateutc": "2026-04-30T13:19:59.1728038+00:00"
        },
        "date_in_production_since": "2026-04-30T13:19:59.1728038+00:00",
        "date_out_of_production_since": "2026-04-30T13:19:59.1728038+00:00",
        "date_end_support": "2026-04-30T13:19:59.1728038+00:00",
        "sales_organization_id": "f0d0a499-3f1d-49cb-a8ac-76cd4055587d",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "677a249e-df67-48e2-a809-fc545b8a138f",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "a96089a1-172a-4d63-a94b-c69687a31d2f",
          "db_currency_id": "258597b7-cb52-44a9-8383-05267306795f",
          "db_language_id": "131c46d9-e10d-4a1c-9ff0-c3e890edf4e2",
          "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-04-30T13:19:59.1728038+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-04-30T13:19:59.1728038+00:00"
      },
      "project_status_id": "835ab15b-8ddc-4ded-b117-391636c61b53",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "3b71d34e-ee5c-4ecc-8db8-fa606f5b2e5f",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "b4569b21-13ec-407d-8200-5081ed3f6af6",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "677a249e-df67-48e2-a809-fc545b8a138f",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "a96089a1-172a-4d63-a94b-c69687a31d2f",
          "db_currency_id": "258597b7-cb52-44a9-8383-05267306795f",
          "db_language_id": "131c46d9-e10d-4a1c-9ff0-c3e890edf4e2",
          "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-04-30T13:19:59.1728038+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-04-30T13:19:59.1728038+00:00"
      },
      "company_id": "9ab90f7c-bac2-4cc3-9b5b-f4216f6cf79e",
      "company_code": "sample string 12",
      "db_address_id": "acbd5bb4-31b9-4d60-a7f8-aaacc2cb66fe",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "12b1817a-a756-4e7d-94c6-df92e084215c",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "af90c5c0-583b-4187-8d59-f1b2f96a64c2",
      "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-04-30T13:19:59.1728038+00:00",
      "date_create": "2026-04-30T13:19:59.1728038+00:00",
      "date_update": "2026-04-30T13:19:59.1728038+00:00",
      "updated_by_user_id": "e5f97572-c1ac-41e0-adf0-acc6bf6f1d0f",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-04-30T13:19:59.1728038+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-04-30T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-04-30T13:19:59.1728038+00:00",
      "date_last_job": "2026-04-30T13:19:59.1728038+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-04-30T13:19:59.1728038+00:00",
      "modified_dateutc": "2026-04-30T13:19:59.1728038+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "433196f0-c461-4cae-abdb-e9b512412230",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "6254c380-8877-43ba-b723-c32d70dee683",
      "name": "sample string 2",
      "sales_organization_id": "bde490bb-0314-4582-bc6c-2aa75c01ccec",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-04-30T13:19:59.1728038+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "bb9b8ea3-b09f-4acd-8531-663c58c7fccb",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "badb81c3-b937-4c57-b108-c029dfc23c2d",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "7112886c-2f9f-4eb5-a100-7fd6ba48efb2",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "677a249e-df67-48e2-a809-fc545b8a138f",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "a96089a1-172a-4d63-a94b-c69687a31d2f",
        "db_currency_id": "258597b7-cb52-44a9-8383-05267306795f",
        "db_language_id": "131c46d9-e10d-4a1c-9ff0-c3e890edf4e2",
        "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-04-30T13:19:59.1728038+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-04-30T13:19:59.1728038+00:00"
    },
    "job_status_id": "5225610c-cfb0-490e-8f9b-dcbc3781c9f2",
    "job_status_code": "sample string 11",
    "db_address_id": "1ab9b7c9-ab06-4ac5-ae2a-a8b70a2865cc",
    "contact_id": "1240cadf-5045-4728-a60a-c91e8d36f765",
    "requested_by_company_id": "c950436d-d735-4f8b-9c3d-7299ad29c020",
    "requested_by_contact_id": "99b03bde-a9f8-4249-8ebf-f60af7ae0f54",
    "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-04-30T13:19:59.1728038+00:00",
    "due_date": "2026-04-30T13:19:59.1728038+00:00",
    "date_create": "2026-04-30T13:19:59.1728038+00:00",
    "date_update": "2026-04-30T13:19:59.1728038+00:00",
    "date_closed": "2026-04-30T13:19:59.1728038+00:00",
    "suggested_user_id": "9fba912f-52eb-4992-b64a-18344f37df78",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "5b4a4cdc-2edc-4048-b330-d8513ec509a2",
      "db_language_id": "c71ab9fa-0418-4e3b-bd63-b60a5030de1b",
      "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-04-30T13:19:59.1728038+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "7c4b9e04-f6a3-424c-89b1-0bc5e23b489b",
      "sales_organization": {
        "id": "677a249e-df67-48e2-a809-fc545b8a138f",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "a96089a1-172a-4d63-a94b-c69687a31d2f",
        "db_currency_id": "258597b7-cb52-44a9-8383-05267306795f",
        "db_language_id": "131c46d9-e10d-4a1c-9ff0-c3e890edf4e2",
        "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-04-30T13:19:59.1728038+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "3bef5658-afde-47d0-8b32-0562712e1731",
      "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": "3771eeb3-6a1b-40cf-8ed3-077c6913a397",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-04-30T13:19:59.1728038+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "42a6eacb-9591-4200-a0ea-b7a6daabbf53"
    },
    "suggested_date_start": "2026-04-30T13:19:59.1728038+00:00",
    "skill_id": "419b88bb-f8c5-485a-91dd-db1d91c402b6",
    "skill_code": "sample string 32",
    "skill": {
      "id": "e1034f78-0d3d-4499-8b17-689be5a563fc",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "1f464561-21a1-4f43-9981-39ca56096716",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "677a249e-df67-48e2-a809-fc545b8a138f",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "a96089a1-172a-4d63-a94b-c69687a31d2f",
        "db_currency_id": "258597b7-cb52-44a9-8383-05267306795f",
        "db_language_id": "131c46d9-e10d-4a1c-9ff0-c3e890edf4e2",
        "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-04-30T13:19:59.1728038+00:00"
      },
      "modified_dateutc": "2026-04-30T13:19:59.1728038+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "3dabebb2-4fea-495d-b5bb-988322fe9b2a",
    "date_reported_by_company": "2026-04-30T13:19:59.1728038+00:00",
    "id2": 36,
    "company_id": "490a0089-6d13-445d-89b3-211db148fae5",
    "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": "9641cbff-23a7-42a7-b019-f8680b22419d",
    "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-04-30T13:19:59.1728038+00:00"
  },
  "work_instruction_details_id": "488192ba-14ca-4f9d-9fc3-937075f6f4f9",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "2b4dad9e-8809-4a4f-af3a-6f4885757926",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "a633ebb4-2dbf-4e98-a12d-714866821b28",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-04-30T13:19:59.1728038+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": "e09ff59b-1c33-4ae5-b424-bde1a73830bc",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-04-30T13:19:59.1728038+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.