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": "4c295447-1604-4f83-8648-ae1256dfb6e1",
  "jobs_id": "024647c9-889c-49a0-9669-de5d6e127e80",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "ca36af27-a1a0-4317-b33c-d3ae9ecea3b4",
    "_parent_id": "075fd041-008c-425d-864d-a79ead0144b5",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "fe205b54-eb0b-442a-9735-7a71071a688b",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "660e996e-093a-4d0a-bfe3-c28b5839bd1e",
      "_parent_id": "3034dd01-3d33-442d-8fd8-bb7519efcf8a",
      "root_parent_id": "933fb5c4-2cc3-4d3d-91f7-3b909c4c8832",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "0ec14328-fb2e-4bba-957d-da93f14e8a32",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "76fd5006-0cd6-4173-a77f-ae9d0a3e5778",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "bb03359b-71bd-4cdc-921b-b8cd83770bf5",
        "_parent_code": "sample string 6",
        "sales_organization_id": "3c3bc823-8e43-4be8-9ab3-67f9318646dd",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "e5811576-f7e2-4de9-af2b-0cbe12c56046",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "25dacb84-fac0-438c-a59a-da323522d97a",
          "db_currency_id": "11fe9aa5-aed4-4a88-b89b-4f1588ff60f1",
          "db_language_id": "f7ff51c7-354f-40a2-8ac2-39ef52ad1385",
          "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": "2025-10-14T03:02:05.9443497+00:00"
        },
        "modified_dateutc": "2025-10-14T03:02:05.9443497+00:00"
      },
      "equipment_model_id": "9b178d43-dda9-4d40-90cb-1f891da07f0d",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "de0475cc-14c0-4e02-be92-5e6c45158242",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "945ee711-5f3d-43f4-ac33-279b830bee81",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "bb7f8495-a31e-4880-b375-6526e7cab32e",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "d9ff42bc-7170-4dc0-bbd5-a7f733bb97d0",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "e5811576-f7e2-4de9-af2b-0cbe12c56046",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "25dacb84-fac0-438c-a59a-da323522d97a",
            "db_currency_id": "11fe9aa5-aed4-4a88-b89b-4f1588ff60f1",
            "db_language_id": "f7ff51c7-354f-40a2-8ac2-39ef52ad1385",
            "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": "2025-10-14T03:02:05.9443497+00:00"
          },
          "modified_dateutc": "2025-10-14T03:02:05.9443497+00:00"
        },
        "equipment_family_id": "1585c4da-6232-4259-929e-d0c84a3d86d0",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "76fd5006-0cd6-4173-a77f-ae9d0a3e5778",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "bb03359b-71bd-4cdc-921b-b8cd83770bf5",
          "_parent_code": "sample string 6",
          "sales_organization_id": "3c3bc823-8e43-4be8-9ab3-67f9318646dd",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "e5811576-f7e2-4de9-af2b-0cbe12c56046",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "25dacb84-fac0-438c-a59a-da323522d97a",
            "db_currency_id": "11fe9aa5-aed4-4a88-b89b-4f1588ff60f1",
            "db_language_id": "f7ff51c7-354f-40a2-8ac2-39ef52ad1385",
            "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": "2025-10-14T03:02:05.9443497+00:00"
          },
          "modified_dateutc": "2025-10-14T03:02:05.9443497+00:00"
        },
        "date_in_production_since": "2025-10-14T03:02:05.9443497+00:00",
        "date_out_of_production_since": "2025-10-14T03:02:05.9443497+00:00",
        "date_end_support": "2025-10-14T03:02:05.9443497+00:00",
        "sales_organization_id": "6b1580ac-b6b5-4c9e-bf7a-fb40c6bcf220",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "e5811576-f7e2-4de9-af2b-0cbe12c56046",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "25dacb84-fac0-438c-a59a-da323522d97a",
          "db_currency_id": "11fe9aa5-aed4-4a88-b89b-4f1588ff60f1",
          "db_language_id": "f7ff51c7-354f-40a2-8ac2-39ef52ad1385",
          "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": "2025-10-14T03:02:05.9443497+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": "2025-10-14T03:02:05.9443497+00:00"
      },
      "project_status_id": "76f6ef33-5990-4887-8b9f-56051e682339",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "b3fc6090-f3b2-4b02-9b07-7cb4b43ae4d0",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "8e5fef36-d54a-41ba-96c5-e251cbb66185",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "e5811576-f7e2-4de9-af2b-0cbe12c56046",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "25dacb84-fac0-438c-a59a-da323522d97a",
          "db_currency_id": "11fe9aa5-aed4-4a88-b89b-4f1588ff60f1",
          "db_language_id": "f7ff51c7-354f-40a2-8ac2-39ef52ad1385",
          "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": "2025-10-14T03:02:05.9443497+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2025-10-14T03:02:05.9443497+00:00"
      },
      "company_id": "70b7b0c3-5132-4120-81a0-74586785ca5d",
      "company_code": "sample string 12",
      "db_address_id": "31c348b3-0ca2-47bb-b43b-80aaef4dd191",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "ef48ab54-e1fa-491f-8813-82232dc00ca7",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "75b2ea7b-257e-4a66-9508-1e1d968856d9",
      "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": "2025-10-14T03:02:05.9443497+00:00",
      "date_create": "2025-10-14T03:02:05.9443497+00:00",
      "date_update": "2025-10-14T03:02:05.9443497+00:00",
      "updated_by_user_id": "8e65c850-784a-4f5e-ab09-6480af5d8812",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2025-10-14T03:02:05.9443497+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": "2025-10-14T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2025-10-14T03:02:05.9443497+00:00",
      "date_last_job": "2025-10-14T03:02:05.9443497+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2025-10-14T03:02:05.9443497+00:00",
      "modified_dateutc": "2025-10-14T03:02:05.9443497+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "1b0893d7-6a30-42ee-8940-d55c61d7fef1",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "0b0d3601-8c65-442b-8f7e-93a11e56c8a9",
      "name": "sample string 2",
      "sales_organization_id": "8a0d4df6-0794-49da-8b23-7a8adcd9c1f6",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2025-10-14T03:02:05.9443497+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "ae19e742-76d3-4d04-a00e-f3b474c34baa",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "d856db3e-311e-483a-8a85-2fad574358c7",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "90637b74-cfc5-4a11-9146-cb52c1077b47",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "e5811576-f7e2-4de9-af2b-0cbe12c56046",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "25dacb84-fac0-438c-a59a-da323522d97a",
        "db_currency_id": "11fe9aa5-aed4-4a88-b89b-4f1588ff60f1",
        "db_language_id": "f7ff51c7-354f-40a2-8ac2-39ef52ad1385",
        "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": "2025-10-14T03:02:05.9443497+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2025-10-14T03:02:05.9443497+00:00"
    },
    "job_status_id": "3b28d8ed-f97c-44b9-a3d7-8552d09e199b",
    "job_status_code": "sample string 11",
    "db_address_id": "5004e58b-9262-42b9-bb10-a7ffcf71dacb",
    "contact_id": "7f75b583-62b1-40b4-80f6-b6a4fbc21825",
    "requested_by_company_id": "989f32e4-bf60-4e1e-9ba2-1904f3c73434",
    "requested_by_contact_id": "48b70927-af19-47d4-9c90-1659ef457daf",
    "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": "2025-10-14T03:02:05.9443497+00:00",
    "due_date": "2025-10-14T03:02:05.9443497+00:00",
    "date_create": "2025-10-14T03:02:05.9443497+00:00",
    "date_update": "2025-10-14T03:02:05.9443497+00:00",
    "date_closed": "2025-10-14T03:02:05.9443497+00:00",
    "suggested_user_id": "ebabaa3a-992f-4d32-91f4-ab6ebd14a5d5",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "95df9a20-5a00-4a15-93a2-f61cbea48d66",
      "db_language_id": "967027e7-d19a-4c34-b12d-c6ca6c88dd21",
      "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": "2025-10-14T03:02:05.9443497+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "642bb5d6-8520-4fd4-85d4-d0e86e72eb47",
      "sales_organization": {
        "id": "e5811576-f7e2-4de9-af2b-0cbe12c56046",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "25dacb84-fac0-438c-a59a-da323522d97a",
        "db_currency_id": "11fe9aa5-aed4-4a88-b89b-4f1588ff60f1",
        "db_language_id": "f7ff51c7-354f-40a2-8ac2-39ef52ad1385",
        "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": "2025-10-14T03:02:05.9443497+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "4bd00720-744c-4427-9df1-59bfffd24f98",
      "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": "90e071ca-6223-4d1a-970b-8dda886d1512",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2025-10-14T03:02:05.9443497+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "7e5f8eaf-327a-4cc6-81c0-a176725985b6"
    },
    "suggested_date_start": "2025-10-14T03:02:05.9443497+00:00",
    "skill_id": "6b06c158-3dff-48cd-ae96-d2fc14deb26a",
    "skill_code": "sample string 32",
    "skill": {
      "id": "fe75d521-a502-44a4-9145-0b4dd534d782",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "e71cf87e-c7b8-4158-bb9c-eb9c33b02d44",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "e5811576-f7e2-4de9-af2b-0cbe12c56046",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "25dacb84-fac0-438c-a59a-da323522d97a",
        "db_currency_id": "11fe9aa5-aed4-4a88-b89b-4f1588ff60f1",
        "db_language_id": "f7ff51c7-354f-40a2-8ac2-39ef52ad1385",
        "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": "2025-10-14T03:02:05.9443497+00:00"
      },
      "modified_dateutc": "2025-10-14T03:02:05.9443497+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "d40f4a0f-fc55-46d9-9406-0475c1e2cf49",
    "date_reported_by_company": "2025-10-14T03:02:05.9443497+00:00",
    "id2": 36,
    "company_id": "b06a9be9-543d-451d-810a-b9a7e131085a",
    "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": "77440c8a-5996-42e2-98b7-691f3c0193a1",
    "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": "2025-10-14T03:02:05.9443497+00:00"
  },
  "work_instruction_details_id": "dea3c8c1-ac6a-4594-888d-a0457c561da4",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "d64cc247-9bfe-48e0-a9cd-1e5e074dcc0d",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "2617b77a-5469-48e6-98ea-2836346f7573",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2025-10-14T03:02:05.9443497+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": "e5964b25-3def-4575-a676-8f91c002b46b",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2025-10-14T03:02:05.9443497+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.