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": "c11b6919-4f4e-4c31-9c59-425175435549",
  "jobs_id": "a176845e-d283-4bf0-988e-c82d9f79980a",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "f4585de7-14ce-478c-92ac-99e633a3577e",
    "_parent_id": "da2f1e30-ffc1-4671-ab42-949c09036c1d",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "7ee9fce2-06ce-4167-838a-b81de7b59dd7",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "db2e4417-c0f5-47e3-8d1b-96724a30510b",
      "_parent_id": "73089fec-b043-406a-b7f6-df60f1742091",
      "root_parent_id": "154210a7-77cf-422b-afd4-fa6477623029",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "c950bed9-a133-4360-ada6-b76ceb4536fe",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "8b18fc2c-c23e-47f7-8f6e-01f9ab508d79",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "49d56999-a14b-4473-b7fe-3ffe920f190f",
        "_parent_code": "sample string 6",
        "sales_organization_id": "f1a1d47a-f5e8-4152-b07d-38c87f26439a",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "93b43d67-5a14-4884-8c37-f0cefe12c1f5",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "9d7e6466-21a4-4eff-b99c-b77b0d873969",
          "db_currency_id": "b8e089ee-adc0-4e20-9218-a71775123c01",
          "db_language_id": "90f0b709-d664-439d-8c93-3c542ea2da2f",
          "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-09-18T07:34:53.8744574+00:00"
        },
        "modified_dateutc": "2026-09-18T07:34:53.8744574+00:00"
      },
      "equipment_model_id": "17c43e96-f049-461b-8147-7e08dd19eec1",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "e014d960-fd8a-453a-9a8e-e2fd5333dabc",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "f23327f3-1133-4ff6-8d0b-51d66a024a20",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "6dd840df-936e-4db8-92d3-6a450b091b22",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "2c20db00-9a35-462e-a352-fbebcb626f64",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "93b43d67-5a14-4884-8c37-f0cefe12c1f5",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "9d7e6466-21a4-4eff-b99c-b77b0d873969",
            "db_currency_id": "b8e089ee-adc0-4e20-9218-a71775123c01",
            "db_language_id": "90f0b709-d664-439d-8c93-3c542ea2da2f",
            "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-09-18T07:34:53.8744574+00:00"
          },
          "modified_dateutc": "2026-09-18T07:34:53.8744574+00:00"
        },
        "equipment_family_id": "764bf256-65e1-468b-a38e-191c78bee9a1",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "8b18fc2c-c23e-47f7-8f6e-01f9ab508d79",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "49d56999-a14b-4473-b7fe-3ffe920f190f",
          "_parent_code": "sample string 6",
          "sales_organization_id": "f1a1d47a-f5e8-4152-b07d-38c87f26439a",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "93b43d67-5a14-4884-8c37-f0cefe12c1f5",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "9d7e6466-21a4-4eff-b99c-b77b0d873969",
            "db_currency_id": "b8e089ee-adc0-4e20-9218-a71775123c01",
            "db_language_id": "90f0b709-d664-439d-8c93-3c542ea2da2f",
            "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-09-18T07:34:53.8744574+00:00"
          },
          "modified_dateutc": "2026-09-18T07:34:53.8744574+00:00"
        },
        "date_in_production_since": "2026-09-18T07:34:53.8744574+00:00",
        "date_out_of_production_since": "2026-09-18T07:34:53.8744574+00:00",
        "date_end_support": "2026-09-18T07:34:53.8744574+00:00",
        "sales_organization_id": "98f987aa-b405-4bd1-808d-938884e2ad4b",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "93b43d67-5a14-4884-8c37-f0cefe12c1f5",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "9d7e6466-21a4-4eff-b99c-b77b0d873969",
          "db_currency_id": "b8e089ee-adc0-4e20-9218-a71775123c01",
          "db_language_id": "90f0b709-d664-439d-8c93-3c542ea2da2f",
          "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-09-18T07:34:53.8744574+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-09-18T07:34:53.8744574+00:00"
      },
      "project_status_id": "2916a8da-909d-4259-be25-bc93a3308a91",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "1c88645d-55f7-49a9-9c4e-8f7d55239343",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "43ab8b8c-5b60-4b1e-99a7-a4730f2579dd",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "93b43d67-5a14-4884-8c37-f0cefe12c1f5",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "9d7e6466-21a4-4eff-b99c-b77b0d873969",
          "db_currency_id": "b8e089ee-adc0-4e20-9218-a71775123c01",
          "db_language_id": "90f0b709-d664-439d-8c93-3c542ea2da2f",
          "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-09-18T07:34:53.8744574+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-09-18T07:34:53.8744574+00:00"
      },
      "company_id": "414f8fa7-35a7-42ed-9468-4c4b726fef12",
      "company_code": "sample string 12",
      "db_address_id": "93244ed6-a1ec-4549-a2df-ed4ee333e244",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "ef036ee9-3906-43eb-8d7b-d92a5a8c3c1d",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "20b4c13b-9459-40f9-a98a-37bf8cf4a822",
      "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-09-18T07:34:53.8744574+00:00",
      "date_create": "2026-09-18T07:34:53.8744574+00:00",
      "date_update": "2026-09-18T07:34:53.8744574+00:00",
      "updated_by_user_id": "54cf91aa-765e-408c-a1f5-a36db1ce1e67",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-09-18T07:34:53.8744574+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-09-18T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-09-18T07:34:53.8744574+00:00",
      "date_last_job": "2026-09-18T07:34:53.8744574+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-09-18T07:34:53.8744574+00:00",
      "modified_dateutc": "2026-09-18T07:34:53.8744574+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "e8238609-2945-40ab-a13f-a1bc1294d1d7",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "417ac588-3e8c-4129-8e39-cc389d464ee7",
      "name": "sample string 2",
      "sales_organization_id": "ed0868ca-32a7-41e0-83f8-f71e1a590510",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-09-18T07:34:53.8744574+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "76adf2d5-7fc6-43e6-86ee-faeb297fa28e",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "52070806-fdbf-4cb2-9527-25e3fc67efe1",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "30b14ab7-cf32-4ac0-9a94-23dd34cfc925",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "93b43d67-5a14-4884-8c37-f0cefe12c1f5",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "9d7e6466-21a4-4eff-b99c-b77b0d873969",
        "db_currency_id": "b8e089ee-adc0-4e20-9218-a71775123c01",
        "db_language_id": "90f0b709-d664-439d-8c93-3c542ea2da2f",
        "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-09-18T07:34:53.8744574+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-09-18T07:34:53.8744574+00:00"
    },
    "job_status_id": "565b597d-d48e-4f3e-ab6b-554ce79f3f42",
    "job_status_code": "sample string 11",
    "db_address_id": "f03f66bc-8a7d-4035-956d-f1d62d4f2042",
    "contact_id": "ee45264a-8b06-4b78-8212-86c922592942",
    "requested_by_company_id": "8f0d6b38-2e53-4894-b20e-fb8c18c9feb1",
    "requested_by_contact_id": "c19919f5-59c2-4dd2-a6af-ff08e058d511",
    "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-09-18T07:34:53.8744574+00:00",
    "due_date": "2026-09-18T07:34:53.8744574+00:00",
    "date_create": "2026-09-18T07:34:53.8744574+00:00",
    "date_update": "2026-09-18T07:34:53.8744574+00:00",
    "date_closed": "2026-09-18T07:34:53.8744574+00:00",
    "suggested_user_id": "4fd8785f-232e-410e-b230-d568812b549c",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "d412ffc8-4c49-4bc9-bc3c-656b6c5c6f2c",
      "db_language_id": "96b6f463-8d25-4651-90a7-81c74416151b",
      "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-09-18T07:34:53.8744574+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "9735a45c-74c1-4465-b7ce-308583b43bd6",
      "sales_organization": {
        "id": "93b43d67-5a14-4884-8c37-f0cefe12c1f5",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "9d7e6466-21a4-4eff-b99c-b77b0d873969",
        "db_currency_id": "b8e089ee-adc0-4e20-9218-a71775123c01",
        "db_language_id": "90f0b709-d664-439d-8c93-3c542ea2da2f",
        "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-09-18T07:34:53.8744574+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "30419aef-71ba-4372-83ad-d771dbbd8ba1",
      "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": "2395737c-20b0-4243-802c-1e0944d25fb4",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-09-18T07:34:53.8744574+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "5b3b9f46-9c7c-4093-bf79-7d807fbefb02"
    },
    "suggested_date_start": "2026-09-18T07:34:53.8744574+00:00",
    "skill_id": "a754a1aa-acc4-4001-9c31-90e3f823f208",
    "skill_code": "sample string 32",
    "skill": {
      "id": "83c2fbdb-c774-47e8-b711-09419289f907",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "945cb560-0768-4091-aa17-e42f97102ab0",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "93b43d67-5a14-4884-8c37-f0cefe12c1f5",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "9d7e6466-21a4-4eff-b99c-b77b0d873969",
        "db_currency_id": "b8e089ee-adc0-4e20-9218-a71775123c01",
        "db_language_id": "90f0b709-d664-439d-8c93-3c542ea2da2f",
        "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-09-18T07:34:53.8744574+00:00"
      },
      "modified_dateutc": "2026-09-18T07:34:53.8744574+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "c151c515-b1a7-402d-ba34-3e1cdd601f61",
    "date_reported_by_company": "2026-09-18T07:34:53.8744574+00:00",
    "id2": 36,
    "company_id": "9b6ad07f-2932-4835-ab1a-3c671edc3e38",
    "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": "b296743f-17fd-478c-9acc-03909a6c1ca8",
    "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-09-18T07:34:53.8744574+00:00"
  },
  "work_instruction_details_id": "071a0f07-fc9a-461c-b8f9-a9db331b2f7e",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "53b97084-a3f3-4616-a20a-1a036ce9e60a",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "c816b8ad-3de0-4f56-bae8-ab7113665f47",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-09-18T07:34:53.8744574+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": "0d10cc13-e8c0-45a0-8fe3-d1bbbe96a2de",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-09-18T07:34:53.8744574+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.