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": "cd489ed3-e8a8-44eb-a491-0b867fcbdeb5",
  "jobs_id": "eeb94055-a378-4c75-a74e-6e572d10c6f8",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "51840acf-9c76-4340-9ffc-b494f2c07cec",
    "_parent_id": "13e7d885-c764-444e-a10b-5d9766dd642e",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "b63dc7cd-d679-4fa3-ad03-640dbcc1534c",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "af294715-9a7f-4151-a003-322046eaba50",
      "_parent_id": "35d389f9-47ad-4c98-985f-57879122ee2e",
      "root_parent_id": "161950ef-927a-4224-81e7-96e94ac009ba",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "7061b0a5-ec89-40ca-9caa-f2b679cf6896",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "e6b6e466-5143-4169-812a-32ebdf94b564",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "83de1454-a47f-4350-815b-a9fe03524c28",
        "_parent_code": "sample string 6",
        "sales_organization_id": "6dcdf1ea-3b37-4e6b-98f8-4592192fd816",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "fb3abea8-8d80-4a15-8b9e-95a6136cb785",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "379aadb1-5396-4bf6-b055-b28633284857",
          "db_currency_id": "24f3c895-c4ef-4102-9301-4e75c1361d4a",
          "db_language_id": "8cb7f153-c542-49be-a87f-5ecb7bccf1cf",
          "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-19T19:04:15.1190722+00:00"
        },
        "modified_dateutc": "2026-11-19T19:04:15.1190722+00:00"
      },
      "equipment_model_id": "0e49cfa5-cb16-4c5b-8b11-4a144c12606c",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "59114f87-80cf-4a3e-a140-6af81293a55e",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "ef8483c4-49bf-4a75-a381-7a4dc0f14eb1",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "8e3bfa05-b029-42c1-be0b-768b7edd132e",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "ab56269c-e293-4a11-9001-ebfca6414b59",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "fb3abea8-8d80-4a15-8b9e-95a6136cb785",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "379aadb1-5396-4bf6-b055-b28633284857",
            "db_currency_id": "24f3c895-c4ef-4102-9301-4e75c1361d4a",
            "db_language_id": "8cb7f153-c542-49be-a87f-5ecb7bccf1cf",
            "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-19T19:04:15.1190722+00:00"
          },
          "modified_dateutc": "2026-11-19T19:04:15.1190722+00:00"
        },
        "equipment_family_id": "979e3b71-c213-44e2-b82b-b5d45e895d11",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "e6b6e466-5143-4169-812a-32ebdf94b564",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "83de1454-a47f-4350-815b-a9fe03524c28",
          "_parent_code": "sample string 6",
          "sales_organization_id": "6dcdf1ea-3b37-4e6b-98f8-4592192fd816",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "fb3abea8-8d80-4a15-8b9e-95a6136cb785",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "379aadb1-5396-4bf6-b055-b28633284857",
            "db_currency_id": "24f3c895-c4ef-4102-9301-4e75c1361d4a",
            "db_language_id": "8cb7f153-c542-49be-a87f-5ecb7bccf1cf",
            "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-19T19:04:15.1190722+00:00"
          },
          "modified_dateutc": "2026-11-19T19:04:15.1190722+00:00"
        },
        "date_in_production_since": "2026-11-19T19:04:15.1190722+00:00",
        "date_out_of_production_since": "2026-11-19T19:04:15.1190722+00:00",
        "date_end_support": "2026-11-19T19:04:15.1190722+00:00",
        "sales_organization_id": "3358098e-3ebe-4058-8480-0d349b3cfaa1",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "fb3abea8-8d80-4a15-8b9e-95a6136cb785",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "379aadb1-5396-4bf6-b055-b28633284857",
          "db_currency_id": "24f3c895-c4ef-4102-9301-4e75c1361d4a",
          "db_language_id": "8cb7f153-c542-49be-a87f-5ecb7bccf1cf",
          "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-19T19:04:15.1190722+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-19T19:04:15.1190722+00:00"
      },
      "project_status_id": "d08997d5-b4d1-4b78-906b-32383aa2bc5d",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "f03abef5-3151-4bff-9590-441739345ba5",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "0f8bddc2-f344-4e91-87af-2a8824ddd8f3",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "fb3abea8-8d80-4a15-8b9e-95a6136cb785",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "379aadb1-5396-4bf6-b055-b28633284857",
          "db_currency_id": "24f3c895-c4ef-4102-9301-4e75c1361d4a",
          "db_language_id": "8cb7f153-c542-49be-a87f-5ecb7bccf1cf",
          "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-19T19:04:15.1190722+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-11-19T19:04:15.1190722+00:00"
      },
      "company_id": "f3ca7bee-0c67-4fcc-8ead-48a5496a8047",
      "company_code": "sample string 12",
      "db_address_id": "3f335241-1fa2-405b-945b-437de29328ad",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "c7c10f89-60aa-42b3-b363-8d3e6bb90c91",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "db6880ef-64b8-47d8-96cb-2cd6479b368e",
      "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-19T19:04:15.1190722+00:00",
      "date_create": "2026-11-19T19:04:15.1190722+00:00",
      "date_update": "2026-11-19T19:04:15.1190722+00:00",
      "updated_by_user_id": "66a4d28b-28d5-49ad-8d38-34d24497fb6d",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-11-19T19:04:15.1190722+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-19T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-11-19T19:04:15.1190722+00:00",
      "date_last_job": "2026-11-19T19:04:15.1190722+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-11-19T19:04:15.1190722+00:00",
      "modified_dateutc": "2026-11-19T19:04:15.1190722+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "5bdc2a28-1086-4513-aba1-5cc745f5b199",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "119dab6a-f841-4c4a-a460-6372d3bbecdd",
      "name": "sample string 2",
      "sales_organization_id": "707b96bb-584f-40d0-99fa-cbcf6c98d3fb",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-11-19T19:04:15.1190722+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "c2559241-c2cc-4fb9-ae64-6aca246ce00d",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "1b4912a4-e86e-403a-9f0b-8defc9a84ef4",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "e670a662-1eec-45fc-9105-aae56d638fe5",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "fb3abea8-8d80-4a15-8b9e-95a6136cb785",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "379aadb1-5396-4bf6-b055-b28633284857",
        "db_currency_id": "24f3c895-c4ef-4102-9301-4e75c1361d4a",
        "db_language_id": "8cb7f153-c542-49be-a87f-5ecb7bccf1cf",
        "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-19T19:04:15.1190722+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-11-19T19:04:15.1190722+00:00"
    },
    "job_status_id": "fcfacabe-9e28-4424-841a-ba45e911d1de",
    "job_status_code": "sample string 11",
    "db_address_id": "a6010875-ce85-4aef-9816-8862fa1ae160",
    "contact_id": "e4337660-967c-4512-a930-3b37358adfc7",
    "requested_by_company_id": "529db3c9-5097-4b87-80d5-4ea48aac33da",
    "requested_by_contact_id": "b8fb5cef-b20a-4f67-8a7c-a2560f945256",
    "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-19T19:04:15.1190722+00:00",
    "due_date": "2026-11-19T19:04:15.1190722+00:00",
    "date_create": "2026-11-19T19:04:15.1190722+00:00",
    "date_update": "2026-11-19T19:04:15.1190722+00:00",
    "date_closed": "2026-11-19T19:04:15.1190722+00:00",
    "suggested_user_id": "db2b7073-e522-4278-af3a-58bb7f45b4e1",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "bb0d1379-a08c-4b27-bcdf-864d5d2cb52a",
      "db_language_id": "b54602d2-9394-4096-9b14-8d8256b9622d",
      "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-19T19:04:15.1190722+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "08532c05-1ad2-49d0-bc01-c4be2259dc4f",
      "sales_organization": {
        "id": "fb3abea8-8d80-4a15-8b9e-95a6136cb785",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "379aadb1-5396-4bf6-b055-b28633284857",
        "db_currency_id": "24f3c895-c4ef-4102-9301-4e75c1361d4a",
        "db_language_id": "8cb7f153-c542-49be-a87f-5ecb7bccf1cf",
        "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-19T19:04:15.1190722+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "8114bd86-023e-4189-b123-7f20166c62cc",
      "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": "ec93ab19-1a23-4ac7-9ad6-b35f77d67cab",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-11-19T19:04:15.1190722+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "5246353a-c188-4027-a520-64b59e1a90fc"
    },
    "suggested_date_start": "2026-11-19T19:04:15.1190722+00:00",
    "skill_id": "2e0e9249-da3d-410f-a526-c697f76a414c",
    "skill_code": "sample string 32",
    "skill": {
      "id": "d363b2d0-8577-4b13-ad8e-0fd16784a375",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "86801333-9d34-4fbc-882a-756da5a35687",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "fb3abea8-8d80-4a15-8b9e-95a6136cb785",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "379aadb1-5396-4bf6-b055-b28633284857",
        "db_currency_id": "24f3c895-c4ef-4102-9301-4e75c1361d4a",
        "db_language_id": "8cb7f153-c542-49be-a87f-5ecb7bccf1cf",
        "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-19T19:04:15.1190722+00:00"
      },
      "modified_dateutc": "2026-11-19T19:04:15.1190722+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "70bd1f19-b3f8-4a00-a179-4fbb17b66f9e",
    "date_reported_by_company": "2026-11-19T19:04:15.1190722+00:00",
    "id2": 36,
    "company_id": "87bffcb4-7d54-42e1-8fd7-ea838dd3f311",
    "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": "c130e5ae-2e15-4ad7-b3de-70e1c342236c",
    "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-19T19:04:15.1190722+00:00"
  },
  "work_instruction_details_id": "31437d28-19c8-4fea-a02a-21fbb2ad4e95",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "6078e677-629d-4833-99d5-7d9f684ee4a3",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "2477fb42-4e45-475c-987d-fb2039ffb54a",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-11-19T19:04:15.1190722+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": "59b1fa4d-6d8c-4ffb-91f8-4a51aab1b1a4",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-11-19T19:04:15.1190722+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.