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": "1f636004-6751-4ddd-9bbc-9dfc2d1c9290",
  "jobs_id": "0444f98d-5f10-4218-b0c7-86581ab2d71e",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "2d70acbe-c788-4f89-bbd9-7072adee986f",
    "_parent_id": "c0359002-4e2b-47b5-b9e5-90ea204d2f0d",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "ab452aee-4eef-4099-b782-7dc401fb0f53",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "2f0cd66f-7444-4a07-8297-b9da4251e44f",
      "_parent_id": "dc75e901-fe21-4f43-8131-925a3d30922c",
      "root_parent_id": "18dd0bc7-81e4-4393-8f05-2ae6546a1671",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "488785eb-a487-4dc9-bf79-6f0bc2f85735",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "4304b026-b848-4b5c-95ef-9a191c4197f7",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "69a98a04-edc7-456d-a03c-0d281cefe7c4",
        "_parent_code": "sample string 6",
        "sales_organization_id": "3c860e50-9c70-489b-aee0-affc079ab7bf",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "2af45476-8ae1-47d0-a3d0-7a7b61ec738e",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "57e33632-bac2-465f-aacf-4a75694d4ffd",
          "db_currency_id": "26d561a4-c313-4d41-9db1-de095df75d99",
          "db_language_id": "8777ffa5-f917-4ad9-b060-c4f9b1bd13cb",
          "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-08-30T01:52:19.5956895+00:00"
        },
        "modified_dateutc": "2026-08-30T01:52:19.5956895+00:00"
      },
      "equipment_model_id": "b9a9b76b-950a-4f9a-9c63-a81edd91bc74",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "def32800-682d-46ac-86fd-d1668ad9ad98",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "0be0c12a-aa09-4802-8bc1-7869d2095039",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "39cfb416-5992-4190-b2ab-cef963710cd3",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "bd62b051-0720-41a7-a22a-60b48c7c6640",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "2af45476-8ae1-47d0-a3d0-7a7b61ec738e",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "57e33632-bac2-465f-aacf-4a75694d4ffd",
            "db_currency_id": "26d561a4-c313-4d41-9db1-de095df75d99",
            "db_language_id": "8777ffa5-f917-4ad9-b060-c4f9b1bd13cb",
            "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-08-30T01:52:19.5956895+00:00"
          },
          "modified_dateutc": "2026-08-30T01:52:19.5956895+00:00"
        },
        "equipment_family_id": "bfa68fd5-37d7-49c7-b038-583aa9897878",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "4304b026-b848-4b5c-95ef-9a191c4197f7",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "69a98a04-edc7-456d-a03c-0d281cefe7c4",
          "_parent_code": "sample string 6",
          "sales_organization_id": "3c860e50-9c70-489b-aee0-affc079ab7bf",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "2af45476-8ae1-47d0-a3d0-7a7b61ec738e",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "57e33632-bac2-465f-aacf-4a75694d4ffd",
            "db_currency_id": "26d561a4-c313-4d41-9db1-de095df75d99",
            "db_language_id": "8777ffa5-f917-4ad9-b060-c4f9b1bd13cb",
            "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-08-30T01:52:19.5956895+00:00"
          },
          "modified_dateutc": "2026-08-30T01:52:19.5956895+00:00"
        },
        "date_in_production_since": "2026-08-30T01:52:19.5956895+00:00",
        "date_out_of_production_since": "2026-08-30T01:52:19.5956895+00:00",
        "date_end_support": "2026-08-30T01:52:19.5956895+00:00",
        "sales_organization_id": "f4b8586d-f9f9-4841-8fd0-cb9519719fc7",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "2af45476-8ae1-47d0-a3d0-7a7b61ec738e",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "57e33632-bac2-465f-aacf-4a75694d4ffd",
          "db_currency_id": "26d561a4-c313-4d41-9db1-de095df75d99",
          "db_language_id": "8777ffa5-f917-4ad9-b060-c4f9b1bd13cb",
          "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-08-30T01:52:19.5956895+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-08-30T01:52:19.6113124+00:00"
      },
      "project_status_id": "63f1357c-b7ef-4bfb-a120-619f5713083d",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "a817cd0b-d8d4-4159-b3f2-c6934ac1b33d",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "46af654c-c99c-45ca-91bf-fe3e5d913de2",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "2af45476-8ae1-47d0-a3d0-7a7b61ec738e",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "57e33632-bac2-465f-aacf-4a75694d4ffd",
          "db_currency_id": "26d561a4-c313-4d41-9db1-de095df75d99",
          "db_language_id": "8777ffa5-f917-4ad9-b060-c4f9b1bd13cb",
          "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-08-30T01:52:19.5956895+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-08-30T01:52:19.6113124+00:00"
      },
      "company_id": "f829382d-af52-49b8-bf09-de234550619b",
      "company_code": "sample string 12",
      "db_address_id": "b56c18f0-1510-45c3-9686-1556c6e76efd",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "eb66ba18-806c-4783-9671-05059f9777e0",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "49966b38-0d29-4218-992e-e4b695d5e45b",
      "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-08-30T01:52:19.6113124+00:00",
      "date_create": "2026-08-30T01:52:19.6113124+00:00",
      "date_update": "2026-08-30T01:52:19.6113124+00:00",
      "updated_by_user_id": "970297d9-2439-4522-9175-8f98233e8ea7",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-08-30T01:52:19.6113124+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-08-30T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-08-30T01:52:19.6113124+00:00",
      "date_last_job": "2026-08-30T01:52:19.6113124+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-08-30T01:52:19.6113124+00:00",
      "modified_dateutc": "2026-08-30T01:52:19.6113124+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "5161d9c0-0f6d-4827-8b6b-403f0ce274fa",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "2a8d4308-20e3-4b75-a6fe-64fc9abb6c4f",
      "name": "sample string 2",
      "sales_organization_id": "da376b5d-667a-4c61-86e0-06664b3ef3fa",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-08-30T01:52:19.6113124+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "ddee8e41-6168-4714-968a-b1a7e496ad7a",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "67c7878c-083a-453d-a920-67a5c40fd31e",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "c2aa23bc-d0ed-4927-b173-fbdb2800e07f",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "2af45476-8ae1-47d0-a3d0-7a7b61ec738e",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "57e33632-bac2-465f-aacf-4a75694d4ffd",
        "db_currency_id": "26d561a4-c313-4d41-9db1-de095df75d99",
        "db_language_id": "8777ffa5-f917-4ad9-b060-c4f9b1bd13cb",
        "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-08-30T01:52:19.5956895+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-08-30T01:52:19.6113124+00:00"
    },
    "job_status_id": "0ca82691-7f73-4855-9d4a-cd9dfd6ec849",
    "job_status_code": "sample string 11",
    "db_address_id": "73c22047-c7a7-44c2-bc58-757ea08430f7",
    "contact_id": "50bed4e1-e827-462a-bbc9-7b1f953b6cb0",
    "requested_by_company_id": "5d43d546-4565-42fc-8f53-e3a137d2a88c",
    "requested_by_contact_id": "5a4e7e00-f552-407f-944a-232539da8590",
    "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-08-30T01:52:19.6113124+00:00",
    "due_date": "2026-08-30T01:52:19.6113124+00:00",
    "date_create": "2026-08-30T01:52:19.6113124+00:00",
    "date_update": "2026-08-30T01:52:19.6113124+00:00",
    "date_closed": "2026-08-30T01:52:19.6113124+00:00",
    "suggested_user_id": "209740f7-65f3-4508-9f11-a9ba225d482d",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "8b144c31-c268-4184-9e9e-52301cb013c1",
      "db_language_id": "93d47aa5-2bc3-4a30-92bc-6d87d327e8cc",
      "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-08-30T01:52:19.6113124+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "1907e78a-dcf7-4e17-b5f8-9b9860e7f3c0",
      "sales_organization": {
        "id": "2af45476-8ae1-47d0-a3d0-7a7b61ec738e",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "57e33632-bac2-465f-aacf-4a75694d4ffd",
        "db_currency_id": "26d561a4-c313-4d41-9db1-de095df75d99",
        "db_language_id": "8777ffa5-f917-4ad9-b060-c4f9b1bd13cb",
        "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-08-30T01:52:19.5956895+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "60d6c54f-0ba5-42ce-9e00-f4277c205d59",
      "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": "38e3fd62-ce70-43f9-a25b-d0e01912d508",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-08-30T01:52:19.6113124+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "ed3598eb-d32d-4fae-998a-5f4487792013"
    },
    "suggested_date_start": "2026-08-30T01:52:19.6113124+00:00",
    "skill_id": "e3092bcd-499a-4ec1-b4b6-3d51e7260fcd",
    "skill_code": "sample string 32",
    "skill": {
      "id": "b1abf1fc-4e94-4fed-a844-f75e5b59c43c",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "9fb322bd-e1e8-45c4-8122-1c6dd017a90d",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "2af45476-8ae1-47d0-a3d0-7a7b61ec738e",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "57e33632-bac2-465f-aacf-4a75694d4ffd",
        "db_currency_id": "26d561a4-c313-4d41-9db1-de095df75d99",
        "db_language_id": "8777ffa5-f917-4ad9-b060-c4f9b1bd13cb",
        "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-08-30T01:52:19.5956895+00:00"
      },
      "modified_dateutc": "2026-08-30T01:52:19.6113124+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "ab40a0dd-2739-4871-beb5-582b385d59f7",
    "date_reported_by_company": "2026-08-30T01:52:19.6113124+00:00",
    "id2": 36,
    "company_id": "4a55a4ba-6bbe-4b9f-bbd1-bb7ee6e0694a",
    "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": "3cf77514-9bf6-4b45-b93d-6d6b4f7714d0",
    "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-08-30T01:52:19.6113124+00:00"
  },
  "work_instruction_details_id": "684d0ac2-4bc3-4529-bc00-fbf1c493a190",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "1b3b3f37-0aed-4662-a550-dab18995325f",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "19a1572d-8b23-4ee8-b517-dae950ad076f",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-08-30T01:52:19.6113124+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": "380c2b6e-8e8d-4669-a6d6-4b8c66b6f8ca",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-08-30T01:52:19.6113124+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.