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": "a8e6c2c2-0a9f-48fb-bc25-f6199fdb3b04",
  "jobs_id": "6d69777b-b169-4e5d-9cbf-200f51506b0a",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "4a0d716c-1875-43f0-b128-222737d62ed6",
    "_parent_id": "e46b95e1-dcd9-4b37-82d1-f34477abc60b",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "4eaf636e-c3b6-43ea-a6ba-148444471f08",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "d9df3031-8cdb-42ab-ba2a-67d7598be02d",
      "_parent_id": "01dc320d-656d-4f43-a9b8-32b0edc08da2",
      "root_parent_id": "6e1f3583-ec3b-457a-8d2d-8a99cbfa20d7",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "ede1b1e8-561a-40c8-b029-f07e64d0802b",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "30672cde-8d24-4423-86c5-e35d05a4af17",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "fc90a092-2f48-4e02-b3fb-e9fcdd56be87",
        "_parent_code": "sample string 6",
        "sales_organization_id": "e342203c-9ccd-415c-90aa-8ffdcea395e4",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "90cf6050-941f-431b-aee0-0c35ee923214",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "d28679eb-1276-4074-be9e-2595770bae9d",
          "db_currency_id": "785e934d-2fb6-4029-9b62-51f0b7ddef04",
          "db_language_id": "9a1cb187-610d-4154-87e3-902ba9014723",
          "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-11-21T06:46:34.7777724+00:00"
        },
        "modified_dateutc": "2025-11-21T06:46:34.7777724+00:00"
      },
      "equipment_model_id": "01e30385-fa5d-4925-a44e-60f0b462be27",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "aa427e32-9121-43c5-b5ab-56cb6be646f8",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "8aa721e2-f7ab-4968-b01b-914ddbc1666a",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "4721532e-5286-46c3-a507-114b4cab3bfa",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "be487a81-bfa0-4a45-acdf-42e1df2e2b81",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "90cf6050-941f-431b-aee0-0c35ee923214",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "d28679eb-1276-4074-be9e-2595770bae9d",
            "db_currency_id": "785e934d-2fb6-4029-9b62-51f0b7ddef04",
            "db_language_id": "9a1cb187-610d-4154-87e3-902ba9014723",
            "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-11-21T06:46:34.7777724+00:00"
          },
          "modified_dateutc": "2025-11-21T06:46:34.7777724+00:00"
        },
        "equipment_family_id": "406236a7-a6a7-4a2b-85c1-6135f6ac88d4",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "30672cde-8d24-4423-86c5-e35d05a4af17",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "fc90a092-2f48-4e02-b3fb-e9fcdd56be87",
          "_parent_code": "sample string 6",
          "sales_organization_id": "e342203c-9ccd-415c-90aa-8ffdcea395e4",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "90cf6050-941f-431b-aee0-0c35ee923214",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "d28679eb-1276-4074-be9e-2595770bae9d",
            "db_currency_id": "785e934d-2fb6-4029-9b62-51f0b7ddef04",
            "db_language_id": "9a1cb187-610d-4154-87e3-902ba9014723",
            "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-11-21T06:46:34.7777724+00:00"
          },
          "modified_dateutc": "2025-11-21T06:46:34.7777724+00:00"
        },
        "date_in_production_since": "2025-11-21T06:46:34.7777724+00:00",
        "date_out_of_production_since": "2025-11-21T06:46:34.7777724+00:00",
        "date_end_support": "2025-11-21T06:46:34.7777724+00:00",
        "sales_organization_id": "ab03ee20-709b-44be-93b4-679140fd239b",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "90cf6050-941f-431b-aee0-0c35ee923214",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "d28679eb-1276-4074-be9e-2595770bae9d",
          "db_currency_id": "785e934d-2fb6-4029-9b62-51f0b7ddef04",
          "db_language_id": "9a1cb187-610d-4154-87e3-902ba9014723",
          "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-11-21T06:46:34.7777724+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-11-21T06:46:34.7777724+00:00"
      },
      "project_status_id": "1e55c68c-d07f-4593-b117-c2e86dca0710",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "ca451bbd-c9bb-4bf2-a424-e888af6d9cab",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "b54e7c7b-0415-4016-8929-6e1837725c6b",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "90cf6050-941f-431b-aee0-0c35ee923214",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "d28679eb-1276-4074-be9e-2595770bae9d",
          "db_currency_id": "785e934d-2fb6-4029-9b62-51f0b7ddef04",
          "db_language_id": "9a1cb187-610d-4154-87e3-902ba9014723",
          "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-11-21T06:46:34.7777724+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2025-11-21T06:46:34.7777724+00:00"
      },
      "company_id": "eb29c054-54ff-4895-a4ab-7cb80a219656",
      "company_code": "sample string 12",
      "db_address_id": "aae03142-af93-4037-a06c-cc6cca04ffa4",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "7e463f27-62a9-4b8f-bcfe-0be097f112f2",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "f9a34306-e0f2-47db-8819-7ad3003cc0eb",
      "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-11-21T06:46:34.7777724+00:00",
      "date_create": "2025-11-21T06:46:34.7777724+00:00",
      "date_update": "2025-11-21T06:46:34.7777724+00:00",
      "updated_by_user_id": "e54582bb-1ebc-4807-8b33-3a18960b4ae8",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2025-11-21T06:46:34.7777724+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-11-21T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2025-11-21T06:46:34.7777724+00:00",
      "date_last_job": "2025-11-21T06:46:34.7777724+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2025-11-21T06:46:34.7777724+00:00",
      "modified_dateutc": "2025-11-21T06:46:34.7777724+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "d1d56ffc-f21e-4fa9-8589-375748c435ff",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "914f204b-a189-4d7e-b52b-c2f239c16fd6",
      "name": "sample string 2",
      "sales_organization_id": "5e2ef0dd-ec93-4e67-a5ac-c809309616db",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2025-11-21T06:46:34.7777724+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "fbf396b2-209e-411d-90eb-1b7bbdac3be3",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "36f9a9c4-d7f6-41b0-8cde-cb6886f52f0e",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "37f80c0a-4379-48bc-9251-ba3fb63c6c4c",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "90cf6050-941f-431b-aee0-0c35ee923214",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "d28679eb-1276-4074-be9e-2595770bae9d",
        "db_currency_id": "785e934d-2fb6-4029-9b62-51f0b7ddef04",
        "db_language_id": "9a1cb187-610d-4154-87e3-902ba9014723",
        "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-11-21T06:46:34.7777724+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2025-11-21T06:46:34.7777724+00:00"
    },
    "job_status_id": "14e97f66-d5dd-4560-a5f0-d43e693c4230",
    "job_status_code": "sample string 11",
    "db_address_id": "3830ab16-d5f8-42a9-8c0f-5e0c204972db",
    "contact_id": "a6dbdd77-d294-4255-ba36-ac41b2af83c9",
    "requested_by_company_id": "f34b5fa3-7c78-4037-90b9-ebff2c17e6a3",
    "requested_by_contact_id": "23330996-c3d5-4312-81f0-178cdad5f693",
    "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-11-21T06:46:34.7777724+00:00",
    "due_date": "2025-11-21T06:46:34.7777724+00:00",
    "date_create": "2025-11-21T06:46:34.7777724+00:00",
    "date_update": "2025-11-21T06:46:34.7777724+00:00",
    "date_closed": "2025-11-21T06:46:34.7777724+00:00",
    "suggested_user_id": "a071f1ff-d2d0-41c9-a3e1-d2c1508f48a3",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "51e792fd-981e-4592-886a-351f499d67d8",
      "db_language_id": "473839e8-c710-443d-b8a0-753b1a96a288",
      "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-11-21T06:46:34.7777724+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "084bcc6a-86b3-4b5d-a8e4-d1ac29f52060",
      "sales_organization": {
        "id": "90cf6050-941f-431b-aee0-0c35ee923214",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "d28679eb-1276-4074-be9e-2595770bae9d",
        "db_currency_id": "785e934d-2fb6-4029-9b62-51f0b7ddef04",
        "db_language_id": "9a1cb187-610d-4154-87e3-902ba9014723",
        "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-11-21T06:46:34.7777724+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "19f97200-9f04-4c29-a510-7130291cde26",
      "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": "18d9f31f-7392-4d6b-9e85-5fbe316c86b7",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2025-11-21T06:46:34.7777724+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "a96f3024-2b1a-48e8-9b86-183a4800da57"
    },
    "suggested_date_start": "2025-11-21T06:46:34.7777724+00:00",
    "skill_id": "17e8e7ff-8013-4549-a264-ec365233ca97",
    "skill_code": "sample string 32",
    "skill": {
      "id": "ae4c92fd-96e6-4edd-8b88-0894088b79cc",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "85216173-885e-427d-bd9e-b2bd06783e07",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "90cf6050-941f-431b-aee0-0c35ee923214",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "d28679eb-1276-4074-be9e-2595770bae9d",
        "db_currency_id": "785e934d-2fb6-4029-9b62-51f0b7ddef04",
        "db_language_id": "9a1cb187-610d-4154-87e3-902ba9014723",
        "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-11-21T06:46:34.7777724+00:00"
      },
      "modified_dateutc": "2025-11-21T06:46:34.793395+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "be652013-f3ef-4745-91f5-a3669f5c2be9",
    "date_reported_by_company": "2025-11-21T06:46:34.793395+00:00",
    "id2": 36,
    "company_id": "7a8debf0-a269-4823-a51d-2226a7705a64",
    "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": "fd022780-13c1-4a6e-b1b3-09531d4fe4cb",
    "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-11-21T06:46:34.793395+00:00"
  },
  "work_instruction_details_id": "71f06b6b-66f0-4b73-83fe-19507bd1d58c",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "45ed860e-0d2e-4b8f-87a4-5a09f9c5a256",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "a83a54a5-4c76-4100-9119-aba6e7c2f95a",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2025-11-21T06:46:34.793395+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": "cd493d41-bed2-4d82-a5c7-577cef41a625",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2025-11-21T06:46:34.793395+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.