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": "017a8fda-6d8a-46eb-b0f5-8176b44e8744",
  "jobs_id": "00d6539f-3f02-49ab-bbf4-0965ba8d9380",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "0e7907c8-c70b-42ef-9f66-1d2f2eab2511",
    "_parent_id": "a415b5c0-8bf0-4af3-a5c6-1ac4091d17e3",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "22b1f2bd-ce63-426b-ad21-79ba043f94df",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "87b755dd-8d7f-4dae-9bfa-4e4b20f3ddfc",
      "_parent_id": "d5f71fdb-fcef-4ac0-95b8-8b118992ff26",
      "root_parent_id": "3287b2fa-b593-43cc-9203-8b922d8d1e2f",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "4d6d34ba-6be8-4d2f-8ffb-4051bd95187e",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "738a24f4-a921-4c6f-9581-5182810a5027",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "0d17cbf0-5af6-4ef5-b5e5-4d75f0cf0506",
        "_parent_code": "sample string 6",
        "sales_organization_id": "30262385-adc4-48a3-8998-2933efb75ce3",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "947af24f-1e53-4a00-9e91-3b1fed593802",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "a6e63b7a-c8be-49ca-b809-936cec89ec8a",
          "db_currency_id": "47f0ab25-a978-4d7c-b7ed-c74d03cb4d18",
          "db_language_id": "f7e6d094-4e1b-4376-95ec-067f0abf881f",
          "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-20T12:48:55.1790897+00:00"
        },
        "modified_dateutc": "2026-11-20T12:48:55.1790897+00:00"
      },
      "equipment_model_id": "10c6d7a7-9911-4e30-9737-681fc24502df",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "45824b69-1300-43e5-9175-65fd54d5e03a",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "9eaaaf1f-8a1c-47f2-a577-9f1513e7887b",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "07577396-9e37-44ec-af1c-c51de6fab6db",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "3daa776c-96e7-4ef1-a732-4d149baf9d47",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "947af24f-1e53-4a00-9e91-3b1fed593802",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "a6e63b7a-c8be-49ca-b809-936cec89ec8a",
            "db_currency_id": "47f0ab25-a978-4d7c-b7ed-c74d03cb4d18",
            "db_language_id": "f7e6d094-4e1b-4376-95ec-067f0abf881f",
            "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-20T12:48:55.1790897+00:00"
          },
          "modified_dateutc": "2026-11-20T12:48:55.1790897+00:00"
        },
        "equipment_family_id": "30e8be2c-185f-4802-aaea-cb2fddf441f9",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "738a24f4-a921-4c6f-9581-5182810a5027",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "0d17cbf0-5af6-4ef5-b5e5-4d75f0cf0506",
          "_parent_code": "sample string 6",
          "sales_organization_id": "30262385-adc4-48a3-8998-2933efb75ce3",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "947af24f-1e53-4a00-9e91-3b1fed593802",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "a6e63b7a-c8be-49ca-b809-936cec89ec8a",
            "db_currency_id": "47f0ab25-a978-4d7c-b7ed-c74d03cb4d18",
            "db_language_id": "f7e6d094-4e1b-4376-95ec-067f0abf881f",
            "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-20T12:48:55.1790897+00:00"
          },
          "modified_dateutc": "2026-11-20T12:48:55.1790897+00:00"
        },
        "date_in_production_since": "2026-11-20T12:48:55.1790897+00:00",
        "date_out_of_production_since": "2026-11-20T12:48:55.1790897+00:00",
        "date_end_support": "2026-11-20T12:48:55.1790897+00:00",
        "sales_organization_id": "1ef3752e-602e-42c9-855b-b34499c285dc",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "947af24f-1e53-4a00-9e91-3b1fed593802",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "a6e63b7a-c8be-49ca-b809-936cec89ec8a",
          "db_currency_id": "47f0ab25-a978-4d7c-b7ed-c74d03cb4d18",
          "db_language_id": "f7e6d094-4e1b-4376-95ec-067f0abf881f",
          "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-20T12:48:55.1790897+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-20T12:48:55.1790897+00:00"
      },
      "project_status_id": "5d07546f-8d55-44dd-a5a2-ee73e9d5eb2b",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "a24b7de4-9935-4a89-ab40-134cb3a650a6",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "60022cf8-ef06-4cbf-874d-84a0b9f67fbf",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "947af24f-1e53-4a00-9e91-3b1fed593802",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "a6e63b7a-c8be-49ca-b809-936cec89ec8a",
          "db_currency_id": "47f0ab25-a978-4d7c-b7ed-c74d03cb4d18",
          "db_language_id": "f7e6d094-4e1b-4376-95ec-067f0abf881f",
          "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-20T12:48:55.1790897+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-11-20T12:48:55.1790897+00:00"
      },
      "company_id": "97b6ff05-b6cd-4af9-a01d-48e7a47ad4cc",
      "company_code": "sample string 12",
      "db_address_id": "d26cab3c-1b00-4ce4-84ba-400a04b38f08",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "ded9c05e-207d-4fc7-8fea-5df3ce79972b",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "513a4f08-662d-42a6-abac-707c8207ab9f",
      "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-20T12:48:55.1947126+00:00",
      "date_create": "2026-11-20T12:48:55.1947126+00:00",
      "date_update": "2026-11-20T12:48:55.1947126+00:00",
      "updated_by_user_id": "4aa4e2ad-f7fc-4184-971c-a44be52af520",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-11-20T12:48:55.1947126+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-20T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-11-20T12:48:55.1947126+00:00",
      "date_last_job": "2026-11-20T12:48:55.1947126+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-11-20T12:48:55.1947126+00:00",
      "modified_dateutc": "2026-11-20T12:48:55.1947126+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "cf565351-d55e-43ab-8a93-8d98754b4bdb",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "5ed56ecf-eb93-46c1-8f8b-9d6a1495f7bd",
      "name": "sample string 2",
      "sales_organization_id": "f41dbda3-679d-4780-941f-869a41848fe1",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-11-20T12:48:55.1947126+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "60d7b5af-22e1-4b3b-b9d6-c34ce906ee93",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "f26bb985-165e-4b75-b680-496ee3f3b891",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "e6e62382-eaed-48d7-850a-6099d6e0f318",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "947af24f-1e53-4a00-9e91-3b1fed593802",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "a6e63b7a-c8be-49ca-b809-936cec89ec8a",
        "db_currency_id": "47f0ab25-a978-4d7c-b7ed-c74d03cb4d18",
        "db_language_id": "f7e6d094-4e1b-4376-95ec-067f0abf881f",
        "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-20T12:48:55.1790897+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-11-20T12:48:55.1947126+00:00"
    },
    "job_status_id": "8f36368f-f8a5-4191-83a9-b0184750eeee",
    "job_status_code": "sample string 11",
    "db_address_id": "4ab1d1af-51e4-4cfb-93ec-44e4b99f591f",
    "contact_id": "d732170e-8eea-444b-8a02-850fd5759150",
    "requested_by_company_id": "0e4814ba-50b4-4e7a-b46e-54266e4cf7d2",
    "requested_by_contact_id": "d75e7a7d-e6a0-4ca3-b46d-6d38a0daecdf",
    "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-20T12:48:55.1947126+00:00",
    "due_date": "2026-11-20T12:48:55.1947126+00:00",
    "date_create": "2026-11-20T12:48:55.1947126+00:00",
    "date_update": "2026-11-20T12:48:55.1947126+00:00",
    "date_closed": "2026-11-20T12:48:55.1947126+00:00",
    "suggested_user_id": "0fae0296-8471-4edb-88d2-2d6c1703b720",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "dcc96802-77a0-4238-ae82-def3d66f9fba",
      "db_language_id": "4d79d078-a3d2-41b4-a134-74bad514f302",
      "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-20T12:48:55.1947126+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "97e30370-ebaa-4a71-ba4c-bca8b6e22450",
      "sales_organization": {
        "id": "947af24f-1e53-4a00-9e91-3b1fed593802",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "a6e63b7a-c8be-49ca-b809-936cec89ec8a",
        "db_currency_id": "47f0ab25-a978-4d7c-b7ed-c74d03cb4d18",
        "db_language_id": "f7e6d094-4e1b-4376-95ec-067f0abf881f",
        "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-20T12:48:55.1790897+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "1696e6c7-f9d4-417b-8f42-bddb27406cfc",
      "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": "95fc61f9-5e60-4353-afef-9709ddf25ac7",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-11-20T12:48:55.1947126+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "e069be9d-c453-4c62-96e0-c754b40b64bc"
    },
    "suggested_date_start": "2026-11-20T12:48:55.1947126+00:00",
    "skill_id": "c8cbc8e3-761c-44cc-b033-49ef6afcb0e6",
    "skill_code": "sample string 32",
    "skill": {
      "id": "0fc05a44-6763-4465-9e79-96f57fb93089",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "cc5f4a7d-fac8-4065-be43-49a8859a24b2",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "947af24f-1e53-4a00-9e91-3b1fed593802",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "a6e63b7a-c8be-49ca-b809-936cec89ec8a",
        "db_currency_id": "47f0ab25-a978-4d7c-b7ed-c74d03cb4d18",
        "db_language_id": "f7e6d094-4e1b-4376-95ec-067f0abf881f",
        "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-20T12:48:55.1790897+00:00"
      },
      "modified_dateutc": "2026-11-20T12:48:55.1947126+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "6f4b86a9-f2d4-41f2-ac5a-b6b174b0e40f",
    "date_reported_by_company": "2026-11-20T12:48:55.1947126+00:00",
    "id2": 36,
    "company_id": "366f0d5c-efcd-44c2-9122-8de5b65ee983",
    "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": "cbfb0523-cb5f-4928-b3bc-9d3e2b2a16ba",
    "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-20T12:48:55.1947126+00:00"
  },
  "work_instruction_details_id": "60fc6b2c-674e-480c-9b7d-d943e9f58dfc",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "1ee85c7a-b81b-469b-a424-4703aad08c22",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "bb644d05-7881-4eb2-bd74-95e227444aa2",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-11-20T12:48:55.1947126+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": "12906f73-2832-40fd-9862-7a70db5ed755",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-11-20T12:48:55.1947126+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.