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": "e16e517a-ec43-4e62-b71e-2c50984f2869",
"jobs_id": "082a69c2-c5f2-45cc-b90c-b96349650c7e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ccc972af-2d3b-4c13-ac5d-aad4f8400641",
"_parent_id": "5716f071-e39e-454d-b16a-6aec8f17dce5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "86143686-ae3c-4e82-b531-8a3c1aa8f577",
"project_reference_back_office": "sample string 5",
"project": {
"id": "29655f45-9fd6-4d26-8576-4684641a878d",
"_parent_id": "a53b4378-04eb-4f4f-949a-6d0c514ea7f6",
"root_parent_id": "986af38a-4e1c-42e0-acd9-0a663844c607",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8bd9a592-35f7-4a8d-aa9d-0cbb37435fb4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0b9ac931-9862-41f6-ac2b-6168cb1c8ee9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "05881dbd-f00b-41f4-b16b-8119889ebcc3",
"_parent_code": "sample string 6",
"sales_organization_id": "bc7b3417-e044-4d84-ad28-f5d535aeae3f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6ded0e78-d475-4732-b9f5-5395c35d8994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec1f5b1e-5c63-43dd-aa21-4eff9908e406",
"db_currency_id": "e527ead7-bcc0-4dcc-8834-22246809cc1f",
"db_language_id": "123474a5-eedf-4112-a211-9906f021b533",
"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-09T12:18:02.5303347+00:00"
},
"modified_dateutc": "2025-11-09T12:18:02.5303347+00:00"
},
"equipment_model_id": "82ff2413-eacb-4553-8ebb-1e54b9474135",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "497773f6-3316-4769-b6ed-09d7ea6a048c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f71ba3fe-1c2a-45dd-a5dd-5c17de818359",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b2468300-4286-4ebc-8fd0-2c29657771f2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b7cfbc8c-7ee5-4470-bc33-308587deb026",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6ded0e78-d475-4732-b9f5-5395c35d8994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec1f5b1e-5c63-43dd-aa21-4eff9908e406",
"db_currency_id": "e527ead7-bcc0-4dcc-8834-22246809cc1f",
"db_language_id": "123474a5-eedf-4112-a211-9906f021b533",
"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-09T12:18:02.5303347+00:00"
},
"modified_dateutc": "2025-11-09T12:18:02.5303347+00:00"
},
"equipment_family_id": "732a04f9-77c5-4dea-9ba7-b95ce7b579de",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0b9ac931-9862-41f6-ac2b-6168cb1c8ee9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "05881dbd-f00b-41f4-b16b-8119889ebcc3",
"_parent_code": "sample string 6",
"sales_organization_id": "bc7b3417-e044-4d84-ad28-f5d535aeae3f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6ded0e78-d475-4732-b9f5-5395c35d8994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec1f5b1e-5c63-43dd-aa21-4eff9908e406",
"db_currency_id": "e527ead7-bcc0-4dcc-8834-22246809cc1f",
"db_language_id": "123474a5-eedf-4112-a211-9906f021b533",
"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-09T12:18:02.5303347+00:00"
},
"modified_dateutc": "2025-11-09T12:18:02.5303347+00:00"
},
"date_in_production_since": "2025-11-09T12:18:02.5303347+00:00",
"date_out_of_production_since": "2025-11-09T12:18:02.5303347+00:00",
"date_end_support": "2025-11-09T12:18:02.5303347+00:00",
"sales_organization_id": "943872c0-e386-4c32-b231-ce562e26b2ea",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6ded0e78-d475-4732-b9f5-5395c35d8994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec1f5b1e-5c63-43dd-aa21-4eff9908e406",
"db_currency_id": "e527ead7-bcc0-4dcc-8834-22246809cc1f",
"db_language_id": "123474a5-eedf-4112-a211-9906f021b533",
"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-09T12:18:02.5303347+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-09T12:18:02.5303347+00:00"
},
"project_status_id": "13dcbeb7-30ce-4ee8-8a12-44fe944bf992",
"project_status_code": "sample string 10",
"project_status": {
"id": "fed4bfc4-835f-4540-9580-15b2feeac8a2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e67d56f1-f508-4863-9911-26cf60fded8c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6ded0e78-d475-4732-b9f5-5395c35d8994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec1f5b1e-5c63-43dd-aa21-4eff9908e406",
"db_currency_id": "e527ead7-bcc0-4dcc-8834-22246809cc1f",
"db_language_id": "123474a5-eedf-4112-a211-9906f021b533",
"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-09T12:18:02.5303347+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-09T12:18:02.5303347+00:00"
},
"company_id": "61e00417-d781-47b3-af3f-b3b95c09e767",
"company_code": "sample string 12",
"db_address_id": "1437245a-d757-4519-91c7-2db11c9af3ea",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "13f23a22-6901-49d0-81a1-6d0b6b127da4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c95b1f3e-c2db-4e50-8043-da2bb6c1276e",
"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-09T12:18:02.5303347+00:00",
"date_create": "2025-11-09T12:18:02.5303347+00:00",
"date_update": "2025-11-09T12:18:02.5303347+00:00",
"updated_by_user_id": "9f7d7d55-a914-4fc6-b271-7760843089ef",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-09T12:18:02.5303347+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-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-09T12:18:02.5303347+00:00",
"date_last_job": "2025-11-09T12:18:02.5303347+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-09T12:18:02.5303347+00:00",
"modified_dateutc": "2025-11-09T12:18:02.5303347+00:00",
"is_mobile_installation": true
},
"job_type_id": "51c783da-1a11-4033-ab94-eb43d778e9db",
"job_type_code": "sample string 7",
"job_type": {
"id": "c7fef946-f68e-4ff8-894e-d1e96719b88f",
"name": "sample string 2",
"sales_organization_id": "b9d559e6-8f59-4034-83ef-3bc1df29eb55",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-09T12:18:02.5303347+00:00",
"code": "sample string 7"
},
"job_priority_id": "0f62ffa6-6376-4099-98c7-1f286097644f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "80df4a42-0a55-4889-9365-d434568ad9ff",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ccc86bb0-f700-4a40-b177-f09b77e0f02e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6ded0e78-d475-4732-b9f5-5395c35d8994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec1f5b1e-5c63-43dd-aa21-4eff9908e406",
"db_currency_id": "e527ead7-bcc0-4dcc-8834-22246809cc1f",
"db_language_id": "123474a5-eedf-4112-a211-9906f021b533",
"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-09T12:18:02.5303347+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-09T12:18:02.5303347+00:00"
},
"job_status_id": "2e813c4d-393d-43d3-9260-9d2fa834cc7f",
"job_status_code": "sample string 11",
"db_address_id": "58e14c26-7e56-483c-ab6b-cea7f48c9fd8",
"contact_id": "46fefa79-9f75-47a5-a28a-a8509d360d76",
"requested_by_company_id": "d4d695c8-01c9-44c6-b906-f3b4776c9045",
"requested_by_contact_id": "8166fedb-c80b-48c8-8799-516aeed432aa",
"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-09T12:18:02.5303347+00:00",
"due_date": "2025-11-09T12:18:02.5303347+00:00",
"date_create": "2025-11-09T12:18:02.5303347+00:00",
"date_update": "2025-11-09T12:18:02.5303347+00:00",
"date_closed": "2025-11-09T12:18:02.5303347+00:00",
"suggested_user_id": "058afad0-0bb7-49ee-8b6f-ab9ed5c97339",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3c86cbe9-f511-4396-b363-d8efe82bd2a5",
"db_language_id": "14dfde0a-60e5-47d3-b4b8-c9886da2fa14",
"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-09T12:18:02.5303347+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e37f5ff3-2c68-44f8-ab85-20b42f4053c4",
"sales_organization": {
"id": "6ded0e78-d475-4732-b9f5-5395c35d8994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec1f5b1e-5c63-43dd-aa21-4eff9908e406",
"db_currency_id": "e527ead7-bcc0-4dcc-8834-22246809cc1f",
"db_language_id": "123474a5-eedf-4112-a211-9906f021b533",
"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-09T12:18:02.5303347+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ae8463f9-ae8f-4c92-84da-2ffdb92c9f32",
"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": "d114d89c-13a7-4a81-b6a3-bb68f627ccc0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-09T12:18:02.5303347+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a68d0261-9f44-4fd0-a07e-dad10ccf4aa6"
},
"suggested_date_start": "2025-11-09T12:18:02.5303347+00:00",
"skill_id": "a87dca48-2cc6-4da1-a221-7438c3c345f5",
"skill_code": "sample string 32",
"skill": {
"id": "6a1a3ed3-f584-47f4-87a4-abb9cbfaef3e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8cd7cd4b-7ce3-4301-96fc-67adc773bdef",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6ded0e78-d475-4732-b9f5-5395c35d8994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ec1f5b1e-5c63-43dd-aa21-4eff9908e406",
"db_currency_id": "e527ead7-bcc0-4dcc-8834-22246809cc1f",
"db_language_id": "123474a5-eedf-4112-a211-9906f021b533",
"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-09T12:18:02.5303347+00:00"
},
"modified_dateutc": "2025-11-09T12:18:02.5303347+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "65712894-e93c-47e5-96c0-2166e9eea10a",
"date_reported_by_company": "2025-11-09T12:18:02.5303347+00:00",
"id2": 36,
"company_id": "2469ee57-b724-463c-8a85-473f13ecd99f",
"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": "95ccee66-9cdb-4c9e-a69d-32f6646dc249",
"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-09T12:18:02.5303347+00:00"
},
"work_instruction_details_id": "ccebf77d-9db7-447d-b058-574521b2e064",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2f4723f4-86c7-45ac-a46e-c5fc49906ccb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "affdd399-c0ab-41b0-b992-9e8bb324ab9f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-09T12:18:02.5303347+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": "b204513a-a858-4e3e-ae8a-68dcf430304f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-09T12:18:02.5303347+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.