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": "df0289fd-3ca5-4e25-8005-a5ecca622066",
  "jobs_id": "2c43c23d-ff62-4b2b-a87a-74d4bf43c312",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "c95a5794-83db-48e3-8532-03aabcb67bac",
    "_parent_id": "ceb56143-2748-4251-9d24-ad3f3ed7cdb1",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "866b696e-915b-435f-b174-0f2f153d3986",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "c9e39a5a-546d-4e48-8bf2-0ee33ff1be61",
      "_parent_id": "5686ac7e-ebfb-46a1-9eab-15ec8fd433dc",
      "root_parent_id": "53567e15-1860-4ed5-9cdd-cde0060251d5",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "ceaf5198-4753-4f51-bbb2-688fc3f88c01",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "33391555-4f41-428d-b235-bbbb7b446164",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "cac37c56-1da4-40cd-b043-c461219139b4",
        "_parent_code": "sample string 6",
        "sales_organization_id": "254900b2-94ea-4021-97d4-9e7d93fd76a6",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "c11593bb-faff-4056-aa94-15fc313e348f",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "d1b8ba60-8d39-4a68-9069-de8de9cbf657",
          "db_currency_id": "bbd0ab61-9243-4686-b33e-8858bb140c37",
          "db_language_id": "4063f237-b364-4ced-adfb-8532b105a646",
          "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-15T18:22:56.133935+00:00"
        },
        "modified_dateutc": "2025-10-15T18:22:56.133935+00:00"
      },
      "equipment_model_id": "b0c83c9f-d1e3-4994-9d26-ff85eb193a85",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "c1537092-8d15-4216-bdd6-962333794f0e",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "e663a3e9-c164-481b-bea9-ae3848e27391",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "04332a57-f876-490f-b4bc-2fcdc4ea15a0",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "162c8687-9717-41de-8e30-5ff912bec64f",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "c11593bb-faff-4056-aa94-15fc313e348f",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "d1b8ba60-8d39-4a68-9069-de8de9cbf657",
            "db_currency_id": "bbd0ab61-9243-4686-b33e-8858bb140c37",
            "db_language_id": "4063f237-b364-4ced-adfb-8532b105a646",
            "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-15T18:22:56.133935+00:00"
          },
          "modified_dateutc": "2025-10-15T18:22:56.133935+00:00"
        },
        "equipment_family_id": "197a5760-cc9e-46aa-9dc5-5a4a0f2cdb5b",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "33391555-4f41-428d-b235-bbbb7b446164",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "cac37c56-1da4-40cd-b043-c461219139b4",
          "_parent_code": "sample string 6",
          "sales_organization_id": "254900b2-94ea-4021-97d4-9e7d93fd76a6",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "c11593bb-faff-4056-aa94-15fc313e348f",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "d1b8ba60-8d39-4a68-9069-de8de9cbf657",
            "db_currency_id": "bbd0ab61-9243-4686-b33e-8858bb140c37",
            "db_language_id": "4063f237-b364-4ced-adfb-8532b105a646",
            "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-15T18:22:56.133935+00:00"
          },
          "modified_dateutc": "2025-10-15T18:22:56.133935+00:00"
        },
        "date_in_production_since": "2025-10-15T18:22:56.133935+00:00",
        "date_out_of_production_since": "2025-10-15T18:22:56.133935+00:00",
        "date_end_support": "2025-10-15T18:22:56.133935+00:00",
        "sales_organization_id": "12a660b9-d407-49dc-9fb3-2077371a27be",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "c11593bb-faff-4056-aa94-15fc313e348f",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "d1b8ba60-8d39-4a68-9069-de8de9cbf657",
          "db_currency_id": "bbd0ab61-9243-4686-b33e-8858bb140c37",
          "db_language_id": "4063f237-b364-4ced-adfb-8532b105a646",
          "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-15T18:22:56.133935+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-15T18:22:56.133935+00:00"
      },
      "project_status_id": "ff561801-075a-4e5f-8bac-d0cc083f96a1",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "8b8fa40d-a863-45ea-ad7c-21331c481f2f",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "ddd59615-434c-4a59-b01a-18da7f3ac112",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "c11593bb-faff-4056-aa94-15fc313e348f",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "d1b8ba60-8d39-4a68-9069-de8de9cbf657",
          "db_currency_id": "bbd0ab61-9243-4686-b33e-8858bb140c37",
          "db_language_id": "4063f237-b364-4ced-adfb-8532b105a646",
          "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-15T18:22:56.133935+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2025-10-15T18:22:56.1495591+00:00"
      },
      "company_id": "dfa6758a-d290-4c5c-b018-c1dd70a1be90",
      "company_code": "sample string 12",
      "db_address_id": "3ebcfd16-54d4-4f51-a99b-1ab5d31fb38b",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "27e7cccc-fdda-4581-9318-8930ec4205e9",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "aae4769f-bb95-4b02-b2ab-880066209236",
      "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-15T18:22:56.1495591+00:00",
      "date_create": "2025-10-15T18:22:56.1495591+00:00",
      "date_update": "2025-10-15T18:22:56.1495591+00:00",
      "updated_by_user_id": "08afa5f1-ed54-4bd5-ba0b-206f9c461cd9",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2025-10-15T18:22:56.1495591+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-15T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2025-10-15T18:22:56.1495591+00:00",
      "date_last_job": "2025-10-15T18:22:56.1495591+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2025-10-15T18:22:56.1495591+00:00",
      "modified_dateutc": "2025-10-15T18:22:56.1495591+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "480d4636-46c2-46f3-b179-7fb2d6bbaabc",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "1f030204-f6e6-4eb8-8c2e-460f90584b44",
      "name": "sample string 2",
      "sales_organization_id": "c7a2884e-aead-4097-a232-7a026a5dd653",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2025-10-15T18:22:56.1495591+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "9226a242-4c24-4c73-8570-2ff42116b8a6",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "d402be36-90fa-41fe-bdc9-d5a8cc63ec35",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "9321884e-4f00-46bf-a4e6-d7807648a2b5",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "c11593bb-faff-4056-aa94-15fc313e348f",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "d1b8ba60-8d39-4a68-9069-de8de9cbf657",
        "db_currency_id": "bbd0ab61-9243-4686-b33e-8858bb140c37",
        "db_language_id": "4063f237-b364-4ced-adfb-8532b105a646",
        "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-15T18:22:56.133935+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2025-10-15T18:22:56.1495591+00:00"
    },
    "job_status_id": "4409c6c2-e7f3-447d-821d-8fbef6a7ce4f",
    "job_status_code": "sample string 11",
    "db_address_id": "cf83266d-e6d0-4ab6-af60-da50d75999fc",
    "contact_id": "33027f7b-f1c0-40f5-82f6-dac2b7fcc1bf",
    "requested_by_company_id": "b5bff8d8-b80a-4753-9de6-d30e5bcb7e80",
    "requested_by_contact_id": "c4f55a65-be4e-4777-bc77-f62db466f859",
    "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-15T18:22:56.1495591+00:00",
    "due_date": "2025-10-15T18:22:56.1495591+00:00",
    "date_create": "2025-10-15T18:22:56.1495591+00:00",
    "date_update": "2025-10-15T18:22:56.1495591+00:00",
    "date_closed": "2025-10-15T18:22:56.1495591+00:00",
    "suggested_user_id": "3436963b-e938-4a92-8f32-c9f958d88ebb",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "53ee96d0-b6af-4fb6-b4d7-ff97a078d21d",
      "db_language_id": "04510d3b-ce20-47ef-8938-0f2e19671554",
      "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-15T18:22:56.1495591+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "830b3f08-69a5-4bb8-9800-46b100ab745d",
      "sales_organization": {
        "id": "c11593bb-faff-4056-aa94-15fc313e348f",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "d1b8ba60-8d39-4a68-9069-de8de9cbf657",
        "db_currency_id": "bbd0ab61-9243-4686-b33e-8858bb140c37",
        "db_language_id": "4063f237-b364-4ced-adfb-8532b105a646",
        "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-15T18:22:56.133935+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "3cdb181d-0987-47fb-8ec7-7c5b9166785c",
      "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": "9a3913f7-6727-4b1e-9fa0-b5b5dc55aeda",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2025-10-15T18:22:56.1495591+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "ddaaaaec-a9ac-4362-b6e9-2e84c52c044c"
    },
    "suggested_date_start": "2025-10-15T18:22:56.1495591+00:00",
    "skill_id": "f0a55eb9-74bd-4b04-b61a-82dffca647f5",
    "skill_code": "sample string 32",
    "skill": {
      "id": "dbb9fde3-eba1-4577-8141-c077905478cb",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "d1ca53f8-00c4-48c5-988b-3952e85c437d",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "c11593bb-faff-4056-aa94-15fc313e348f",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "d1b8ba60-8d39-4a68-9069-de8de9cbf657",
        "db_currency_id": "bbd0ab61-9243-4686-b33e-8858bb140c37",
        "db_language_id": "4063f237-b364-4ced-adfb-8532b105a646",
        "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-15T18:22:56.133935+00:00"
      },
      "modified_dateutc": "2025-10-15T18:22:56.1495591+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "b8a3bb24-59ea-47fb-8ba5-c8bec0406a38",
    "date_reported_by_company": "2025-10-15T18:22:56.1495591+00:00",
    "id2": 36,
    "company_id": "92cc3f1f-970d-412f-b58a-33fe059d1255",
    "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": "59a72558-a264-4e7e-9c5f-0afab1331c54",
    "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-15T18:22:56.1495591+00:00"
  },
  "work_instruction_details_id": "1120b831-e724-45fd-8bfc-02fccd91fdc9",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "794f6e67-8474-4c97-8fa8-089221c00fac",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "65501157-8e25-4029-8421-d58218cdb1c4",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2025-10-15T18:22:56.1495591+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": "df56da54-ff6f-4e5b-a125-8ddcd72838ab",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2025-10-15T18:22:56.1495591+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.