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": "80a3bf70-602b-4e7c-a7a9-52f0f3f56edf",
  "jobs_id": "1419f3a8-2a23-4536-b5fb-63fd1b6682f0",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "19588d05-9b69-4bc9-95d3-145f5a1a8b77",
    "_parent_id": "6a31e061-ddd2-4bab-9293-c83504419f70",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "429018a7-096f-46ff-b4b6-d44446a0a506",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "932dbf98-d412-4638-9380-09c8cd4582ff",
      "_parent_id": "65cafe99-81c1-496f-ad3a-add59b362035",
      "root_parent_id": "dd1873a0-081a-41f6-b796-9ef6260106e3",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "f55c84b3-f246-4727-9be9-b0dfbc99aa82",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "d74f22fe-33e1-4380-901c-ce9e7d128da6",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "fc506411-f234-4aaa-bc35-17a3c99aaa70",
        "_parent_code": "sample string 6",
        "sales_organization_id": "6068855d-f3fe-48f3-95a1-7fd3b10d5ef1",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "4e261338-8e70-4993-99ab-c091c0798907",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "69c6b898-c902-4140-a2fb-4c51dd01ce14",
          "db_currency_id": "737a2d2a-c042-4988-b6a5-5a2e75b14ef3",
          "db_language_id": "acc73f53-f6de-496d-8286-c2f63b74a4ff",
          "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-24T20:16:00.7102552+00:00"
        },
        "modified_dateutc": "2026-04-24T20:16:00.7102552+00:00"
      },
      "equipment_model_id": "dbb7dc28-630e-4b86-bd6e-c4b75ccf6537",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "75e3ec3e-6c4d-4e04-ad69-b1159ed39ac6",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "79040d8b-2db8-41c5-babc-b7f971d61a0c",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "38065400-b437-48f5-8c7a-62ed7567804b",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "be30fb2c-cf2f-414c-b284-b7ec6a1d9503",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "4e261338-8e70-4993-99ab-c091c0798907",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "69c6b898-c902-4140-a2fb-4c51dd01ce14",
            "db_currency_id": "737a2d2a-c042-4988-b6a5-5a2e75b14ef3",
            "db_language_id": "acc73f53-f6de-496d-8286-c2f63b74a4ff",
            "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-24T20:16:00.7102552+00:00"
          },
          "modified_dateutc": "2026-04-24T20:16:00.7102552+00:00"
        },
        "equipment_family_id": "b7b15704-8c15-4284-a807-ea72b2cecd25",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "d74f22fe-33e1-4380-901c-ce9e7d128da6",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "fc506411-f234-4aaa-bc35-17a3c99aaa70",
          "_parent_code": "sample string 6",
          "sales_organization_id": "6068855d-f3fe-48f3-95a1-7fd3b10d5ef1",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "4e261338-8e70-4993-99ab-c091c0798907",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "69c6b898-c902-4140-a2fb-4c51dd01ce14",
            "db_currency_id": "737a2d2a-c042-4988-b6a5-5a2e75b14ef3",
            "db_language_id": "acc73f53-f6de-496d-8286-c2f63b74a4ff",
            "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-24T20:16:00.7102552+00:00"
          },
          "modified_dateutc": "2026-04-24T20:16:00.7102552+00:00"
        },
        "date_in_production_since": "2026-04-24T20:16:00.7102552+00:00",
        "date_out_of_production_since": "2026-04-24T20:16:00.7102552+00:00",
        "date_end_support": "2026-04-24T20:16:00.7102552+00:00",
        "sales_organization_id": "8b6dad02-101d-46b1-9235-8b12d96485e0",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "4e261338-8e70-4993-99ab-c091c0798907",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "69c6b898-c902-4140-a2fb-4c51dd01ce14",
          "db_currency_id": "737a2d2a-c042-4988-b6a5-5a2e75b14ef3",
          "db_language_id": "acc73f53-f6de-496d-8286-c2f63b74a4ff",
          "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-24T20:16:00.7102552+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-24T20:16:00.7102552+00:00"
      },
      "project_status_id": "f6266c0a-8a99-4742-8b32-55e34c53daad",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "2a3d646d-19d3-4f51-80d9-c40479bdf111",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "18fbb9f4-dca9-47eb-a4c2-708a74467387",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "4e261338-8e70-4993-99ab-c091c0798907",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "69c6b898-c902-4140-a2fb-4c51dd01ce14",
          "db_currency_id": "737a2d2a-c042-4988-b6a5-5a2e75b14ef3",
          "db_language_id": "acc73f53-f6de-496d-8286-c2f63b74a4ff",
          "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-24T20:16:00.7102552+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-04-24T20:16:00.7102552+00:00"
      },
      "company_id": "604ef189-1936-45ff-8056-f4515732d2ff",
      "company_code": "sample string 12",
      "db_address_id": "1212cfc1-6cc4-4304-8137-ea7dc3dcdc30",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "bb9457a0-d019-4e9b-abb5-d0311098dc12",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "a5ca847f-48f9-4529-9df8-41b66353dbf0",
      "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-24T20:16:00.7102552+00:00",
      "date_create": "2026-04-24T20:16:00.7102552+00:00",
      "date_update": "2026-04-24T20:16:00.7102552+00:00",
      "updated_by_user_id": "178b6f56-feca-486f-92aa-aebf95ab7777",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-04-24T20:16:00.7102552+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-24T20:16:00.7102552+00:00",
      "date_last_job": "2026-04-24T20:16:00.7102552+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-04-24T20:16:00.7102552+00:00",
      "modified_dateutc": "2026-04-24T20:16:00.7102552+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "e3a68193-6e77-4475-915c-1e0906250d61",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "2f32bde1-715b-4d17-b3f5-dc30ca93a8c1",
      "name": "sample string 2",
      "sales_organization_id": "71ff55f1-d536-4121-8891-6e77accd3d31",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-04-24T20:16:00.7102552+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "255736f9-138d-4798-ab93-46de64fc8af0",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "8e6860d5-d2f1-4f9c-a692-ffbbc837de7b",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "1d5a8c54-e4e5-4b84-893e-62e74df7b3ea",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "4e261338-8e70-4993-99ab-c091c0798907",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "69c6b898-c902-4140-a2fb-4c51dd01ce14",
        "db_currency_id": "737a2d2a-c042-4988-b6a5-5a2e75b14ef3",
        "db_language_id": "acc73f53-f6de-496d-8286-c2f63b74a4ff",
        "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-24T20:16:00.7102552+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-04-24T20:16:00.7102552+00:00"
    },
    "job_status_id": "35e2b27f-9cd5-4579-bd96-f05efd0214df",
    "job_status_code": "sample string 11",
    "db_address_id": "9e081419-3801-4a35-943e-c8b934093aba",
    "contact_id": "32fe9d21-184c-4b04-a24a-633077c71510",
    "requested_by_company_id": "62c66234-4359-4844-b75d-b159e87ca9b0",
    "requested_by_contact_id": "fd441ae7-8a9e-4e7e-acc4-461b3a99824f",
    "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-24T20:16:00.7102552+00:00",
    "due_date": "2026-04-24T20:16:00.7102552+00:00",
    "date_create": "2026-04-24T20:16:00.7102552+00:00",
    "date_update": "2026-04-24T20:16:00.7102552+00:00",
    "date_closed": "2026-04-24T20:16:00.7102552+00:00",
    "suggested_user_id": "2c9aaa77-143d-467b-b8c9-7e405e9dfcc3",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "ee13e09d-c525-4938-a4e2-9e52e466f3d5",
      "db_language_id": "d85d9428-c4a6-400e-a04c-1fddb346b7db",
      "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-24T20:16:00.7102552+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "8f3429d4-22d8-4484-8b07-ee29655b2dc3",
      "sales_organization": {
        "id": "4e261338-8e70-4993-99ab-c091c0798907",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "69c6b898-c902-4140-a2fb-4c51dd01ce14",
        "db_currency_id": "737a2d2a-c042-4988-b6a5-5a2e75b14ef3",
        "db_language_id": "acc73f53-f6de-496d-8286-c2f63b74a4ff",
        "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-24T20:16:00.7102552+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "7a59dcb2-58a8-4df7-b359-2d9b9b024aec",
      "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": "8da64b5f-a843-454b-99cb-ed2d8f683398",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-04-24T20:16:00.7102552+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "136d7c3c-56a1-4e38-9072-f923115bd119"
    },
    "suggested_date_start": "2026-04-24T20:16:00.7102552+00:00",
    "skill_id": "cf6ad62a-db88-4453-baa5-9dc3c2c208c7",
    "skill_code": "sample string 32",
    "skill": {
      "id": "8aa4fdc0-e248-4842-b688-3a9d838b6d45",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "922f4380-1cec-447d-bbbc-e2d59385a2e4",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "4e261338-8e70-4993-99ab-c091c0798907",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "69c6b898-c902-4140-a2fb-4c51dd01ce14",
        "db_currency_id": "737a2d2a-c042-4988-b6a5-5a2e75b14ef3",
        "db_language_id": "acc73f53-f6de-496d-8286-c2f63b74a4ff",
        "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-24T20:16:00.7102552+00:00"
      },
      "modified_dateutc": "2026-04-24T20:16:00.7102552+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "85b4b86a-3a2c-457a-9f0b-4f1d5710a52f",
    "date_reported_by_company": "2026-04-24T20:16:00.7102552+00:00",
    "id2": 36,
    "company_id": "379c5870-d467-4da1-b74e-c96ef5f5a031",
    "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": "4bf2f9a8-f48a-41f2-bd93-58ee0d5ebc33",
    "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-24T20:16:00.7102552+00:00"
  },
  "work_instruction_details_id": "6680ef5d-3803-4220-be79-9ece76c991ab",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "3bc60bea-b84e-4373-84a6-9b48a4d40840",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "71c64914-228a-4f56-8b72-5c75888b35dc",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-04-24T20:16:00.7258807+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": "755ccf0a-3301-452b-b81a-d2e315f52ac2",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-04-24T20:16:00.7258807+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.