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": "23fc5d3b-5ffd-4030-b34a-b0e6f7269a2b",
  "jobs_id": "e4ea3291-4e29-4578-a520-d4dfc1041a84",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "0e81bd3c-eb7b-465b-a146-6827134e7703",
    "_parent_id": "d3c0c954-ac86-4b0c-88f0-f3515b408f5c",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "1068c8cb-2e37-4c1d-9801-698f0a033118",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "953af3d9-db6f-4139-a84e-8102293df0cc",
      "_parent_id": "082fa901-a3ee-4f0f-a0ee-21531da3a09a",
      "root_parent_id": "969da23e-ab09-4de3-a66d-2cbda7155c6e",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "9b5a5512-a310-4f3c-9665-b853dbbfeae9",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "aa1bfaf9-4132-4582-86e2-28c29c2c06a4",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "7fc37c59-f5a7-4441-a0c9-05c00c3784ec",
        "_parent_code": "sample string 6",
        "sales_organization_id": "07f74ecd-5f0c-4561-987a-663612eeaf16",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "61346d87-ecdc-40d0-b301-3138f9c6ebe5",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "17934b48-3942-4025-adb5-36dafabc187d",
          "db_currency_id": "606d7086-b2d3-46ec-ac0f-c9b9b7650b52",
          "db_language_id": "d76fda8d-fad6-44f6-b6f0-92ce93f73456",
          "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-16T15:54:29.366304+00:00"
        },
        "modified_dateutc": "2026-11-16T15:54:29.366304+00:00"
      },
      "equipment_model_id": "2dee8a3e-f97a-486f-b8f2-39ddea396d08",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "9bf6aeae-ab36-47dc-88ba-6cecf5930bbe",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "15ed5d92-bee4-4a22-b7ab-bed2cacabf09",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "7cc7991e-513d-45a6-91fc-f70df6d58636",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "addf9732-2505-46fa-a7b9-90c30fd6281b",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "61346d87-ecdc-40d0-b301-3138f9c6ebe5",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "17934b48-3942-4025-adb5-36dafabc187d",
            "db_currency_id": "606d7086-b2d3-46ec-ac0f-c9b9b7650b52",
            "db_language_id": "d76fda8d-fad6-44f6-b6f0-92ce93f73456",
            "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-16T15:54:29.366304+00:00"
          },
          "modified_dateutc": "2026-11-16T15:54:29.366304+00:00"
        },
        "equipment_family_id": "9e6eaa27-67c2-46f2-a198-13ef6abba2f8",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "aa1bfaf9-4132-4582-86e2-28c29c2c06a4",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "7fc37c59-f5a7-4441-a0c9-05c00c3784ec",
          "_parent_code": "sample string 6",
          "sales_organization_id": "07f74ecd-5f0c-4561-987a-663612eeaf16",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "61346d87-ecdc-40d0-b301-3138f9c6ebe5",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "17934b48-3942-4025-adb5-36dafabc187d",
            "db_currency_id": "606d7086-b2d3-46ec-ac0f-c9b9b7650b52",
            "db_language_id": "d76fda8d-fad6-44f6-b6f0-92ce93f73456",
            "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-16T15:54:29.366304+00:00"
          },
          "modified_dateutc": "2026-11-16T15:54:29.366304+00:00"
        },
        "date_in_production_since": "2026-11-16T15:54:29.366304+00:00",
        "date_out_of_production_since": "2026-11-16T15:54:29.366304+00:00",
        "date_end_support": "2026-11-16T15:54:29.366304+00:00",
        "sales_organization_id": "a1f9f94b-765c-42a2-b32d-e0533f4480da",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "61346d87-ecdc-40d0-b301-3138f9c6ebe5",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "17934b48-3942-4025-adb5-36dafabc187d",
          "db_currency_id": "606d7086-b2d3-46ec-ac0f-c9b9b7650b52",
          "db_language_id": "d76fda8d-fad6-44f6-b6f0-92ce93f73456",
          "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-16T15:54:29.366304+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-16T15:54:29.3821457+00:00"
      },
      "project_status_id": "48619dd6-6457-4de9-ad7f-a891b341f7ff",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "f8fe9ef5-e62f-4195-bb37-57e27023648b",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "55c03569-f637-43ee-b86e-ea8100c3de33",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "61346d87-ecdc-40d0-b301-3138f9c6ebe5",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "17934b48-3942-4025-adb5-36dafabc187d",
          "db_currency_id": "606d7086-b2d3-46ec-ac0f-c9b9b7650b52",
          "db_language_id": "d76fda8d-fad6-44f6-b6f0-92ce93f73456",
          "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-16T15:54:29.366304+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-11-16T15:54:29.3821457+00:00"
      },
      "company_id": "5c7aec9d-a4e7-4255-86a0-486cf93ca0d6",
      "company_code": "sample string 12",
      "db_address_id": "3f93f112-f5c7-4c32-8345-30d18a1031d1",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "60fe05b4-5449-497b-9080-2f91f73fce40",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "72a67c0f-f29b-406e-b414-28eb512098f3",
      "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-16T15:54:29.3821457+00:00",
      "date_create": "2026-11-16T15:54:29.3821457+00:00",
      "date_update": "2026-11-16T15:54:29.3821457+00:00",
      "updated_by_user_id": "4764ef2e-7321-4f94-a0e2-7f46059a7b93",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-11-16T15:54:29.3821457+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-16T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-11-16T15:54:29.3821457+00:00",
      "date_last_job": "2026-11-16T15:54:29.3821457+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-11-16T15:54:29.3821457+00:00",
      "modified_dateutc": "2026-11-16T15:54:29.3821457+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "7c70f4a1-ee43-40b9-9f03-29fc637de835",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "c285cabe-3b49-44d3-b20f-07513a2737a5",
      "name": "sample string 2",
      "sales_organization_id": "ef2b7c29-4b28-4934-95d8-26cbd5fbe77a",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-11-16T15:54:29.3821457+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "74f2533e-bceb-4b55-abc8-5067e0c02657",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "028df824-976b-4a33-9e4b-d92b31066af3",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "ad7bcedf-6929-447c-aa40-753fb80b2268",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "61346d87-ecdc-40d0-b301-3138f9c6ebe5",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "17934b48-3942-4025-adb5-36dafabc187d",
        "db_currency_id": "606d7086-b2d3-46ec-ac0f-c9b9b7650b52",
        "db_language_id": "d76fda8d-fad6-44f6-b6f0-92ce93f73456",
        "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-16T15:54:29.366304+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-11-16T15:54:29.3821457+00:00"
    },
    "job_status_id": "571ddbf3-e0b7-4949-9cf0-1c4f8ad7b16e",
    "job_status_code": "sample string 11",
    "db_address_id": "364c2e71-f1eb-4eeb-b79e-153180c43c8f",
    "contact_id": "e19b44ff-707c-4257-a260-ef232cad28d6",
    "requested_by_company_id": "065b346a-2b4c-4a97-bd6b-70094739448a",
    "requested_by_contact_id": "55d7f3f5-883a-4376-8f97-00921c8f4bbb",
    "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-16T15:54:29.3821457+00:00",
    "due_date": "2026-11-16T15:54:29.3821457+00:00",
    "date_create": "2026-11-16T15:54:29.3821457+00:00",
    "date_update": "2026-11-16T15:54:29.3821457+00:00",
    "date_closed": "2026-11-16T15:54:29.3821457+00:00",
    "suggested_user_id": "04159b31-b030-45ae-9f6e-98aebe6fb1df",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "4d4c1bcf-9313-4929-8616-cc8c999a7829",
      "db_language_id": "e54a3419-a549-4613-8274-802fdee1b3b7",
      "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-16T15:54:29.3821457+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "64901649-cd2a-40b5-9077-e7613fa61658",
      "sales_organization": {
        "id": "61346d87-ecdc-40d0-b301-3138f9c6ebe5",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "17934b48-3942-4025-adb5-36dafabc187d",
        "db_currency_id": "606d7086-b2d3-46ec-ac0f-c9b9b7650b52",
        "db_language_id": "d76fda8d-fad6-44f6-b6f0-92ce93f73456",
        "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-16T15:54:29.366304+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "3a7a6031-d9db-4bbc-b5b8-862c2403cb8e",
      "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": "dc0ef92c-6ed1-4051-9aff-bd9546b3bc57",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-11-16T15:54:29.3821457+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "234272fd-c487-4697-82c4-6c347d2ac2f7"
    },
    "suggested_date_start": "2026-11-16T15:54:29.3821457+00:00",
    "skill_id": "ba107e43-6f28-4396-9f3a-15bb0034a881",
    "skill_code": "sample string 32",
    "skill": {
      "id": "a01a9d14-7fc5-4424-a921-5741bcdce717",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "f76f9f58-67f0-4412-ba71-0ad7cde50801",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "61346d87-ecdc-40d0-b301-3138f9c6ebe5",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "17934b48-3942-4025-adb5-36dafabc187d",
        "db_currency_id": "606d7086-b2d3-46ec-ac0f-c9b9b7650b52",
        "db_language_id": "d76fda8d-fad6-44f6-b6f0-92ce93f73456",
        "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-16T15:54:29.366304+00:00"
      },
      "modified_dateutc": "2026-11-16T15:54:29.3821457+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "669638a9-4dfe-47ea-b89e-e70cc84dc5ba",
    "date_reported_by_company": "2026-11-16T15:54:29.3821457+00:00",
    "id2": 36,
    "company_id": "4a765207-9563-4e5d-81dc-35040a049bc9",
    "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": "f9297b5b-20ee-42ce-8301-93e3adf8f1d6",
    "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-16T15:54:29.3821457+00:00"
  },
  "work_instruction_details_id": "2385e044-13ff-4b88-99b1-7fbe80042446",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "513eb877-09cd-47f9-add6-e76551284dc6",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "73ef558e-aea4-4aa3-898c-b5c7d39c1e86",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-11-16T15:54:29.3821457+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": "c02efc6b-faf2-4cee-8595-db49c3231022",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-11-16T15:54:29.3821457+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.