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": "40600cc7-40f1-41f4-8772-1fe37f833644",
"jobs_id": "3aa45857-1042-4678-9cc1-6d689acbb7e6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "751f943c-c3f2-4a7b-b9bd-976de792dc4b",
"_parent_id": "a62d1228-1604-4be5-a366-76c3395811ab",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8a0a971c-9cca-44bd-9543-851604c3c0b1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c2266848-f8ec-46f7-aca2-bde811f44fa3",
"_parent_id": "5c05dcd3-809e-4a0f-9fa5-6ac4c7517b0f",
"root_parent_id": "8101efb0-3275-46a1-a660-259b89e98522",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "beb002e1-c712-428d-bbfa-1248ff4061a6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e602feec-2422-429c-b53b-ce019fc1a217",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "467ba135-f3fe-4057-9bba-dc5066be3a9c",
"_parent_code": "sample string 6",
"sales_organization_id": "dc7a0bbf-6f03-489c-bac9-ac444bb51c06",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "60614e32-a6e1-40a9-914e-59ce44db0630",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6c9d4d4-1914-471c-953b-a8d8efb6eece",
"db_currency_id": "9fdfb150-5983-48e3-9e67-e073004304c9",
"db_language_id": "dc4c9271-ebcc-428a-9c48-c0bd6bce2c62",
"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-04-17T07:49:17.9228028+00:00"
},
"modified_dateutc": "2026-04-17T07:49:17.9228028+00:00"
},
"equipment_model_id": "dcab5e28-e0a1-47c2-a4cf-8245bf52e819",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fcf8b8ba-db23-4e9f-82fc-484ffd2c08af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "65d10c06-f9e3-496d-96b8-430f4327c58c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0827c7e2-9601-4e34-92c4-190aa92d1494",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "62c62db7-1374-4537-bb53-764dc46b8732",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "60614e32-a6e1-40a9-914e-59ce44db0630",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6c9d4d4-1914-471c-953b-a8d8efb6eece",
"db_currency_id": "9fdfb150-5983-48e3-9e67-e073004304c9",
"db_language_id": "dc4c9271-ebcc-428a-9c48-c0bd6bce2c62",
"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-04-17T07:49:17.9228028+00:00"
},
"modified_dateutc": "2026-04-17T07:49:17.9384255+00:00"
},
"equipment_family_id": "f2689ebb-50bd-4dae-a933-a4adda45ac19",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e602feec-2422-429c-b53b-ce019fc1a217",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "467ba135-f3fe-4057-9bba-dc5066be3a9c",
"_parent_code": "sample string 6",
"sales_organization_id": "dc7a0bbf-6f03-489c-bac9-ac444bb51c06",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "60614e32-a6e1-40a9-914e-59ce44db0630",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6c9d4d4-1914-471c-953b-a8d8efb6eece",
"db_currency_id": "9fdfb150-5983-48e3-9e67-e073004304c9",
"db_language_id": "dc4c9271-ebcc-428a-9c48-c0bd6bce2c62",
"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-04-17T07:49:17.9228028+00:00"
},
"modified_dateutc": "2026-04-17T07:49:17.9228028+00:00"
},
"date_in_production_since": "2026-04-17T07:49:17.9384255+00:00",
"date_out_of_production_since": "2026-04-17T07:49:17.9384255+00:00",
"date_end_support": "2026-04-17T07:49:17.9384255+00:00",
"sales_organization_id": "b0a4631c-2d50-4ba4-a26e-0c3f891b6c83",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "60614e32-a6e1-40a9-914e-59ce44db0630",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6c9d4d4-1914-471c-953b-a8d8efb6eece",
"db_currency_id": "9fdfb150-5983-48e3-9e67-e073004304c9",
"db_language_id": "dc4c9271-ebcc-428a-9c48-c0bd6bce2c62",
"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-04-17T07:49:17.9228028+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-04-17T07:49:17.9384255+00:00"
},
"project_status_id": "9cf840ed-8edd-46e4-b979-eb053c23a7ba",
"project_status_code": "sample string 10",
"project_status": {
"id": "a325a23d-a778-4558-8ad0-679a5edbd1bc",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3ec949fc-2941-4873-a455-62366bd9df50",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "60614e32-a6e1-40a9-914e-59ce44db0630",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6c9d4d4-1914-471c-953b-a8d8efb6eece",
"db_currency_id": "9fdfb150-5983-48e3-9e67-e073004304c9",
"db_language_id": "dc4c9271-ebcc-428a-9c48-c0bd6bce2c62",
"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-04-17T07:49:17.9228028+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-17T07:49:17.9384255+00:00"
},
"company_id": "b8702dbc-2544-4ce0-83df-7a70b5c5b604",
"company_code": "sample string 12",
"db_address_id": "0a35c5a1-d6b9-47cc-8d02-2ac03dd682a2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d9c7e781-786f-437b-8827-3deef9b01122",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bbc6e0a4-88e9-46c7-95c2-e8552d5649fc",
"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-04-17T07:49:17.9384255+00:00",
"date_create": "2026-04-17T07:49:17.9384255+00:00",
"date_update": "2026-04-17T07:49:17.9384255+00:00",
"updated_by_user_id": "3702e914-f37b-40de-b745-93a0b066127d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-17T07:49:17.9384255+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-04-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-17T07:49:17.9384255+00:00",
"date_last_job": "2026-04-17T07:49:17.9384255+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-17T07:49:17.9384255+00:00",
"modified_dateutc": "2026-04-17T07:49:17.9384255+00:00",
"is_mobile_installation": true
},
"job_type_id": "e78824ac-4f37-42a2-acb0-0981a7fd8b17",
"job_type_code": "sample string 7",
"job_type": {
"id": "9ff50448-7354-4d09-a8eb-5d870751c925",
"name": "sample string 2",
"sales_organization_id": "14acddd0-328b-464c-a6bf-3b772b55f8c7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-17T07:49:17.9384255+00:00",
"code": "sample string 7"
},
"job_priority_id": "7547e434-18a9-4546-9619-d7797bb7dfde",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3ca55100-edc0-4bb6-b66e-e608b703df0b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "94ec48d2-4b70-49e1-ae2a-8df0b7ad4b1d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "60614e32-a6e1-40a9-914e-59ce44db0630",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6c9d4d4-1914-471c-953b-a8d8efb6eece",
"db_currency_id": "9fdfb150-5983-48e3-9e67-e073004304c9",
"db_language_id": "dc4c9271-ebcc-428a-9c48-c0bd6bce2c62",
"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-04-17T07:49:17.9228028+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-17T07:49:17.9384255+00:00"
},
"job_status_id": "d6a12e06-9d49-42de-bd2a-ae4cdcefabe1",
"job_status_code": "sample string 11",
"db_address_id": "576581af-e03f-48c5-8fd0-0bc4bba7c889",
"contact_id": "a828d944-8fbb-4d5d-97e0-6e8cdd1161c9",
"requested_by_company_id": "610c0091-b724-4653-80ae-d75e54cd549c",
"requested_by_contact_id": "7d206053-eaec-411d-80a0-8443dd62c3f5",
"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-04-17T07:49:17.9384255+00:00",
"due_date": "2026-04-17T07:49:17.9384255+00:00",
"date_create": "2026-04-17T07:49:17.9384255+00:00",
"date_update": "2026-04-17T07:49:17.9384255+00:00",
"date_closed": "2026-04-17T07:49:17.9384255+00:00",
"suggested_user_id": "936a8886-ab07-4fcc-9339-791f913108c6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7fb5d6c5-a479-4a7e-94d9-55188d912127",
"db_language_id": "bf0d3d0b-5ba4-427d-9e32-fa0ce83c81f1",
"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-04-17T07:49:17.9384255+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "98542a21-8b86-4547-87f6-4a9091dc505b",
"sales_organization": {
"id": "60614e32-a6e1-40a9-914e-59ce44db0630",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6c9d4d4-1914-471c-953b-a8d8efb6eece",
"db_currency_id": "9fdfb150-5983-48e3-9e67-e073004304c9",
"db_language_id": "dc4c9271-ebcc-428a-9c48-c0bd6bce2c62",
"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-04-17T07:49:17.9228028+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fc59b70c-0bd5-4098-8f2f-9e54b6f1b88c",
"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": "492e38cb-d3e0-4554-bc84-724d692241bd",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-17T07:49:17.9384255+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4aa3139d-18f5-485a-98d1-eb4b9f637199"
},
"suggested_date_start": "2026-04-17T07:49:17.9384255+00:00",
"skill_id": "1c9f6d5f-02ef-4f70-8e39-7566ef043dc1",
"skill_code": "sample string 32",
"skill": {
"id": "e01f978d-f707-4f8a-8593-0993395d7e99",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1031419e-230c-44e1-b945-676f6be5fbd0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "60614e32-a6e1-40a9-914e-59ce44db0630",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b6c9d4d4-1914-471c-953b-a8d8efb6eece",
"db_currency_id": "9fdfb150-5983-48e3-9e67-e073004304c9",
"db_language_id": "dc4c9271-ebcc-428a-9c48-c0bd6bce2c62",
"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-04-17T07:49:17.9228028+00:00"
},
"modified_dateutc": "2026-04-17T07:49:17.9384255+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "daf1a6be-b96a-428b-a1f5-0800eb3f54b4",
"date_reported_by_company": "2026-04-17T07:49:17.9384255+00:00",
"id2": 36,
"company_id": "aa75d90b-63b6-46a4-8377-0023ffa6d02d",
"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": "16effa2c-f6bc-4afa-8766-23df5cf74bb5",
"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-04-17T07:49:17.9384255+00:00"
},
"work_instruction_details_id": "af509e66-88ae-48a6-8ecf-29bf0ae73848",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d94fb3b6-b535-4bd1-8c97-910735f2c3be",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "afb53581-aef5-402a-8f84-bee55794eb67",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-17T07:49:17.9384255+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": "6570c785-5299-4e5b-aae6-4a306b39437e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-17T07:49:17.9384255+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.