Updates the job work instruction list with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
job_work_instruction_list| Name | Description | Type | Additional 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": "75ffdeed-0ce8-45ad-8692-79dd962b8f96",
"jobs_id": "e28543ed-3042-4f78-84b8-f53d542277c6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9b51cc73-f2b5-45d9-8cb4-a172cc72b802",
"_parent_id": "2cbe5f3b-4936-427b-88d0-7c36a0a0cdc9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "73908769-5ae7-4c69-8c9c-f458679fb800",
"project_reference_back_office": "sample string 5",
"project": {
"id": "201adbde-74e1-47e4-b50f-273fddc3934d",
"_parent_id": "d6942478-5bf7-4d2d-b258-ec88665943c7",
"root_parent_id": "2e89b8eb-4453-4505-886d-7e583b176d21",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "98a38ede-d889-49bb-b094-5fa38fe80d45",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "abb43d10-a7b3-4d32-8567-96ee103bb6df",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5b79b56d-eafd-4447-a58d-61bfd43c8588",
"_parent_code": "sample string 6",
"sales_organization_id": "fe15671b-5f91-4e8b-a872-bfe75c2edcca",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1571db53-3914-434a-a65c-51601c5bcf8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d614da39-ef80-4f30-b3f5-543ced5b4327",
"db_currency_id": "496aff0c-8354-4db4-908b-e1c86ad88cd7",
"db_language_id": "773dc2b9-48ba-4faf-a65d-717d59cad7bc",
"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-12-21T07:05:12.0343981+00:00"
},
"modified_dateutc": "2025-12-21T07:05:12.0343981+00:00"
},
"equipment_model_id": "3e19e7f2-dec6-43ed-894c-59f2f4325541",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ab4a7234-3161-40c4-8cdc-d06356d5fba8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ce33cf2c-5633-4ba6-b11d-879a66b2d937",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "274ad93e-cd7f-471f-b74e-3b9984068892",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "550ba7ae-1f44-469b-834e-e6b9dc79b91a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1571db53-3914-434a-a65c-51601c5bcf8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d614da39-ef80-4f30-b3f5-543ced5b4327",
"db_currency_id": "496aff0c-8354-4db4-908b-e1c86ad88cd7",
"db_language_id": "773dc2b9-48ba-4faf-a65d-717d59cad7bc",
"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-12-21T07:05:12.0343981+00:00"
},
"modified_dateutc": "2025-12-21T07:05:12.0343981+00:00"
},
"equipment_family_id": "d2933b0a-65fe-410f-bbb6-f00a861e166d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "abb43d10-a7b3-4d32-8567-96ee103bb6df",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5b79b56d-eafd-4447-a58d-61bfd43c8588",
"_parent_code": "sample string 6",
"sales_organization_id": "fe15671b-5f91-4e8b-a872-bfe75c2edcca",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1571db53-3914-434a-a65c-51601c5bcf8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d614da39-ef80-4f30-b3f5-543ced5b4327",
"db_currency_id": "496aff0c-8354-4db4-908b-e1c86ad88cd7",
"db_language_id": "773dc2b9-48ba-4faf-a65d-717d59cad7bc",
"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-12-21T07:05:12.0343981+00:00"
},
"modified_dateutc": "2025-12-21T07:05:12.0343981+00:00"
},
"date_in_production_since": "2025-12-21T07:05:12.0343981+00:00",
"date_out_of_production_since": "2025-12-21T07:05:12.0343981+00:00",
"date_end_support": "2025-12-21T07:05:12.0343981+00:00",
"sales_organization_id": "9d88101d-c702-4df9-a30a-61ca1889b013",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1571db53-3914-434a-a65c-51601c5bcf8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d614da39-ef80-4f30-b3f5-543ced5b4327",
"db_currency_id": "496aff0c-8354-4db4-908b-e1c86ad88cd7",
"db_language_id": "773dc2b9-48ba-4faf-a65d-717d59cad7bc",
"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-12-21T07:05:12.0343981+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-12-21T07:05:12.0343981+00:00"
},
"project_status_id": "09ff81ba-adb9-4940-9794-378478043c65",
"project_status_code": "sample string 10",
"project_status": {
"id": "06fb96ab-005f-42a3-966b-0a2d8c60fe6a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6bc2de05-c2c8-48f2-8479-b0296b9f92c0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1571db53-3914-434a-a65c-51601c5bcf8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d614da39-ef80-4f30-b3f5-543ced5b4327",
"db_currency_id": "496aff0c-8354-4db4-908b-e1c86ad88cd7",
"db_language_id": "773dc2b9-48ba-4faf-a65d-717d59cad7bc",
"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-12-21T07:05:12.0343981+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-21T07:05:12.0343981+00:00"
},
"company_id": "49b1a2e9-727c-424f-af68-c4962046099f",
"company_code": "sample string 12",
"db_address_id": "6cf6b38b-e51f-4a76-9af0-aa0271dbafd1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "faddd826-a0b8-45c9-af71-705ce13825c4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f4f5736e-824d-4005-b4b0-fe9b906b4f38",
"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-12-21T07:05:12.0343981+00:00",
"date_create": "2025-12-21T07:05:12.0343981+00:00",
"date_update": "2025-12-21T07:05:12.0343981+00:00",
"updated_by_user_id": "aa6ebe54-c9af-449d-b7aa-fc26281bab0b",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-21T07:05:12.0343981+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-12-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-21T07:05:12.0343981+00:00",
"date_last_job": "2025-12-21T07:05:12.0343981+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-21T07:05:12.0343981+00:00",
"modified_dateutc": "2025-12-21T07:05:12.0343981+00:00",
"is_mobile_installation": true
},
"job_type_id": "02d05996-edd9-4c63-84bd-35ee148e7b33",
"job_type_code": "sample string 7",
"job_type": {
"id": "a156ed89-c26b-4e6d-a8cb-ece56da450b0",
"name": "sample string 2",
"sales_organization_id": "33a79922-78fe-45f6-a5e2-2b042fa4d711",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-21T07:05:12.0343981+00:00",
"code": "sample string 7"
},
"job_priority_id": "4c071b2a-fa16-4e55-a0df-ff7e72836161",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "251ea20b-bf41-46f9-92da-43a243c9be9e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4816cffb-6905-4bf7-957a-0981200a2c8f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1571db53-3914-434a-a65c-51601c5bcf8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d614da39-ef80-4f30-b3f5-543ced5b4327",
"db_currency_id": "496aff0c-8354-4db4-908b-e1c86ad88cd7",
"db_language_id": "773dc2b9-48ba-4faf-a65d-717d59cad7bc",
"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-12-21T07:05:12.0343981+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-21T07:05:12.0343981+00:00"
},
"job_status_id": "4894375d-4d3c-4bbb-94ac-d4a37fa80583",
"job_status_code": "sample string 11",
"db_address_id": "c35afe10-5ceb-4cd4-9b6e-cfecb1b9a852",
"contact_id": "cfc58ef1-e9eb-4b25-b285-fc870ce08490",
"requested_by_company_id": "52041528-0926-44a9-9716-27ba040155cf",
"requested_by_contact_id": "947ce89c-ba29-4de4-83cf-b06e7aebdb31",
"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-12-21T07:05:12.0343981+00:00",
"due_date": "2025-12-21T07:05:12.0343981+00:00",
"date_create": "2025-12-21T07:05:12.0343981+00:00",
"date_update": "2025-12-21T07:05:12.0343981+00:00",
"date_closed": "2025-12-21T07:05:12.0343981+00:00",
"suggested_user_id": "02708551-ed98-4da7-bcec-28b94424fef2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "74597b35-1fc6-4f95-a041-49091fdc9ac1",
"db_language_id": "6a361769-cca8-4156-88fc-ce064d52f6ac",
"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-12-21T07:05:12.0343981+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "62c53a01-7dd0-4512-bfca-7a51d7c27793",
"sales_organization": {
"id": "1571db53-3914-434a-a65c-51601c5bcf8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d614da39-ef80-4f30-b3f5-543ced5b4327",
"db_currency_id": "496aff0c-8354-4db4-908b-e1c86ad88cd7",
"db_language_id": "773dc2b9-48ba-4faf-a65d-717d59cad7bc",
"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-12-21T07:05:12.0343981+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "289d0fcd-023e-4f9c-81c4-cf054bfb01ac",
"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": "29339b1d-df1e-4280-9be6-ec5d6e6cf756",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-21T07:05:12.0343981+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "40319b82-a211-49dc-a986-154aa228d7b6"
},
"suggested_date_start": "2025-12-21T07:05:12.0343981+00:00",
"skill_id": "8ce3225e-367a-4fc6-ab7a-f1a47a63e521",
"skill_code": "sample string 32",
"skill": {
"id": "bb05125c-1797-44d1-9c10-e7391c260734",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a7f38fc5-23f7-48a2-a536-c1133ade28f8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1571db53-3914-434a-a65c-51601c5bcf8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d614da39-ef80-4f30-b3f5-543ced5b4327",
"db_currency_id": "496aff0c-8354-4db4-908b-e1c86ad88cd7",
"db_language_id": "773dc2b9-48ba-4faf-a65d-717d59cad7bc",
"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-12-21T07:05:12.0343981+00:00"
},
"modified_dateutc": "2025-12-21T07:05:12.0343981+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "94d29547-34e1-41c9-a0b7-360e78cf40b2",
"date_reported_by_company": "2025-12-21T07:05:12.0343981+00:00",
"id2": 36,
"company_id": "6911d339-11b2-45e2-b477-4b64a5adfd78",
"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": "03c888e8-5f66-4f05-9d05-81a2d09a26bd",
"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-12-21T07:05:12.0343981+00:00"
},
"work_instruction_details_id": "84119d94-631c-4888-9802-f71ad161856e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2bc3635f-c0d3-4138-873f-c0d8d649c7a7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "70549fd1-473d-493e-a30f-2acab88b2204",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-21T07:05:12.0343981+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": "c8c246ae-1585-4b78-9f75-08160a589a15",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-21T07:05:12.0343981+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.