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": "7b301f6c-0d38-4dcf-a5b7-492df3b23c6b",
  "jobs_id": "5a9e45e0-1de5-435e-877b-63d33995a25e",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "34d872bf-ca9c-4e18-ae02-61429e0068a2",
    "_parent_id": "824153a5-79aa-4dbd-8bad-9ad445422e6e",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "a5ef6da3-7377-4b05-a24c-889cfd8d9243",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "ae8cbc2e-ba6f-40f4-8c54-d8233817b4f0",
      "_parent_id": "c4a98ba8-1011-40e0-bc7c-8de2452527b1",
      "root_parent_id": "0b347f90-97e4-4ec6-92cb-4545901e0ac1",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "b564642e-29bb-465f-b9ae-f15374a36a25",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "47ea4845-2715-4322-98ef-2a411c988246",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "82e7c5ec-4560-404c-8005-b651324e8196",
        "_parent_code": "sample string 6",
        "sales_organization_id": "c575a22e-9c05-4eef-82f2-65b9bde2010f",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "9d8b0b94-b0d6-441d-baa5-9dc370ebd974",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "21517a96-d47b-4aa5-abdf-7ef32a25794e",
          "db_currency_id": "40a68da2-1a23-4eb5-9c27-bd624765dbe7",
          "db_language_id": "8f58e26d-5de8-42ef-a278-11c58bf5ef24",
          "accountancy_code": "sample string 8",
          "archived": true,
          "default_unit_of_measure_system_type": "sample string 10",
          "street": "sample string 11",
          "street2": "sample string 12",
          "street_number": "sample string 13",
          "zip": "sample string 14",
          "city": "sample string 15",
          "email": "sample string 16",
          "phone": "sample string 17",
          "fax": "sample string 18",
          "url": "sample string 19",
          "vat_reg_code": "sample string 20",
          "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00"
        },
        "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00"
      },
      "equipment_model_id": "f04513b7-99bf-4510-b27b-efb93fe3ea38",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "7b643cbf-1982-4ff6-aa9a-f71f92888c04",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "95fa2aa8-6e45-4109-b617-84edac34c9ef",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "9ac27148-4af1-4a11-b303-18a7716dbc6f",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "17b04c82-1a20-4d9d-8365-3ca093f725e4",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "9d8b0b94-b0d6-441d-baa5-9dc370ebd974",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "21517a96-d47b-4aa5-abdf-7ef32a25794e",
            "db_currency_id": "40a68da2-1a23-4eb5-9c27-bd624765dbe7",
            "db_language_id": "8f58e26d-5de8-42ef-a278-11c58bf5ef24",
            "accountancy_code": "sample string 8",
            "archived": true,
            "default_unit_of_measure_system_type": "sample string 10",
            "street": "sample string 11",
            "street2": "sample string 12",
            "street_number": "sample string 13",
            "zip": "sample string 14",
            "city": "sample string 15",
            "email": "sample string 16",
            "phone": "sample string 17",
            "fax": "sample string 18",
            "url": "sample string 19",
            "vat_reg_code": "sample string 20",
            "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00"
          },
          "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00"
        },
        "equipment_family_id": "56e76b7e-01e1-4ace-9613-00af2027f53d",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "47ea4845-2715-4322-98ef-2a411c988246",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "82e7c5ec-4560-404c-8005-b651324e8196",
          "_parent_code": "sample string 6",
          "sales_organization_id": "c575a22e-9c05-4eef-82f2-65b9bde2010f",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "9d8b0b94-b0d6-441d-baa5-9dc370ebd974",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "21517a96-d47b-4aa5-abdf-7ef32a25794e",
            "db_currency_id": "40a68da2-1a23-4eb5-9c27-bd624765dbe7",
            "db_language_id": "8f58e26d-5de8-42ef-a278-11c58bf5ef24",
            "accountancy_code": "sample string 8",
            "archived": true,
            "default_unit_of_measure_system_type": "sample string 10",
            "street": "sample string 11",
            "street2": "sample string 12",
            "street_number": "sample string 13",
            "zip": "sample string 14",
            "city": "sample string 15",
            "email": "sample string 16",
            "phone": "sample string 17",
            "fax": "sample string 18",
            "url": "sample string 19",
            "vat_reg_code": "sample string 20",
            "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00"
          },
          "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00"
        },
        "date_in_production_since": "2026-09-19T10:59:38.6074087+00:00",
        "date_out_of_production_since": "2026-09-19T10:59:38.6074087+00:00",
        "date_end_support": "2026-09-19T10:59:38.6074087+00:00",
        "sales_organization_id": "8c790fe1-7d53-4b62-9672-639aeec1ed94",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "9d8b0b94-b0d6-441d-baa5-9dc370ebd974",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "21517a96-d47b-4aa5-abdf-7ef32a25794e",
          "db_currency_id": "40a68da2-1a23-4eb5-9c27-bd624765dbe7",
          "db_language_id": "8f58e26d-5de8-42ef-a278-11c58bf5ef24",
          "accountancy_code": "sample string 8",
          "archived": true,
          "default_unit_of_measure_system_type": "sample string 10",
          "street": "sample string 11",
          "street2": "sample string 12",
          "street_number": "sample string 13",
          "zip": "sample string 14",
          "city": "sample string 15",
          "email": "sample string 16",
          "phone": "sample string 17",
          "fax": "sample string 18",
          "url": "sample string 19",
          "vat_reg_code": "sample string 20",
          "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00"
        },
        "replacement_period_nb_months": 14,
        "warranty_period_nb_months": 15,
        "translations": [
          {
            "field_name": "sample string 1",
            "language_code": "sample string 2",
            "value_translated": "sample string 3"
          },
          {
            "field_name": "sample string 1",
            "language_code": "sample string 2",
            "value_translated": "sample string 3"
          }
        ],
        "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00"
      },
      "project_status_id": "e825362b-035b-4dc2-82e0-9334dbc3bdc5",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "a78cf7c4-4fb2-449b-9f7f-549afcc09d5d",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "48477b8b-64c0-4f51-b622-9c7f744a36d9",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "9d8b0b94-b0d6-441d-baa5-9dc370ebd974",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "21517a96-d47b-4aa5-abdf-7ef32a25794e",
          "db_currency_id": "40a68da2-1a23-4eb5-9c27-bd624765dbe7",
          "db_language_id": "8f58e26d-5de8-42ef-a278-11c58bf5ef24",
          "accountancy_code": "sample string 8",
          "archived": true,
          "default_unit_of_measure_system_type": "sample string 10",
          "street": "sample string 11",
          "street2": "sample string 12",
          "street_number": "sample string 13",
          "zip": "sample string 14",
          "city": "sample string 15",
          "email": "sample string 16",
          "phone": "sample string 17",
          "fax": "sample string 18",
          "url": "sample string 19",
          "vat_reg_code": "sample string 20",
          "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00"
      },
      "company_id": "aac2bce8-709d-4298-9bd4-08969b7579ff",
      "company_code": "sample string 12",
      "db_address_id": "bbb2e72f-ad3a-4480-bbaa-b44d91ea7a19",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "a262f90c-7ebf-41d1-b40c-2ccc6473d053",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "734b1060-74b2-4711-b364-5171238345bf",
      "name": "sample string 19",
      "description": "sample string 20",
      "reference_back_office": "sample string 21",
      "serial_number": "sample string 22",
      "barcode": "sample string 23",
      "date_start_production": "2026-09-19T10:59:38.6074087+00:00",
      "date_create": "2026-09-19T10:59:38.6074087+00:00",
      "date_update": "2026-09-19T10:59:38.6074087+00:00",
      "updated_by_user_id": "e2e403b4-95b9-401b-aeaa-4778355487c4",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-09-19T10:59:38.6074087+00:00",
      "last_standard_result_score_1": "sample string 30",
      "last_standard_result_score_2": "sample string 31",
      "target_standard_result_score_1": "sample string 32",
      "target_standard_result_score_2": "sample string 33",
      "date_built": "2026-09-19T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-09-19T10:59:38.6074087+00:00",
      "date_last_job": "2026-09-19T10:59:38.6074087+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-09-19T10:59:38.6074087+00:00",
      "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "0366c722-7bde-4ef6-b0c3-ca848fae6732",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "7492a161-0ee4-417a-a652-a566a2adec79",
      "name": "sample string 2",
      "sales_organization_id": "6fad6f89-650c-422f-8eb6-a6fff49bd42f",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "a1970dd5-718e-446c-b709-01bc74924274",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "6d22d906-5bc7-411e-b843-29b785712747",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "c14c2558-2eb8-44db-9804-ea2dfacf8e87",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "9d8b0b94-b0d6-441d-baa5-9dc370ebd974",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "21517a96-d47b-4aa5-abdf-7ef32a25794e",
        "db_currency_id": "40a68da2-1a23-4eb5-9c27-bd624765dbe7",
        "db_language_id": "8f58e26d-5de8-42ef-a278-11c58bf5ef24",
        "accountancy_code": "sample string 8",
        "archived": true,
        "default_unit_of_measure_system_type": "sample string 10",
        "street": "sample string 11",
        "street2": "sample string 12",
        "street_number": "sample string 13",
        "zip": "sample string 14",
        "city": "sample string 15",
        "email": "sample string 16",
        "phone": "sample string 17",
        "fax": "sample string 18",
        "url": "sample string 19",
        "vat_reg_code": "sample string 20",
        "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00"
    },
    "job_status_id": "19073f12-5805-4b03-9a0b-19cfc06e03f6",
    "job_status_code": "sample string 11",
    "db_address_id": "1ba70056-47e2-40a7-adea-7f185c247847",
    "contact_id": "4447d393-6667-4c7b-80e0-544833fa7697",
    "requested_by_company_id": "af5186ae-6701-46ce-bb14-cefc92d53bd3",
    "requested_by_contact_id": "b7a17dd6-c2d1-4e97-992e-7c9432aa080c",
    "reference_back_office": "sample string 16",
    "name": "sample string 17",
    "description": "sample string 18",
    "working_sequence": 19,
    "internal_memo": "sample string 20",
    "prejob_information": "sample string 21",
    "estimated_time": 22,
    "earliest_date_plannable": "2026-09-19T10:59:38.6074087+00:00",
    "due_date": "2026-09-19T10:59:38.6074087+00:00",
    "date_create": "2026-09-19T10:59:38.6074087+00:00",
    "date_update": "2026-09-19T10:59:38.6074087+00:00",
    "date_closed": "2026-09-19T10:59:38.6074087+00:00",
    "suggested_user_id": "31d9a94c-fb5f-4d02-a8b6-cd42d03335e6",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "2cdcd25b-0e38-45a3-b19f-6b4a0d48e888",
      "db_language_id": "2253b3b2-fa2a-4d0d-bb8e-4d3564e53afc",
      "username": "sample string 3",
      "firstname": "sample string 4",
      "lastname": "sample string 5",
      "code": "sample string 6",
      "archived": true,
      "disabled": true,
      "emergency_contact": "sample string 9",
      "bankaccount": "sample string 10",
      "social_security": "sample string 11",
      "place_of_birth": "sample string 12",
      "nationality": "sample string 13",
      "functions": "sample string 14",
      "birthdate": "2026-09-19T10:59:38.6074087+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "299181a7-49d7-49c9-9b00-59401fbcc8f5",
      "sales_organization": {
        "id": "9d8b0b94-b0d6-441d-baa5-9dc370ebd974",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "21517a96-d47b-4aa5-abdf-7ef32a25794e",
        "db_currency_id": "40a68da2-1a23-4eb5-9c27-bd624765dbe7",
        "db_language_id": "8f58e26d-5de8-42ef-a278-11c58bf5ef24",
        "accountancy_code": "sample string 8",
        "archived": true,
        "default_unit_of_measure_system_type": "sample string 10",
        "street": "sample string 11",
        "street2": "sample string 12",
        "street_number": "sample string 13",
        "zip": "sample string 14",
        "city": "sample string 15",
        "email": "sample string 16",
        "phone": "sample string 17",
        "fax": "sample string 18",
        "url": "sample string 19",
        "vat_reg_code": "sample string 20",
        "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "3e15937e-8413-4140-a067-592f26cc1dd8",
      "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": "869050ee-ffde-4d93-a254-ff54e73ce729",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "fb38ac91-5f5d-439c-9999-b5aee368989d"
    },
    "suggested_date_start": "2026-09-19T10:59:38.6074087+00:00",
    "skill_id": "8da24278-0b32-43eb-9f34-44da66458df8",
    "skill_code": "sample string 32",
    "skill": {
      "id": "1f768f7c-849d-4383-8dbf-62c785b19aac",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "d14b2439-4876-4f40-b77f-46b443530256",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "9d8b0b94-b0d6-441d-baa5-9dc370ebd974",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "21517a96-d47b-4aa5-abdf-7ef32a25794e",
        "db_currency_id": "40a68da2-1a23-4eb5-9c27-bd624765dbe7",
        "db_language_id": "8f58e26d-5de8-42ef-a278-11c58bf5ef24",
        "accountancy_code": "sample string 8",
        "archived": true,
        "default_unit_of_measure_system_type": "sample string 10",
        "street": "sample string 11",
        "street2": "sample string 12",
        "street_number": "sample string 13",
        "zip": "sample string 14",
        "city": "sample string 15",
        "email": "sample string 16",
        "phone": "sample string 17",
        "fax": "sample string 18",
        "url": "sample string 19",
        "vat_reg_code": "sample string 20",
        "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00"
      },
      "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "4efed6a0-bc4a-4639-bacd-9409f2c56546",
    "date_reported_by_company": "2026-09-19T10:59:38.6074087+00:00",
    "id2": 36,
    "company_id": "963e28f7-c7a5-47ae-8d16-7967b89a8a5b",
    "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": "152caec2-5179-41f3-ba5c-724f18f93d7b",
    "db_address_db_country_code": "sample string 46",
    "db_address_phone": "sample string 47",
    "db_address_email": "sample string 48",
    "db_address_latitude_decimal": 49.0,
    "db_address_longitude_decimal": 50.0,
    "estimated_quantity_remark": "sample string 51",
    "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00"
  },
  "work_instruction_details_id": "2841ebd2-98f4-4c97-9b35-e1287f906a4f",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "51efabfe-742a-4b7f-b50a-bac5927b5d1f",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "24411c21-26b1-48da-8185-96b3314d1ea0",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-09-19T10:59:38.6074087+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": "e538f29b-8163-463a-8ac7-3ffbd87009e6",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-09-19T10:59:38.6074087+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.