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": "e853bd87-a091-4f3b-b085-2846eb420de6",
  "jobs_id": "9bbde945-3a59-44f7-807b-928692de8c6b",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "cdaedd1b-493f-4f37-9048-d8d3d16e7bc8",
    "_parent_id": "e8cc8fd9-81c3-472d-b273-d051d931fca2",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "073d5a57-c527-4e49-bd19-020dfa7d57fe",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "80e615c7-7876-40cf-9866-1d029240500f",
      "_parent_id": "ec3fc119-afdc-47d3-a45e-5f8d74fc4af7",
      "root_parent_id": "027791c3-c00e-4f33-8481-e730941e6273",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "0c55498b-c695-4d30-a8c3-f3409bb0933c",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "58365e79-c63a-46c3-aaaf-5c6bfa7f9f45",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "f88a3740-61a5-4d37-aba1-eb98b658ed2e",
        "_parent_code": "sample string 6",
        "sales_organization_id": "0384036a-9a76-45f2-964a-537a7767eac1",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "13784ff3-5621-44ed-a4a9-fc98d53c632a",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "8f8f187f-6730-4dad-b337-84b7375737ed",
          "db_currency_id": "8fde4710-7e72-4f98-9c29-ece3478d81fe",
          "db_language_id": "c2ae578b-e2f4-4614-95d0-8f4c20b41116",
          "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-17T18:27:04.4042655+00:00"
        },
        "modified_dateutc": "2026-11-17T18:27:04.4042655+00:00"
      },
      "equipment_model_id": "d5368b7b-ec67-4730-81f8-f13a9ac1ab99",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "21efa2d8-c50d-48c2-9ec5-012ea2cee178",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "f5004c1e-c64e-40e5-b0e2-d9843179fb69",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "9b13a392-99b0-4d74-9149-8677448e67d7",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "a7f52ac3-49cf-4d3f-8841-4c3351b4e66d",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "13784ff3-5621-44ed-a4a9-fc98d53c632a",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "8f8f187f-6730-4dad-b337-84b7375737ed",
            "db_currency_id": "8fde4710-7e72-4f98-9c29-ece3478d81fe",
            "db_language_id": "c2ae578b-e2f4-4614-95d0-8f4c20b41116",
            "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-17T18:27:04.4042655+00:00"
          },
          "modified_dateutc": "2026-11-17T18:27:04.4042655+00:00"
        },
        "equipment_family_id": "8454b96d-83ab-496c-9aab-c41122c76578",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "58365e79-c63a-46c3-aaaf-5c6bfa7f9f45",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "f88a3740-61a5-4d37-aba1-eb98b658ed2e",
          "_parent_code": "sample string 6",
          "sales_organization_id": "0384036a-9a76-45f2-964a-537a7767eac1",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "13784ff3-5621-44ed-a4a9-fc98d53c632a",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "8f8f187f-6730-4dad-b337-84b7375737ed",
            "db_currency_id": "8fde4710-7e72-4f98-9c29-ece3478d81fe",
            "db_language_id": "c2ae578b-e2f4-4614-95d0-8f4c20b41116",
            "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-17T18:27:04.4042655+00:00"
          },
          "modified_dateutc": "2026-11-17T18:27:04.4042655+00:00"
        },
        "date_in_production_since": "2026-11-17T18:27:04.4042655+00:00",
        "date_out_of_production_since": "2026-11-17T18:27:04.4042655+00:00",
        "date_end_support": "2026-11-17T18:27:04.4042655+00:00",
        "sales_organization_id": "0bd2944d-b016-417b-a7ce-4c822ee26867",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "13784ff3-5621-44ed-a4a9-fc98d53c632a",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "8f8f187f-6730-4dad-b337-84b7375737ed",
          "db_currency_id": "8fde4710-7e72-4f98-9c29-ece3478d81fe",
          "db_language_id": "c2ae578b-e2f4-4614-95d0-8f4c20b41116",
          "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-17T18:27:04.4042655+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-17T18:27:04.4042655+00:00"
      },
      "project_status_id": "47499834-de93-4fa9-93a7-c9ec77553612",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "75970b73-61b6-4661-952c-c2e3175ceba2",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "93fd475b-bfd7-4f00-95f8-dd6d8856ac20",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "13784ff3-5621-44ed-a4a9-fc98d53c632a",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "8f8f187f-6730-4dad-b337-84b7375737ed",
          "db_currency_id": "8fde4710-7e72-4f98-9c29-ece3478d81fe",
          "db_language_id": "c2ae578b-e2f4-4614-95d0-8f4c20b41116",
          "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-17T18:27:04.4042655+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-11-17T18:27:04.4042655+00:00"
      },
      "company_id": "ddeb1219-22f8-4974-8410-3003158bd8a2",
      "company_code": "sample string 12",
      "db_address_id": "e1cd39a9-2f1e-4729-b65b-0496faa40c9f",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "76d18aaa-21da-4cb8-8f49-722041c73961",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "c8e27562-b82a-4b6d-9185-de7586b4d78c",
      "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-17T18:27:04.4042655+00:00",
      "date_create": "2026-11-17T18:27:04.4042655+00:00",
      "date_update": "2026-11-17T18:27:04.4042655+00:00",
      "updated_by_user_id": "6c1b4603-3494-4eb7-8cf9-8afe54b0c846",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-11-17T18:27:04.4042655+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-17T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-11-17T18:27:04.4042655+00:00",
      "date_last_job": "2026-11-17T18:27:04.4042655+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-11-17T18:27:04.4042655+00:00",
      "modified_dateutc": "2026-11-17T18:27:04.4042655+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "e101323f-89e9-4a6f-bf94-3c7e87160ea6",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "56d09056-a882-46c0-8e83-3af115826061",
      "name": "sample string 2",
      "sales_organization_id": "1cba5061-a41b-4ecb-9e7f-73d649ebbc6d",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-11-17T18:27:04.4042655+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "6e658417-8906-4c32-af64-437d4ec5122d",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "69cb0cbb-61e9-4924-9aba-cc0eba73072c",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "af2cfb5a-f995-4ffa-b4e9-d54a61ed382f",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "13784ff3-5621-44ed-a4a9-fc98d53c632a",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "8f8f187f-6730-4dad-b337-84b7375737ed",
        "db_currency_id": "8fde4710-7e72-4f98-9c29-ece3478d81fe",
        "db_language_id": "c2ae578b-e2f4-4614-95d0-8f4c20b41116",
        "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-17T18:27:04.4042655+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-11-17T18:27:04.4042655+00:00"
    },
    "job_status_id": "2be9cfd3-8f81-415e-a0ee-a1329692d367",
    "job_status_code": "sample string 11",
    "db_address_id": "997d7c13-b3b6-4861-9387-ff752f25d623",
    "contact_id": "31feb310-30b7-4da8-866a-10558e22834a",
    "requested_by_company_id": "855711ec-becc-4d59-a08f-ca6e802b6989",
    "requested_by_contact_id": "f3941617-84f7-44fe-8c58-984c9d036ca7",
    "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-17T18:27:04.4042655+00:00",
    "due_date": "2026-11-17T18:27:04.4042655+00:00",
    "date_create": "2026-11-17T18:27:04.4042655+00:00",
    "date_update": "2026-11-17T18:27:04.4042655+00:00",
    "date_closed": "2026-11-17T18:27:04.4042655+00:00",
    "suggested_user_id": "375fc530-d79a-418d-a219-583066adb5af",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "32136cd7-cc87-493d-b8c3-fe2a777beff2",
      "db_language_id": "c5cdc739-bb2f-4ece-b30e-c6d895b2a0c2",
      "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-17T18:27:04.4042655+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "c7fa11b1-ac8d-410d-a42a-4ff43b6c2209",
      "sales_organization": {
        "id": "13784ff3-5621-44ed-a4a9-fc98d53c632a",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "8f8f187f-6730-4dad-b337-84b7375737ed",
        "db_currency_id": "8fde4710-7e72-4f98-9c29-ece3478d81fe",
        "db_language_id": "c2ae578b-e2f4-4614-95d0-8f4c20b41116",
        "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-17T18:27:04.4042655+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "8a2fac6e-ec6a-45f9-a3ba-856a394433ba",
      "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": "8296d0d1-b5fc-4ac6-a5df-ca839edf3307",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-11-17T18:27:04.4042655+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "3ea8c5f2-a5fd-42f1-aad8-cd5b1e6f78d0"
    },
    "suggested_date_start": "2026-11-17T18:27:04.4042655+00:00",
    "skill_id": "e42af914-e762-43f1-a4ea-91c3bdca9e40",
    "skill_code": "sample string 32",
    "skill": {
      "id": "e3a9ff01-b526-492a-bad3-41c68b776585",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "e3962bdd-4aeb-4f4a-84df-d203c442c695",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "13784ff3-5621-44ed-a4a9-fc98d53c632a",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "8f8f187f-6730-4dad-b337-84b7375737ed",
        "db_currency_id": "8fde4710-7e72-4f98-9c29-ece3478d81fe",
        "db_language_id": "c2ae578b-e2f4-4614-95d0-8f4c20b41116",
        "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-17T18:27:04.4042655+00:00"
      },
      "modified_dateutc": "2026-11-17T18:27:04.4181214+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "ece40b44-eb53-4217-82ed-457353a94e6a",
    "date_reported_by_company": "2026-11-17T18:27:04.4181214+00:00",
    "id2": 36,
    "company_id": "2cb18537-193b-465b-801d-856980108374",
    "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": "5e0cc016-e352-4619-a3f1-de3253b825d8",
    "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-17T18:27:04.4181214+00:00"
  },
  "work_instruction_details_id": "83366768-2663-4738-8bfb-1d2f14486d83",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "17f757c8-3edf-418c-a956-8c92a8c0a0cb",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "9d761c2c-079c-4d65-b6da-2f701004bb45",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-11-17T18:27:04.4181214+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": "9117543f-a037-49e9-91fd-43277ec99dc6",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-11-17T18:27:04.4181214+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.