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": "26c2ad6d-0a7a-4fd1-b558-92515b24e9c8",
  "jobs_id": "e689d5c7-8028-4481-a297-3a0c0dfc7b1e",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "2f021d4d-56d3-4a40-a309-941bbf628c8c",
    "_parent_id": "f4ec1159-b09c-45f1-96d0-fa61e3ac9a71",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "d7f60fc1-c049-4e8b-86f3-a10e72fb9117",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "49aa41cb-d7fd-4fb6-9298-3d3d05f027df",
      "_parent_id": "1a0270b5-0b08-4c40-9b34-a6cd83e29f02",
      "root_parent_id": "94e79176-bb99-4cd6-9a08-4ebf09b2fa29",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "040fb043-bb8e-4148-a74e-7c4567b5dc95",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "af712eb7-0ff4-45d8-ae4b-45796e24bfe6",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "15f10320-5d87-4e1f-9367-07ada57d4bbf",
        "_parent_code": "sample string 6",
        "sales_organization_id": "4b07d99c-39d2-4f7f-a375-c74041239f8b",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "21f1d65e-2fde-4aaf-a9b0-c6ddfba62ebd",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "9f89b7db-a0e4-4c66-bc88-7f03fb0077fd",
          "db_currency_id": "f6a9425a-66f2-4d42-8ebf-4ef9d2695d9f",
          "db_language_id": "6c468d3f-3e84-4903-bdd7-e9ab49c85d8b",
          "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-07-08T09:36:25.588439+00:00"
        },
        "modified_dateutc": "2026-07-08T09:36:25.588439+00:00"
      },
      "equipment_model_id": "e8931537-2b2c-411b-a14b-bc643d8b2386",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "a5758233-b0d7-43ea-ab35-2245804c21ca",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "dc978e3d-6fc8-4030-af2c-b59685004f2c",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "d81ee70b-a578-4c90-93b0-ac7ca40840fe",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "be84ce95-8ac7-41f6-a70f-20cce5d75116",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "21f1d65e-2fde-4aaf-a9b0-c6ddfba62ebd",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "9f89b7db-a0e4-4c66-bc88-7f03fb0077fd",
            "db_currency_id": "f6a9425a-66f2-4d42-8ebf-4ef9d2695d9f",
            "db_language_id": "6c468d3f-3e84-4903-bdd7-e9ab49c85d8b",
            "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-07-08T09:36:25.588439+00:00"
          },
          "modified_dateutc": "2026-07-08T09:36:25.588439+00:00"
        },
        "equipment_family_id": "24f056c9-ea40-4d32-835c-85456b763358",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "af712eb7-0ff4-45d8-ae4b-45796e24bfe6",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "15f10320-5d87-4e1f-9367-07ada57d4bbf",
          "_parent_code": "sample string 6",
          "sales_organization_id": "4b07d99c-39d2-4f7f-a375-c74041239f8b",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "21f1d65e-2fde-4aaf-a9b0-c6ddfba62ebd",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "9f89b7db-a0e4-4c66-bc88-7f03fb0077fd",
            "db_currency_id": "f6a9425a-66f2-4d42-8ebf-4ef9d2695d9f",
            "db_language_id": "6c468d3f-3e84-4903-bdd7-e9ab49c85d8b",
            "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-07-08T09:36:25.588439+00:00"
          },
          "modified_dateutc": "2026-07-08T09:36:25.588439+00:00"
        },
        "date_in_production_since": "2026-07-08T09:36:25.588439+00:00",
        "date_out_of_production_since": "2026-07-08T09:36:25.588439+00:00",
        "date_end_support": "2026-07-08T09:36:25.588439+00:00",
        "sales_organization_id": "ad695957-8c9e-49ff-bf53-a602a374f3a5",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "21f1d65e-2fde-4aaf-a9b0-c6ddfba62ebd",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "9f89b7db-a0e4-4c66-bc88-7f03fb0077fd",
          "db_currency_id": "f6a9425a-66f2-4d42-8ebf-4ef9d2695d9f",
          "db_language_id": "6c468d3f-3e84-4903-bdd7-e9ab49c85d8b",
          "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-07-08T09:36:25.588439+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-07-08T09:36:25.588439+00:00"
      },
      "project_status_id": "c71de753-4890-452e-93ea-0d26e4d6677c",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "7355094f-0295-452b-9a83-712c0fc72690",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "f9523865-440a-4d1a-a296-745dd7967418",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "21f1d65e-2fde-4aaf-a9b0-c6ddfba62ebd",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "9f89b7db-a0e4-4c66-bc88-7f03fb0077fd",
          "db_currency_id": "f6a9425a-66f2-4d42-8ebf-4ef9d2695d9f",
          "db_language_id": "6c468d3f-3e84-4903-bdd7-e9ab49c85d8b",
          "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-07-08T09:36:25.588439+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-07-08T09:36:25.588439+00:00"
      },
      "company_id": "efd6ba00-c697-4364-9eb5-b59e9d550653",
      "company_code": "sample string 12",
      "db_address_id": "a2857090-19d1-4726-8645-d2ea3ed054f0",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "62b09688-0ae1-45d1-8087-39c847f8f843",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "b5e49c60-7003-44f7-83df-41a003038fa2",
      "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-07-08T09:36:25.588439+00:00",
      "date_create": "2026-07-08T09:36:25.588439+00:00",
      "date_update": "2026-07-08T09:36:25.588439+00:00",
      "updated_by_user_id": "f059d677-70bf-4a56-9c58-adbd01b706ce",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-07-08T09:36:25.588439+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-07-08T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-07-08T09:36:25.588439+00:00",
      "date_last_job": "2026-07-08T09:36:25.588439+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-07-08T09:36:25.588439+00:00",
      "modified_dateutc": "2026-07-08T09:36:25.588439+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "606a4b29-4e5d-4a8a-9f00-fbdec890e56e",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "d90ec207-1dab-4d5e-94b8-e6b87aeeab20",
      "name": "sample string 2",
      "sales_organization_id": "4ff99d61-e276-4851-b552-d6f42097f590",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-07-08T09:36:25.588439+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "312dd1e6-a7b3-4090-8729-e8c4186d628d",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "7d356728-aeef-4dd3-8498-f3451cad5998",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "f3ce6290-f0f9-4b65-8b89-80ae6df5106f",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "21f1d65e-2fde-4aaf-a9b0-c6ddfba62ebd",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "9f89b7db-a0e4-4c66-bc88-7f03fb0077fd",
        "db_currency_id": "f6a9425a-66f2-4d42-8ebf-4ef9d2695d9f",
        "db_language_id": "6c468d3f-3e84-4903-bdd7-e9ab49c85d8b",
        "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-07-08T09:36:25.588439+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-07-08T09:36:25.588439+00:00"
    },
    "job_status_id": "bf540d60-be20-4173-8bad-bf8dbf8a6489",
    "job_status_code": "sample string 11",
    "db_address_id": "e34923ea-7551-4809-97d3-024f94039d6e",
    "contact_id": "ad543255-6b6a-48b3-93f3-4b61ace6ce78",
    "requested_by_company_id": "3721199d-c221-4a9c-93cb-feb18b847e1a",
    "requested_by_contact_id": "09ba71c5-2dba-453f-8760-1f2c8d02cf62",
    "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-07-08T09:36:25.588439+00:00",
    "due_date": "2026-07-08T09:36:25.588439+00:00",
    "date_create": "2026-07-08T09:36:25.588439+00:00",
    "date_update": "2026-07-08T09:36:25.588439+00:00",
    "date_closed": "2026-07-08T09:36:25.588439+00:00",
    "suggested_user_id": "4de5de74-a1ff-40f1-9c7a-1d8d483a3683",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "560d5ae2-9a6a-48a8-b87e-936ba67aa8f8",
      "db_language_id": "fbee8904-f022-4687-afa8-b4ea71cdfbd2",
      "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-07-08T09:36:25.588439+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "5764db62-a861-4f49-a4cb-378196359465",
      "sales_organization": {
        "id": "21f1d65e-2fde-4aaf-a9b0-c6ddfba62ebd",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "9f89b7db-a0e4-4c66-bc88-7f03fb0077fd",
        "db_currency_id": "f6a9425a-66f2-4d42-8ebf-4ef9d2695d9f",
        "db_language_id": "6c468d3f-3e84-4903-bdd7-e9ab49c85d8b",
        "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-07-08T09:36:25.588439+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "a7546eb1-b82a-42cf-bd5d-4e1a2ab46199",
      "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": "43bbc6f1-9aa5-4a0a-bc3b-f05f069f11f4",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-07-08T09:36:25.588439+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "9b165eb1-3b97-4493-aa6a-2508498d3233"
    },
    "suggested_date_start": "2026-07-08T09:36:25.588439+00:00",
    "skill_id": "4564d3b7-a0ac-49fb-a736-36548641bfab",
    "skill_code": "sample string 32",
    "skill": {
      "id": "9cedefdf-e314-4ad4-9489-712eea50dc75",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "210fc9f5-15f1-4228-aa93-893b9cbc63bc",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "21f1d65e-2fde-4aaf-a9b0-c6ddfba62ebd",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "9f89b7db-a0e4-4c66-bc88-7f03fb0077fd",
        "db_currency_id": "f6a9425a-66f2-4d42-8ebf-4ef9d2695d9f",
        "db_language_id": "6c468d3f-3e84-4903-bdd7-e9ab49c85d8b",
        "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-07-08T09:36:25.588439+00:00"
      },
      "modified_dateutc": "2026-07-08T09:36:25.588439+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "8c62059c-c6db-475a-b19d-3a48a012722f",
    "date_reported_by_company": "2026-07-08T09:36:25.588439+00:00",
    "id2": 36,
    "company_id": "b955e8df-37ea-4416-94ca-728567977232",
    "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": "16ba0dda-1898-4432-aef5-1596db00ea46",
    "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-07-08T09:36:25.588439+00:00"
  },
  "work_instruction_details_id": "680fb1ed-c245-427d-84a2-be6916c411b1",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "bc106182-042f-46f5-8aae-ea5c7abd5170",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "a52e1888-3df8-427a-8a43-433566ca06d6",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-07-08T09:36:25.588439+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": "dd002447-89ee-49cf-b049-7bb6ea11687c",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-07-08T09:36:25.588439+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.