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": "84fec0eb-d25f-4304-9f37-257bec9d063d",
  "jobs_id": "37295ebc-b102-4f9f-aa3f-ac25c72f3991",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "26f98f71-7498-4f7a-a130-4f7bee951fb6",
    "_parent_id": "c9b88883-ccc0-40d5-acb8-2c04a9d8fe98",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "eff89433-bc23-4b01-b037-6f6a078c276a",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "0735d2a1-b10d-44a6-bbf3-7445592c5373",
      "_parent_id": "b2e43e7c-68f1-4821-90fc-da7d86a59950",
      "root_parent_id": "9682ebb0-5960-4361-bfff-d28a98e9befc",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "b0aa6037-0b95-4638-b2a9-f863b39880ca",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "0a748d15-70f5-430f-9711-575b8c2339a3",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "7fb91be8-ff61-4546-b53f-8b7187daa1ba",
        "_parent_code": "sample string 6",
        "sales_organization_id": "c641b2d3-3fda-4bd4-ab5c-fb037a8d60b3",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "e1153a51-4fdb-4283-ad91-df9857058878",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "d127a319-b415-433f-899d-081ed3636e6d",
          "db_currency_id": "c0574ac9-05b5-48c1-ade4-16aac7cef9db",
          "db_language_id": "86167004-4188-409a-a1af-c00ab6274f7c",
          "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-18T22:18:26.4209878+00:00"
        },
        "modified_dateutc": "2026-11-18T22:18:26.4209878+00:00"
      },
      "equipment_model_id": "6c538800-78c1-4b93-bf4c-1c3e80d6fae3",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "9e98dd86-3557-4b8a-9b6d-3ccbed9ad550",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "ad12ac4e-3dfc-41b6-b399-410caa114908",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "294829a3-2e1a-407f-8283-379a7cac91b6",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "602b8160-2843-40c6-a106-b66ea0720c82",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "e1153a51-4fdb-4283-ad91-df9857058878",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "d127a319-b415-433f-899d-081ed3636e6d",
            "db_currency_id": "c0574ac9-05b5-48c1-ade4-16aac7cef9db",
            "db_language_id": "86167004-4188-409a-a1af-c00ab6274f7c",
            "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-18T22:18:26.4209878+00:00"
          },
          "modified_dateutc": "2026-11-18T22:18:26.4209878+00:00"
        },
        "equipment_family_id": "52ab128d-db5b-4aa6-8d61-8f7fcc0d3933",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "0a748d15-70f5-430f-9711-575b8c2339a3",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "7fb91be8-ff61-4546-b53f-8b7187daa1ba",
          "_parent_code": "sample string 6",
          "sales_organization_id": "c641b2d3-3fda-4bd4-ab5c-fb037a8d60b3",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "e1153a51-4fdb-4283-ad91-df9857058878",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "d127a319-b415-433f-899d-081ed3636e6d",
            "db_currency_id": "c0574ac9-05b5-48c1-ade4-16aac7cef9db",
            "db_language_id": "86167004-4188-409a-a1af-c00ab6274f7c",
            "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-18T22:18:26.4209878+00:00"
          },
          "modified_dateutc": "2026-11-18T22:18:26.4209878+00:00"
        },
        "date_in_production_since": "2026-11-18T22:18:26.4209878+00:00",
        "date_out_of_production_since": "2026-11-18T22:18:26.4209878+00:00",
        "date_end_support": "2026-11-18T22:18:26.4209878+00:00",
        "sales_organization_id": "cd27d1cb-c031-428e-abec-dbd61cecac3a",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "e1153a51-4fdb-4283-ad91-df9857058878",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "d127a319-b415-433f-899d-081ed3636e6d",
          "db_currency_id": "c0574ac9-05b5-48c1-ade4-16aac7cef9db",
          "db_language_id": "86167004-4188-409a-a1af-c00ab6274f7c",
          "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-18T22:18:26.4209878+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-18T22:18:26.4209878+00:00"
      },
      "project_status_id": "b8395485-0dfe-4ecb-996b-46f1d6646850",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "82e45194-051f-4bc4-83d8-4793ca56793a",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "0a3f1639-b511-45fb-b2df-18c40b8a6387",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "e1153a51-4fdb-4283-ad91-df9857058878",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "d127a319-b415-433f-899d-081ed3636e6d",
          "db_currency_id": "c0574ac9-05b5-48c1-ade4-16aac7cef9db",
          "db_language_id": "86167004-4188-409a-a1af-c00ab6274f7c",
          "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-18T22:18:26.4209878+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-11-18T22:18:26.4209878+00:00"
      },
      "company_id": "ba65bb6c-27a6-4663-8b70-6e46b7bcecf5",
      "company_code": "sample string 12",
      "db_address_id": "e0d4f3a7-1196-4267-b5cf-0cfb732cd119",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "8c688841-1fff-434a-9128-30492f7108c6",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "906296cf-cfcb-4767-a062-a10ecf90c125",
      "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-18T22:18:26.4209878+00:00",
      "date_create": "2026-11-18T22:18:26.4209878+00:00",
      "date_update": "2026-11-18T22:18:26.4209878+00:00",
      "updated_by_user_id": "b683d67c-fb88-430e-9483-b0756cf8c9ee",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-11-18T22:18:26.4209878+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-18T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-11-18T22:18:26.4209878+00:00",
      "date_last_job": "2026-11-18T22:18:26.4209878+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-11-18T22:18:26.4209878+00:00",
      "modified_dateutc": "2026-11-18T22:18:26.4209878+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "c60881f1-4033-4ae5-a643-ead3f478b38a",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "d1a8311e-adee-4a58-b3ac-1627f0be2632",
      "name": "sample string 2",
      "sales_organization_id": "f0d78e98-767b-42cf-8f4e-706f8fdbeb7a",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-11-18T22:18:26.4209878+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "fbc706d9-9169-4a83-b433-c161585874b1",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "d1d645c5-57ab-43f1-a47b-ebf0e73acc10",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "18324797-c7a1-44be-8bde-ba83fb0f6ba6",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "e1153a51-4fdb-4283-ad91-df9857058878",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "d127a319-b415-433f-899d-081ed3636e6d",
        "db_currency_id": "c0574ac9-05b5-48c1-ade4-16aac7cef9db",
        "db_language_id": "86167004-4188-409a-a1af-c00ab6274f7c",
        "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-18T22:18:26.4209878+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-11-18T22:18:26.4209878+00:00"
    },
    "job_status_id": "fff30157-3869-46f2-b4ad-4bab9ee33c67",
    "job_status_code": "sample string 11",
    "db_address_id": "81345d4b-dded-4fa0-9b8d-cb6b617c24f5",
    "contact_id": "bfc83f73-96d9-48a3-b991-452100751a17",
    "requested_by_company_id": "8f2da32c-950a-4725-bd36-6de87c231115",
    "requested_by_contact_id": "4aa399b7-5225-449d-b36b-787be5026650",
    "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-18T22:18:26.4209878+00:00",
    "due_date": "2026-11-18T22:18:26.4209878+00:00",
    "date_create": "2026-11-18T22:18:26.4209878+00:00",
    "date_update": "2026-11-18T22:18:26.4209878+00:00",
    "date_closed": "2026-11-18T22:18:26.4209878+00:00",
    "suggested_user_id": "8692a390-b57f-4d32-a61c-9e9e8e03b6e2",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "1730d626-e72f-41ee-98d8-c383d9df2cd8",
      "db_language_id": "01e15854-3243-4865-8167-bf1633c4fcb1",
      "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-18T22:18:26.4209878+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "2d134557-e836-4b38-bea6-0c8dae42ceb1",
      "sales_organization": {
        "id": "e1153a51-4fdb-4283-ad91-df9857058878",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "d127a319-b415-433f-899d-081ed3636e6d",
        "db_currency_id": "c0574ac9-05b5-48c1-ade4-16aac7cef9db",
        "db_language_id": "86167004-4188-409a-a1af-c00ab6274f7c",
        "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-18T22:18:26.4209878+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "c66760d9-e03c-48d1-b543-6bdcd87dc0f0",
      "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": "3bffbc7f-c948-4a7f-969e-081c7af7fc5f",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-11-18T22:18:26.4209878+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "162b1da5-6d0f-47a4-9114-51aec09dce86"
    },
    "suggested_date_start": "2026-11-18T22:18:26.4209878+00:00",
    "skill_id": "f3fe3163-91d3-4c8a-bd66-8e855faf391a",
    "skill_code": "sample string 32",
    "skill": {
      "id": "fe7f628c-8210-47fe-80f4-b9bb334981c2",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "a6e855b9-2ac2-4649-826b-b4daf85f1475",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "e1153a51-4fdb-4283-ad91-df9857058878",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "d127a319-b415-433f-899d-081ed3636e6d",
        "db_currency_id": "c0574ac9-05b5-48c1-ade4-16aac7cef9db",
        "db_language_id": "86167004-4188-409a-a1af-c00ab6274f7c",
        "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-18T22:18:26.4209878+00:00"
      },
      "modified_dateutc": "2026-11-18T22:18:26.4209878+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "192cd6ca-9f1b-42bb-90de-c2de6d37ec8d",
    "date_reported_by_company": "2026-11-18T22:18:26.4209878+00:00",
    "id2": 36,
    "company_id": "9d17448c-b09d-4a9c-aa75-26c25f59129d",
    "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": "296ba134-c46f-4020-8a7e-57d663dccbb3",
    "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-18T22:18:26.4209878+00:00"
  },
  "work_instruction_details_id": "a945782f-9ed6-407f-86ba-4979b6e445c4",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "25feacca-a1fe-48b1-9414-d1c0bdb35114",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "0ade2631-423e-422e-938d-64cfe003dd21",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-11-18T22:18:26.4209878+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": "6b279b70-55d6-48cd-bb31-d710eb0b2312",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-11-18T22:18:26.4209878+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.