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": "de10a96a-546c-4f97-9b77-7481a688d98b",
  "jobs_id": "be717554-4d1f-4aff-a33c-d40318f74078",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "af696142-9eda-4f9b-b5aa-d0781b0ca8c1",
    "_parent_id": "23bdbace-b099-40cc-bbc2-4729d8300741",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "f6beb1a8-505e-4868-9fbd-df81df9030b9",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "9defa3d4-6a52-4ced-ac03-8d65da14a6cf",
      "_parent_id": "894f9c95-e0cc-43c6-bb1b-795b73a358b5",
      "root_parent_id": "a78ed225-49b8-4187-969b-1e7151f2f474",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "44a390a2-e549-43ec-923e-55ce3dfe7f3f",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "6c3517d5-c02b-4f56-af32-6a77e8abedb2",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "47383747-0df7-402f-b676-c0db0f6d09eb",
        "_parent_code": "sample string 6",
        "sales_organization_id": "906b35b2-4dbc-4636-bb63-1ae76fd43ca5",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "2613ba0d-1268-46f8-946f-26b483d26ee1",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "65b833f4-ad3e-4e70-a1c0-995403c458dd",
          "db_currency_id": "9dfa029f-f3b0-4656-a898-b7dbb5b82cfe",
          "db_language_id": "6997c8b1-ccbe-4c25-b0e5-891be079ebee",
          "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-11-12T07:16:51.7244071+00:00"
        },
        "modified_dateutc": "2025-11-12T07:16:51.7400321+00:00"
      },
      "equipment_model_id": "cf08863b-86bb-40ed-a5e0-43553a580fd3",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "dfe14e46-4e43-46a5-bb8e-10dc8791aff2",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "9b14369d-af71-4985-8a67-8b7e6a9b78da",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "4fb55071-44fc-449e-aedb-564fbaade42e",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "31b9ae75-6bae-49e6-a0a8-3faeaf6934b1",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "2613ba0d-1268-46f8-946f-26b483d26ee1",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "65b833f4-ad3e-4e70-a1c0-995403c458dd",
            "db_currency_id": "9dfa029f-f3b0-4656-a898-b7dbb5b82cfe",
            "db_language_id": "6997c8b1-ccbe-4c25-b0e5-891be079ebee",
            "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-11-12T07:16:51.7244071+00:00"
          },
          "modified_dateutc": "2025-11-12T07:16:51.7400321+00:00"
        },
        "equipment_family_id": "99b989c4-897f-45ef-9236-cf3a02bcb2d2",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "6c3517d5-c02b-4f56-af32-6a77e8abedb2",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "47383747-0df7-402f-b676-c0db0f6d09eb",
          "_parent_code": "sample string 6",
          "sales_organization_id": "906b35b2-4dbc-4636-bb63-1ae76fd43ca5",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "2613ba0d-1268-46f8-946f-26b483d26ee1",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "65b833f4-ad3e-4e70-a1c0-995403c458dd",
            "db_currency_id": "9dfa029f-f3b0-4656-a898-b7dbb5b82cfe",
            "db_language_id": "6997c8b1-ccbe-4c25-b0e5-891be079ebee",
            "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-11-12T07:16:51.7244071+00:00"
          },
          "modified_dateutc": "2025-11-12T07:16:51.7400321+00:00"
        },
        "date_in_production_since": "2025-11-12T07:16:51.7400321+00:00",
        "date_out_of_production_since": "2025-11-12T07:16:51.7400321+00:00",
        "date_end_support": "2025-11-12T07:16:51.7400321+00:00",
        "sales_organization_id": "1f813307-4b39-40e2-bde5-896ed1184ed1",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "2613ba0d-1268-46f8-946f-26b483d26ee1",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "65b833f4-ad3e-4e70-a1c0-995403c458dd",
          "db_currency_id": "9dfa029f-f3b0-4656-a898-b7dbb5b82cfe",
          "db_language_id": "6997c8b1-ccbe-4c25-b0e5-891be079ebee",
          "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-11-12T07:16:51.7244071+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-11-12T07:16:51.7400321+00:00"
      },
      "project_status_id": "ac9bc244-2063-4e55-ba92-e2d24fe4a70c",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "3ad3a0fc-fea6-434c-ab38-50de7dd11188",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "1e05ec0a-df66-4559-993a-49e580cdac04",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "2613ba0d-1268-46f8-946f-26b483d26ee1",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "65b833f4-ad3e-4e70-a1c0-995403c458dd",
          "db_currency_id": "9dfa029f-f3b0-4656-a898-b7dbb5b82cfe",
          "db_language_id": "6997c8b1-ccbe-4c25-b0e5-891be079ebee",
          "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-11-12T07:16:51.7244071+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2025-11-12T07:16:51.7400321+00:00"
      },
      "company_id": "cfae874e-aa21-4474-8d8c-0eb35d5c75e9",
      "company_code": "sample string 12",
      "db_address_id": "f9758224-512b-46e4-afe7-17594a3e5e48",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "4d541987-ec0a-42fc-baf7-3f2720ecceb7",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "52c01a14-6bf3-4f1c-bbbf-23c7f3b2f2c0",
      "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-11-12T07:16:51.7400321+00:00",
      "date_create": "2025-11-12T07:16:51.7400321+00:00",
      "date_update": "2025-11-12T07:16:51.7400321+00:00",
      "updated_by_user_id": "bfd74daf-aa31-475c-957c-b666c53ffacc",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2025-11-12T07:16:51.7400321+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-11-12T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2025-11-12T07:16:51.7400321+00:00",
      "date_last_job": "2025-11-12T07:16:51.7400321+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2025-11-12T07:16:51.7400321+00:00",
      "modified_dateutc": "2025-11-12T07:16:51.7400321+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "837e8f97-9e07-49c2-b4d3-9d93641be695",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "dd752e74-5b99-413c-ba07-36226952d00c",
      "name": "sample string 2",
      "sales_organization_id": "ca207892-6292-4d67-b134-b05be042507b",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2025-11-12T07:16:51.7400321+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "3591ef02-5089-4659-856e-20959491ff35",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "45a5f1dd-3be0-47f3-b4cf-46d560f9c91d",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "9ed002d0-49ac-4770-b5b0-cc7558ae346c",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "2613ba0d-1268-46f8-946f-26b483d26ee1",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "65b833f4-ad3e-4e70-a1c0-995403c458dd",
        "db_currency_id": "9dfa029f-f3b0-4656-a898-b7dbb5b82cfe",
        "db_language_id": "6997c8b1-ccbe-4c25-b0e5-891be079ebee",
        "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-11-12T07:16:51.7244071+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2025-11-12T07:16:51.7400321+00:00"
    },
    "job_status_id": "9c4e954c-50bf-46b5-a249-2a4f064cb77e",
    "job_status_code": "sample string 11",
    "db_address_id": "057f1e4e-e744-4fbd-9753-df0519762d50",
    "contact_id": "66fcb45b-7bf3-45ae-95ab-07e761b0c5c7",
    "requested_by_company_id": "7ef104f8-3172-456b-8655-00bd1ed8d77d",
    "requested_by_contact_id": "27b3d5a5-b0a1-4af1-b6f6-d6e6d55abb0c",
    "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-11-12T07:16:51.7400321+00:00",
    "due_date": "2025-11-12T07:16:51.7400321+00:00",
    "date_create": "2025-11-12T07:16:51.7400321+00:00",
    "date_update": "2025-11-12T07:16:51.7400321+00:00",
    "date_closed": "2025-11-12T07:16:51.7400321+00:00",
    "suggested_user_id": "c7253f04-e178-4717-a9c0-ea6493f7bec8",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "6f470338-2555-4051-93e3-2b93ac779cb7",
      "db_language_id": "75caabf7-e1d2-42a7-ad9d-33bf78d6374e",
      "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-11-12T07:16:51.7400321+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "0b70c646-9259-49ec-8f51-454c214ab370",
      "sales_organization": {
        "id": "2613ba0d-1268-46f8-946f-26b483d26ee1",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "65b833f4-ad3e-4e70-a1c0-995403c458dd",
        "db_currency_id": "9dfa029f-f3b0-4656-a898-b7dbb5b82cfe",
        "db_language_id": "6997c8b1-ccbe-4c25-b0e5-891be079ebee",
        "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-11-12T07:16:51.7244071+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "7690cf3e-d765-4498-9e07-71294243bf0d",
      "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": "9ee1d515-0eb5-4c14-8ab3-53b88aa67b78",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2025-11-12T07:16:51.7400321+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "6e2e611f-b334-446a-8beb-7938e47eb483"
    },
    "suggested_date_start": "2025-11-12T07:16:51.7400321+00:00",
    "skill_id": "bf37a388-fd46-40d1-86bb-d3a634e18f38",
    "skill_code": "sample string 32",
    "skill": {
      "id": "e264ac53-d758-443a-b03a-eae7aabf5153",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "ac45dfb7-0c2b-4a5b-9bab-83a971ca2196",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "2613ba0d-1268-46f8-946f-26b483d26ee1",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "65b833f4-ad3e-4e70-a1c0-995403c458dd",
        "db_currency_id": "9dfa029f-f3b0-4656-a898-b7dbb5b82cfe",
        "db_language_id": "6997c8b1-ccbe-4c25-b0e5-891be079ebee",
        "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-11-12T07:16:51.7244071+00:00"
      },
      "modified_dateutc": "2025-11-12T07:16:51.7400321+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "c3ddd0b7-3294-4c19-9704-3ef50674f20e",
    "date_reported_by_company": "2025-11-12T07:16:51.7400321+00:00",
    "id2": 36,
    "company_id": "ae8a4fbd-f4af-442a-ae25-889c912cb9d0",
    "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": "1a083c97-5783-416c-893d-6c818e2e49bd",
    "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-11-12T07:16:51.7400321+00:00"
  },
  "work_instruction_details_id": "e9348e04-fe8e-4c43-897b-124d55d462ec",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "1fb92fc3-f0f4-45c8-8673-89c71b527289",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "e7421a1c-2a0e-4fac-aec8-fabd261ed556",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2025-11-12T07:16:51.7400321+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": "6edcb179-9d68-4329-9821-d2d3c7a46798",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2025-11-12T07:16:51.7400321+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.