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": "685335dd-a74c-4111-9e79-6aaa642a1490",
  "jobs_id": "b61f9934-690d-4c98-9104-9b565cfa2cc5",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "23081bb2-2170-44ff-993e-f6483706ca1b",
    "_parent_id": "52d619d3-51c9-4109-8710-72e6ee76c731",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "845431d9-60d9-4a81-981e-84c2c6aa3a09",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "e524b990-0291-40d2-81ab-16541debd7fe",
      "_parent_id": "b8dc66ce-86e7-4341-b81a-a84d21bb8a72",
      "root_parent_id": "93f6ca9d-65e5-486b-92dd-1c0143514f47",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "8af6ae1e-5f33-4b50-aa99-2dc22dcbbdbc",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "74902c74-5322-4981-b369-af0d7a725dc2",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "da3887fe-2f57-4286-b3e3-7fbe66a479e6",
        "_parent_code": "sample string 6",
        "sales_organization_id": "60797c8d-9e9a-4b48-ad94-8dd9b61c7176",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "531f8239-84b5-435c-9dc3-25cea3dcaede",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "800be112-ffe7-4fd6-8b50-274142f81785",
          "db_currency_id": "7fa1bca8-c1ca-4d8a-8cad-21b5c619cd18",
          "db_language_id": "e9bd55e3-0204-42dd-a249-cd79e7fa6206",
          "accountancy_code": "sample string 8",
          "archived": true,
          "default_unit_of_measure_system_type": "sample string 10",
          "street": "sample string 11",
          "street2": "sample string 12",
          "street_number": "sample string 13",
          "zip": "sample string 14",
          "city": "sample string 15",
          "email": "sample string 16",
          "phone": "sample string 17",
          "fax": "sample string 18",
          "url": "sample string 19",
          "vat_reg_code": "sample string 20",
          "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00"
        },
        "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00"
      },
      "equipment_model_id": "f555ce1b-a33e-42ce-b240-61449d3babb8",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "24d0eb95-70eb-4551-a4f7-24f8982b295e",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "138b12fd-279d-4104-b977-591852dae613",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "65f1d83b-be9d-4f31-9e37-cddf1e0efe68",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "28e26fcb-5088-4b9d-815e-f6224605cec6",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "531f8239-84b5-435c-9dc3-25cea3dcaede",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "800be112-ffe7-4fd6-8b50-274142f81785",
            "db_currency_id": "7fa1bca8-c1ca-4d8a-8cad-21b5c619cd18",
            "db_language_id": "e9bd55e3-0204-42dd-a249-cd79e7fa6206",
            "accountancy_code": "sample string 8",
            "archived": true,
            "default_unit_of_measure_system_type": "sample string 10",
            "street": "sample string 11",
            "street2": "sample string 12",
            "street_number": "sample string 13",
            "zip": "sample string 14",
            "city": "sample string 15",
            "email": "sample string 16",
            "phone": "sample string 17",
            "fax": "sample string 18",
            "url": "sample string 19",
            "vat_reg_code": "sample string 20",
            "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00"
          },
          "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00"
        },
        "equipment_family_id": "07323205-b7c4-4309-b19e-eb35fd365be0",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "74902c74-5322-4981-b369-af0d7a725dc2",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "da3887fe-2f57-4286-b3e3-7fbe66a479e6",
          "_parent_code": "sample string 6",
          "sales_organization_id": "60797c8d-9e9a-4b48-ad94-8dd9b61c7176",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "531f8239-84b5-435c-9dc3-25cea3dcaede",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "800be112-ffe7-4fd6-8b50-274142f81785",
            "db_currency_id": "7fa1bca8-c1ca-4d8a-8cad-21b5c619cd18",
            "db_language_id": "e9bd55e3-0204-42dd-a249-cd79e7fa6206",
            "accountancy_code": "sample string 8",
            "archived": true,
            "default_unit_of_measure_system_type": "sample string 10",
            "street": "sample string 11",
            "street2": "sample string 12",
            "street_number": "sample string 13",
            "zip": "sample string 14",
            "city": "sample string 15",
            "email": "sample string 16",
            "phone": "sample string 17",
            "fax": "sample string 18",
            "url": "sample string 19",
            "vat_reg_code": "sample string 20",
            "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00"
          },
          "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00"
        },
        "date_in_production_since": "2025-10-23T00:01:58.3120037+00:00",
        "date_out_of_production_since": "2025-10-23T00:01:58.3120037+00:00",
        "date_end_support": "2025-10-23T00:01:58.3120037+00:00",
        "sales_organization_id": "2f8d3451-e4d3-409f-a94d-05ff8b5a78ab",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "531f8239-84b5-435c-9dc3-25cea3dcaede",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "800be112-ffe7-4fd6-8b50-274142f81785",
          "db_currency_id": "7fa1bca8-c1ca-4d8a-8cad-21b5c619cd18",
          "db_language_id": "e9bd55e3-0204-42dd-a249-cd79e7fa6206",
          "accountancy_code": "sample string 8",
          "archived": true,
          "default_unit_of_measure_system_type": "sample string 10",
          "street": "sample string 11",
          "street2": "sample string 12",
          "street_number": "sample string 13",
          "zip": "sample string 14",
          "city": "sample string 15",
          "email": "sample string 16",
          "phone": "sample string 17",
          "fax": "sample string 18",
          "url": "sample string 19",
          "vat_reg_code": "sample string 20",
          "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00"
        },
        "replacement_period_nb_months": 14,
        "warranty_period_nb_months": 15,
        "translations": [
          {
            "field_name": "sample string 1",
            "language_code": "sample string 2",
            "value_translated": "sample string 3"
          },
          {
            "field_name": "sample string 1",
            "language_code": "sample string 2",
            "value_translated": "sample string 3"
          }
        ],
        "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00"
      },
      "project_status_id": "9ea1fa38-d7b0-4873-93f0-ab89fb996702",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "428bb1a9-f81d-4c38-8577-b6c1394ff21d",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "23fbe40b-2ea3-4dac-bbfa-9414c94cd7c8",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "531f8239-84b5-435c-9dc3-25cea3dcaede",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "800be112-ffe7-4fd6-8b50-274142f81785",
          "db_currency_id": "7fa1bca8-c1ca-4d8a-8cad-21b5c619cd18",
          "db_language_id": "e9bd55e3-0204-42dd-a249-cd79e7fa6206",
          "accountancy_code": "sample string 8",
          "archived": true,
          "default_unit_of_measure_system_type": "sample string 10",
          "street": "sample string 11",
          "street2": "sample string 12",
          "street_number": "sample string 13",
          "zip": "sample string 14",
          "city": "sample string 15",
          "email": "sample string 16",
          "phone": "sample string 17",
          "fax": "sample string 18",
          "url": "sample string 19",
          "vat_reg_code": "sample string 20",
          "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00"
      },
      "company_id": "46720ede-0a12-4be4-a815-e267024fcce4",
      "company_code": "sample string 12",
      "db_address_id": "609949c8-7f3a-437b-945f-1f9232b4e74e",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "f0b5a9aa-6b7c-4edc-8fcf-f37fe42aa8af",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "9d2410db-5b9e-43cd-9538-736600f6a8a4",
      "name": "sample string 19",
      "description": "sample string 20",
      "reference_back_office": "sample string 21",
      "serial_number": "sample string 22",
      "barcode": "sample string 23",
      "date_start_production": "2025-10-23T00:01:58.3120037+00:00",
      "date_create": "2025-10-23T00:01:58.3120037+00:00",
      "date_update": "2025-10-23T00:01:58.3120037+00:00",
      "updated_by_user_id": "173aabd6-5a21-4de6-a741-e9fff9b3b4c6",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2025-10-23T00:01:58.3120037+00:00",
      "last_standard_result_score_1": "sample string 30",
      "last_standard_result_score_2": "sample string 31",
      "target_standard_result_score_1": "sample string 32",
      "target_standard_result_score_2": "sample string 33",
      "date_built": "2025-10-23T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2025-10-23T00:01:58.3120037+00:00",
      "date_last_job": "2025-10-23T00:01:58.3120037+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2025-10-23T00:01:58.3120037+00:00",
      "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "6f0826e6-a48c-4a07-9774-bf3ae68ef6a4",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "5e1b9df3-1fbe-4191-a26a-a922b933e6d2",
      "name": "sample string 2",
      "sales_organization_id": "db10cb54-bb86-495b-989c-eef088ac70b6",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "f9fbfc16-8203-4cec-8c21-f619664c3bdf",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "876dd7df-02d3-4bc6-81fe-6bc95addd365",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "38d42daf-0380-44be-956a-8a52f45ec53c",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "531f8239-84b5-435c-9dc3-25cea3dcaede",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "800be112-ffe7-4fd6-8b50-274142f81785",
        "db_currency_id": "7fa1bca8-c1ca-4d8a-8cad-21b5c619cd18",
        "db_language_id": "e9bd55e3-0204-42dd-a249-cd79e7fa6206",
        "accountancy_code": "sample string 8",
        "archived": true,
        "default_unit_of_measure_system_type": "sample string 10",
        "street": "sample string 11",
        "street2": "sample string 12",
        "street_number": "sample string 13",
        "zip": "sample string 14",
        "city": "sample string 15",
        "email": "sample string 16",
        "phone": "sample string 17",
        "fax": "sample string 18",
        "url": "sample string 19",
        "vat_reg_code": "sample string 20",
        "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00"
    },
    "job_status_id": "3ce9d71f-bc01-4202-ad88-5cbe623ef5ab",
    "job_status_code": "sample string 11",
    "db_address_id": "136edce1-db41-4815-820c-16c7daef62bf",
    "contact_id": "7bd4814a-0315-4aa9-8fd4-93c54a47f993",
    "requested_by_company_id": "ad6e252a-57fb-45a3-aa07-b2ced4254e4c",
    "requested_by_contact_id": "6d8edf43-8c2f-47fd-9d5f-b4bb8d92fb3f",
    "reference_back_office": "sample string 16",
    "name": "sample string 17",
    "description": "sample string 18",
    "working_sequence": 19,
    "internal_memo": "sample string 20",
    "prejob_information": "sample string 21",
    "estimated_time": 22,
    "earliest_date_plannable": "2025-10-23T00:01:58.3120037+00:00",
    "due_date": "2025-10-23T00:01:58.3120037+00:00",
    "date_create": "2025-10-23T00:01:58.3120037+00:00",
    "date_update": "2025-10-23T00:01:58.3120037+00:00",
    "date_closed": "2025-10-23T00:01:58.3120037+00:00",
    "suggested_user_id": "1e8b7e2a-562f-4b9e-b3c3-73dcf3fecbd1",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "f0db8998-376a-4421-97bb-7fdf8b9df57b",
      "db_language_id": "faaea45e-0e5d-4253-830e-764e29bee2ad",
      "username": "sample string 3",
      "firstname": "sample string 4",
      "lastname": "sample string 5",
      "code": "sample string 6",
      "archived": true,
      "disabled": true,
      "emergency_contact": "sample string 9",
      "bankaccount": "sample string 10",
      "social_security": "sample string 11",
      "place_of_birth": "sample string 12",
      "nationality": "sample string 13",
      "functions": "sample string 14",
      "birthdate": "2025-10-23T00:01:58.3120037+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "197b14cc-a904-44d5-a1c2-25a168f03de0",
      "sales_organization": {
        "id": "531f8239-84b5-435c-9dc3-25cea3dcaede",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "800be112-ffe7-4fd6-8b50-274142f81785",
        "db_currency_id": "7fa1bca8-c1ca-4d8a-8cad-21b5c619cd18",
        "db_language_id": "e9bd55e3-0204-42dd-a249-cd79e7fa6206",
        "accountancy_code": "sample string 8",
        "archived": true,
        "default_unit_of_measure_system_type": "sample string 10",
        "street": "sample string 11",
        "street2": "sample string 12",
        "street_number": "sample string 13",
        "zip": "sample string 14",
        "city": "sample string 15",
        "email": "sample string 16",
        "phone": "sample string 17",
        "fax": "sample string 18",
        "url": "sample string 19",
        "vat_reg_code": "sample string 20",
        "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "9f24de9e-4091-4ee6-a509-3df8c44ac175",
      "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": "2203e96f-3e6d-487a-b628-7dd9daafed21",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "05813926-c6c7-4ab2-b087-764b18554c49"
    },
    "suggested_date_start": "2025-10-23T00:01:58.3120037+00:00",
    "skill_id": "eeb1d9c2-0e14-4dae-9ace-3bc31252494b",
    "skill_code": "sample string 32",
    "skill": {
      "id": "f22f98f9-2080-4acc-959b-4df40d9e069d",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "fb09b2c7-efed-4baf-a623-4ed167d588e3",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "531f8239-84b5-435c-9dc3-25cea3dcaede",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "800be112-ffe7-4fd6-8b50-274142f81785",
        "db_currency_id": "7fa1bca8-c1ca-4d8a-8cad-21b5c619cd18",
        "db_language_id": "e9bd55e3-0204-42dd-a249-cd79e7fa6206",
        "accountancy_code": "sample string 8",
        "archived": true,
        "default_unit_of_measure_system_type": "sample string 10",
        "street": "sample string 11",
        "street2": "sample string 12",
        "street_number": "sample string 13",
        "zip": "sample string 14",
        "city": "sample string 15",
        "email": "sample string 16",
        "phone": "sample string 17",
        "fax": "sample string 18",
        "url": "sample string 19",
        "vat_reg_code": "sample string 20",
        "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00"
      },
      "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "b2026f1a-8a81-4372-813d-d9a95b21d2a3",
    "date_reported_by_company": "2025-10-23T00:01:58.3120037+00:00",
    "id2": 36,
    "company_id": "7e0ad06f-dc83-45d2-827b-faf9ac16505a",
    "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": "9746f91f-82fb-44d1-bff8-1488992c1e1e",
    "db_address_db_country_code": "sample string 46",
    "db_address_phone": "sample string 47",
    "db_address_email": "sample string 48",
    "db_address_latitude_decimal": 49.0,
    "db_address_longitude_decimal": 50.0,
    "estimated_quantity_remark": "sample string 51",
    "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00"
  },
  "work_instruction_details_id": "64f719c4-5889-41f5-a95f-116b92000cd9",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "a87367cb-6a40-4d79-85dc-42f52614cc0b",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "8b6b4892-1a75-44a4-b1fb-4c2d2adfe716",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2025-10-23T00:01:58.3120037+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": "cb4e3c2d-e242-4d79-be59-0c52b54f637f",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2025-10-23T00:01:58.3120037+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.