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": "7257e092-7c1a-41a7-8ec6-2e383fded6c7",
  "jobs_id": "3f291067-9912-4395-ac75-ee14bcd49d36",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "46ce912b-67cc-4f64-bb5a-71e9a5a446ec",
    "_parent_id": "2b53d0d8-e68e-4d83-b368-be7a118a2e5f",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "6735ec05-9f9c-4c7e-8f96-ee6d27b1b372",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "dd6956ac-2bfa-4434-8864-ea55e1168d1d",
      "_parent_id": "d3c88ee8-116f-4683-a8f9-5d2d13e29051",
      "root_parent_id": "c86d3341-51b6-4a86-8a23-b3a2459b891b",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "601edd9d-1c5a-43ba-98ed-efadf102fd20",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "98a4883a-ae0d-4672-b3d7-93e16d14501d",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "67f08be1-1de2-4b9b-90f2-ba3dece82d39",
        "_parent_code": "sample string 6",
        "sales_organization_id": "c494c2a6-0a7f-4266-a315-f81f1781aaad",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "0f18f0d6-6fa7-4d7f-9417-7f6817aa5d62",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "11e8d819-2c5b-4409-b035-c62a8885020e",
          "db_currency_id": "28e8dff7-9d59-451e-bb70-2d131e8aa3d7",
          "db_language_id": "654ddb0e-053b-4da9-a81d-6098fd6d1c70",
          "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-04-24T14:13:02.4781649+00:00"
        },
        "modified_dateutc": "2026-04-24T14:13:02.4781649+00:00"
      },
      "equipment_model_id": "ec30835e-3c5a-4aac-968f-a97d51b511e2",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "95e146a4-3cc3-43d1-9cb7-be38d5651fed",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "1896c11f-7aac-416b-8cb8-3db1136bf016",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "b79a0cb7-e603-40b1-94c0-afe079fc5e95",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "3ff3bb8b-b6f2-4586-bb84-ca356488983a",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "0f18f0d6-6fa7-4d7f-9417-7f6817aa5d62",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "11e8d819-2c5b-4409-b035-c62a8885020e",
            "db_currency_id": "28e8dff7-9d59-451e-bb70-2d131e8aa3d7",
            "db_language_id": "654ddb0e-053b-4da9-a81d-6098fd6d1c70",
            "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-04-24T14:13:02.4781649+00:00"
          },
          "modified_dateutc": "2026-04-24T14:13:02.4781649+00:00"
        },
        "equipment_family_id": "60001539-57ee-4081-a8be-9b0b824bda4f",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "98a4883a-ae0d-4672-b3d7-93e16d14501d",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "67f08be1-1de2-4b9b-90f2-ba3dece82d39",
          "_parent_code": "sample string 6",
          "sales_organization_id": "c494c2a6-0a7f-4266-a315-f81f1781aaad",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "0f18f0d6-6fa7-4d7f-9417-7f6817aa5d62",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "11e8d819-2c5b-4409-b035-c62a8885020e",
            "db_currency_id": "28e8dff7-9d59-451e-bb70-2d131e8aa3d7",
            "db_language_id": "654ddb0e-053b-4da9-a81d-6098fd6d1c70",
            "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-04-24T14:13:02.4781649+00:00"
          },
          "modified_dateutc": "2026-04-24T14:13:02.4781649+00:00"
        },
        "date_in_production_since": "2026-04-24T14:13:02.4781649+00:00",
        "date_out_of_production_since": "2026-04-24T14:13:02.4781649+00:00",
        "date_end_support": "2026-04-24T14:13:02.4781649+00:00",
        "sales_organization_id": "5867cf64-d566-41a7-9a5c-0fd932b9e13d",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "0f18f0d6-6fa7-4d7f-9417-7f6817aa5d62",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "11e8d819-2c5b-4409-b035-c62a8885020e",
          "db_currency_id": "28e8dff7-9d59-451e-bb70-2d131e8aa3d7",
          "db_language_id": "654ddb0e-053b-4da9-a81d-6098fd6d1c70",
          "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-04-24T14:13:02.4781649+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-04-24T14:13:02.4781649+00:00"
      },
      "project_status_id": "389084f2-3118-4c6d-aa26-127a4b42092f",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "ed2561a2-a7bc-4bc4-85fb-6ec2040f0cbd",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "c5c65968-1f10-4d06-8786-8263ee83a3da",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "0f18f0d6-6fa7-4d7f-9417-7f6817aa5d62",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "11e8d819-2c5b-4409-b035-c62a8885020e",
          "db_currency_id": "28e8dff7-9d59-451e-bb70-2d131e8aa3d7",
          "db_language_id": "654ddb0e-053b-4da9-a81d-6098fd6d1c70",
          "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-04-24T14:13:02.4781649+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-04-24T14:13:02.4781649+00:00"
      },
      "company_id": "eaf4a5e1-c247-46e7-93bb-19c587f60c9b",
      "company_code": "sample string 12",
      "db_address_id": "1b9edf6f-c6b0-4cd3-8d2e-8ddf8c2e74c7",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "76e5a090-a4f3-4bf6-a59d-393f082aab0c",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "e526d154-3fa8-4f02-90cc-391b9f4dd66f",
      "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-04-24T14:13:02.4781649+00:00",
      "date_create": "2026-04-24T14:13:02.4937895+00:00",
      "date_update": "2026-04-24T14:13:02.4937895+00:00",
      "updated_by_user_id": "2c82e954-fe96-4f3a-99dc-e81d56a11df3",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-04-24T14:13:02.4937895+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-04-24T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-04-24T14:13:02.4937895+00:00",
      "date_last_job": "2026-04-24T14:13:02.4937895+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-04-24T14:13:02.4937895+00:00",
      "modified_dateutc": "2026-04-24T14:13:02.4937895+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "5069385a-a926-4028-82cf-5600f354fc11",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "63fdcfc1-ee8e-4573-971d-96aa628d5974",
      "name": "sample string 2",
      "sales_organization_id": "fbdfb13e-a360-493e-a858-696627fc91cc",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-04-24T14:13:02.4937895+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "4884b20a-9a52-4846-8c1a-f5b01e01ceb1",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "801226a3-965f-4602-9832-a95d13009e0b",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "09a4f3da-916f-4d59-998b-6b631d89d05b",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "0f18f0d6-6fa7-4d7f-9417-7f6817aa5d62",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "11e8d819-2c5b-4409-b035-c62a8885020e",
        "db_currency_id": "28e8dff7-9d59-451e-bb70-2d131e8aa3d7",
        "db_language_id": "654ddb0e-053b-4da9-a81d-6098fd6d1c70",
        "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-04-24T14:13:02.4781649+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-04-24T14:13:02.4937895+00:00"
    },
    "job_status_id": "cd42cfcf-eace-4ff0-a76b-1458be5064cb",
    "job_status_code": "sample string 11",
    "db_address_id": "88feafac-4de3-4052-a947-a36a84457fd5",
    "contact_id": "5fc0f39e-d7b5-44d4-96ae-92f663936f89",
    "requested_by_company_id": "396ed980-cd90-4c6e-850e-c4eb416fec1a",
    "requested_by_contact_id": "acb5d19a-dc0a-4f9f-b63a-153b09c6f70c",
    "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-04-24T14:13:02.4937895+00:00",
    "due_date": "2026-04-24T14:13:02.4937895+00:00",
    "date_create": "2026-04-24T14:13:02.4937895+00:00",
    "date_update": "2026-04-24T14:13:02.4937895+00:00",
    "date_closed": "2026-04-24T14:13:02.4937895+00:00",
    "suggested_user_id": "daab72e2-da08-4def-8a05-4b182d600ebe",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "a94bf1ed-c5ea-48aa-b9cf-a99ea6216541",
      "db_language_id": "cd3d4acc-7f3a-4af7-97c3-39403bc5250a",
      "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-04-24T14:13:02.4937895+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "1052c8b3-536e-46da-a8c4-f6a0962636f7",
      "sales_organization": {
        "id": "0f18f0d6-6fa7-4d7f-9417-7f6817aa5d62",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "11e8d819-2c5b-4409-b035-c62a8885020e",
        "db_currency_id": "28e8dff7-9d59-451e-bb70-2d131e8aa3d7",
        "db_language_id": "654ddb0e-053b-4da9-a81d-6098fd6d1c70",
        "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-04-24T14:13:02.4781649+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "e4f66f0d-13eb-4c22-8656-52690565b1d3",
      "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": "3366003f-e649-473c-a9f6-594a7eb51954",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-04-24T14:13:02.4937895+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "ea70f118-b9f0-4e35-8a9f-ca20343a126a"
    },
    "suggested_date_start": "2026-04-24T14:13:02.4937895+00:00",
    "skill_id": "4b26f840-c860-4122-939b-b3b6a5e9f00a",
    "skill_code": "sample string 32",
    "skill": {
      "id": "d1d5f960-1da5-4288-b49b-6eaf355b17e9",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "d822eca2-20f6-4ba4-b0f7-140abef492e2",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "0f18f0d6-6fa7-4d7f-9417-7f6817aa5d62",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "11e8d819-2c5b-4409-b035-c62a8885020e",
        "db_currency_id": "28e8dff7-9d59-451e-bb70-2d131e8aa3d7",
        "db_language_id": "654ddb0e-053b-4da9-a81d-6098fd6d1c70",
        "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-04-24T14:13:02.4781649+00:00"
      },
      "modified_dateutc": "2026-04-24T14:13:02.4937895+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "4c2acac4-f83e-4eeb-8c45-b303c5e1c7e1",
    "date_reported_by_company": "2026-04-24T14:13:02.4937895+00:00",
    "id2": 36,
    "company_id": "bf364041-b6d6-4fc1-826d-3ad210dadb62",
    "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": "3a605cc3-b7ca-48be-a363-a2e4137998ba",
    "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-04-24T14:13:02.4937895+00:00"
  },
  "work_instruction_details_id": "a6406469-52df-4cd0-a420-d801f29429c6",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "33419fc3-09b2-446b-ada8-9a625f2d5cf0",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "be38f10b-a00d-426c-8780-4a85c6b99e13",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-04-24T14:13:02.4937895+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": "4d2308e6-9e2b-4de1-b4d9-d7b849812b90",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-04-24T14:13:02.4937895+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.