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": "67ffd2c2-22b2-4a02-84ea-d34fffc36bce",
  "jobs_id": "c231574e-e4b6-4731-b833-a62648bfabbd",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "7806fb91-4202-44a4-823b-763e8e5c2d61",
    "_parent_id": "0b7ea3c1-b97e-4ac9-9dcf-24fd2471236c",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "3166d0d3-2a1d-4064-bdbf-ff8bacd6471c",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "3948ec32-9d08-4ba8-be79-27ab8dcaae3b",
      "_parent_id": "d7aab263-5297-4b89-b3b4-9d4c0d7ddf0f",
      "root_parent_id": "6e6ee258-fc73-4a44-af59-b9e89c5da252",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "4e6da41f-aefd-4d1b-8d6e-739fdd6fe730",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "f3575057-fa59-438b-b506-8a67f52b8386",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "c06893f1-fb85-4804-8479-03b8bc42370f",
        "_parent_code": "sample string 6",
        "sales_organization_id": "504f8f73-b8d2-4731-ae6c-77e91a664171",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "3df5c442-be2e-4baa-9c2b-bbe772fcbbd1",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "4a1dc252-a727-4631-88bc-d71d14d80240",
          "db_currency_id": "c09a0f8a-869c-4e00-9d93-979308fd1afe",
          "db_language_id": "a61c11d4-bd10-4d9e-93bf-3816dbb9913d",
          "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-22T09:08:22.8966916+00:00"
        },
        "modified_dateutc": "2026-11-22T09:08:22.8966916+00:00"
      },
      "equipment_model_id": "e3ccd6cd-4231-429f-8906-e5c5b5b4881c",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "7101fa82-2380-432f-b149-13f86c77c172",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "882d3afc-979e-4ded-8445-0a2626071cd7",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "e152dd64-da9f-430a-a439-51643dcf9dac",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "5ea13f1b-28ea-4ef1-aa49-4bae7fe580d9",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "3df5c442-be2e-4baa-9c2b-bbe772fcbbd1",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "4a1dc252-a727-4631-88bc-d71d14d80240",
            "db_currency_id": "c09a0f8a-869c-4e00-9d93-979308fd1afe",
            "db_language_id": "a61c11d4-bd10-4d9e-93bf-3816dbb9913d",
            "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-22T09:08:22.8966916+00:00"
          },
          "modified_dateutc": "2026-11-22T09:08:22.8966916+00:00"
        },
        "equipment_family_id": "54d10845-d7de-445d-8d3b-2933f8d57333",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "f3575057-fa59-438b-b506-8a67f52b8386",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "c06893f1-fb85-4804-8479-03b8bc42370f",
          "_parent_code": "sample string 6",
          "sales_organization_id": "504f8f73-b8d2-4731-ae6c-77e91a664171",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "3df5c442-be2e-4baa-9c2b-bbe772fcbbd1",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "4a1dc252-a727-4631-88bc-d71d14d80240",
            "db_currency_id": "c09a0f8a-869c-4e00-9d93-979308fd1afe",
            "db_language_id": "a61c11d4-bd10-4d9e-93bf-3816dbb9913d",
            "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-22T09:08:22.8966916+00:00"
          },
          "modified_dateutc": "2026-11-22T09:08:22.8966916+00:00"
        },
        "date_in_production_since": "2026-11-22T09:08:22.8966916+00:00",
        "date_out_of_production_since": "2026-11-22T09:08:22.8966916+00:00",
        "date_end_support": "2026-11-22T09:08:22.8966916+00:00",
        "sales_organization_id": "78c69647-3224-448e-af5d-ca2c840e351f",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "3df5c442-be2e-4baa-9c2b-bbe772fcbbd1",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "4a1dc252-a727-4631-88bc-d71d14d80240",
          "db_currency_id": "c09a0f8a-869c-4e00-9d93-979308fd1afe",
          "db_language_id": "a61c11d4-bd10-4d9e-93bf-3816dbb9913d",
          "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-22T09:08:22.8966916+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-22T09:08:22.8966916+00:00"
      },
      "project_status_id": "e8e08e8f-0a80-4a07-90b9-8a57499c91b0",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "5f3726ee-d2ff-4e91-865a-bd8131a4c514",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "fc9daac8-c157-4d54-934d-f961000efd05",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "3df5c442-be2e-4baa-9c2b-bbe772fcbbd1",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "4a1dc252-a727-4631-88bc-d71d14d80240",
          "db_currency_id": "c09a0f8a-869c-4e00-9d93-979308fd1afe",
          "db_language_id": "a61c11d4-bd10-4d9e-93bf-3816dbb9913d",
          "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-22T09:08:22.8966916+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-11-22T09:08:22.8966916+00:00"
      },
      "company_id": "d214512c-4d9e-44c6-bcd8-b3913ab1d7af",
      "company_code": "sample string 12",
      "db_address_id": "d6c1e28e-2ebe-4a09-b133-ac2fd5954bce",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "81ffa700-301c-4a6c-a3c1-1769fd880dcd",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "a2152a83-8d59-43c0-b6de-d979bfcc50ea",
      "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-22T09:08:22.8966916+00:00",
      "date_create": "2026-11-22T09:08:22.8966916+00:00",
      "date_update": "2026-11-22T09:08:22.8966916+00:00",
      "updated_by_user_id": "8bdb66d4-ea78-476d-87d7-8e05c7c71867",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-11-22T09:08:22.8966916+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-22T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-11-22T09:08:22.8966916+00:00",
      "date_last_job": "2026-11-22T09:08:22.8966916+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-11-22T09:08:22.8966916+00:00",
      "modified_dateutc": "2026-11-22T09:08:22.8966916+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "1aa6ebf8-89c8-47cb-a9b5-1b1b6ea83713",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "978e2834-ecff-419b-bdfb-74b7a44e2900",
      "name": "sample string 2",
      "sales_organization_id": "68b53763-597b-49d2-8954-9f6b3cecb311",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-11-22T09:08:22.8966916+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "c7b94cac-7884-4a5d-afdf-0ffb8d1e62ae",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "88cee333-2f20-4377-898f-be09f82f4e18",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "9f87c7e4-fd4f-42c5-b108-7dac1adc247d",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "3df5c442-be2e-4baa-9c2b-bbe772fcbbd1",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "4a1dc252-a727-4631-88bc-d71d14d80240",
        "db_currency_id": "c09a0f8a-869c-4e00-9d93-979308fd1afe",
        "db_language_id": "a61c11d4-bd10-4d9e-93bf-3816dbb9913d",
        "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-22T09:08:22.8966916+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-11-22T09:08:22.8966916+00:00"
    },
    "job_status_id": "2f63003b-89df-4c25-871a-9362ec38a8b4",
    "job_status_code": "sample string 11",
    "db_address_id": "707c3c26-ee00-4fd9-85d6-c29a91515022",
    "contact_id": "ed27118e-c689-4146-a9a6-7d09889d3248",
    "requested_by_company_id": "569028c2-b9fb-47d2-9951-dd72188669af",
    "requested_by_contact_id": "a2020b70-1180-4b01-8c4b-e37d51c1931f",
    "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-22T09:08:22.8966916+00:00",
    "due_date": "2026-11-22T09:08:22.8966916+00:00",
    "date_create": "2026-11-22T09:08:22.8966916+00:00",
    "date_update": "2026-11-22T09:08:22.8966916+00:00",
    "date_closed": "2026-11-22T09:08:22.8966916+00:00",
    "suggested_user_id": "c0310eef-8f4a-4465-909d-f4d6b808b78f",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "d82da5f0-7725-44c7-8e49-42c2a6242215",
      "db_language_id": "20fc4eee-2a3b-47ad-a4a9-d76484e0fcda",
      "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-22T09:08:22.8966916+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "7a8ba7d0-6908-452c-81ad-19fc9cbda66e",
      "sales_organization": {
        "id": "3df5c442-be2e-4baa-9c2b-bbe772fcbbd1",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "4a1dc252-a727-4631-88bc-d71d14d80240",
        "db_currency_id": "c09a0f8a-869c-4e00-9d93-979308fd1afe",
        "db_language_id": "a61c11d4-bd10-4d9e-93bf-3816dbb9913d",
        "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-22T09:08:22.8966916+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "a257684e-fc76-4985-9b91-a207bd4a1548",
      "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": "deba2f91-11dc-4764-b6c1-73c645e9547c",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-11-22T09:08:22.8966916+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "b0998d9d-97a2-4ff5-a191-5c08a7766e31"
    },
    "suggested_date_start": "2026-11-22T09:08:22.8966916+00:00",
    "skill_id": "c91effd5-310d-4272-b528-84dbf6d9abe2",
    "skill_code": "sample string 32",
    "skill": {
      "id": "c3d9184a-abb7-4939-a089-ab06665b505e",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "88fc0c29-5fd7-422a-bd5d-490caab6ac73",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "3df5c442-be2e-4baa-9c2b-bbe772fcbbd1",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "4a1dc252-a727-4631-88bc-d71d14d80240",
        "db_currency_id": "c09a0f8a-869c-4e00-9d93-979308fd1afe",
        "db_language_id": "a61c11d4-bd10-4d9e-93bf-3816dbb9913d",
        "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-22T09:08:22.8966916+00:00"
      },
      "modified_dateutc": "2026-11-22T09:08:22.8966916+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "9b5585a9-785e-4437-9151-5b38e46891fe",
    "date_reported_by_company": "2026-11-22T09:08:22.8966916+00:00",
    "id2": 36,
    "company_id": "eeed08a3-53f2-4965-aa9e-e89b294187a8",
    "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": "bdc5f430-61ae-4721-b433-4dccdc9bb9ec",
    "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-22T09:08:22.8966916+00:00"
  },
  "work_instruction_details_id": "0226b38d-0a8a-4400-bcee-6a9276908d29",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "4933cc06-2667-4ff0-b0fe-b32e2ab5748e",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "1faa6c40-ac33-495b-8ca7-2c8aa849a7eb",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-11-22T09:08:22.9093448+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": "fbb5c113-ad81-4d25-a962-a9f2de4dcadd",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-11-22T09:08:22.9093448+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.