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": "8ff0f076-ef58-4a00-973b-1f428fdfd6e3",
"jobs_id": "ae785127-91ec-4685-b7ab-72b21cba3704",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bc0a8a1e-879b-45df-bae2-ec506b840042",
"_parent_id": "9060496b-d99c-4f6c-9dac-77b2b71d0655",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "aa1c66da-6849-4106-ac0f-e389324fdc2f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8275c887-30a5-4803-9b49-3b0a83a73454",
"_parent_id": "da55ff7f-3f78-4090-ba58-6b275c4d2b41",
"root_parent_id": "c2dbd0c8-b786-4503-949a-0a35b38c8fc8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b73bd030-e926-4d5c-bd6a-f8d786244975",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f939cf00-65bd-4129-a020-f5b93899ad04",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "97f7289a-37f0-4643-956c-62023aa9e3c6",
"_parent_code": "sample string 6",
"sales_organization_id": "8e3b3138-e6ea-44a8-8750-f586e8bcaa3d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f4a116b6-eaf1-4b28-af6a-172f44d97a4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ff30ee29-a29e-44f1-8502-c40768305273",
"db_currency_id": "c6c4de3d-c483-4838-991f-e37e03588223",
"db_language_id": "e73894d6-a5ed-4716-ae24-de45356a1c20",
"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-07-13T22:54:17.5741117+00:00"
},
"modified_dateutc": "2026-07-13T22:54:17.5741117+00:00"
},
"equipment_model_id": "5b524a75-183e-447e-a70f-42e6b449b915",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "515a8875-a55c-44ef-ba39-1339d8bdb994",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "46bb07d6-9e15-4ea3-9ce8-d18a7288ae4e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "04c75f7e-388b-4cf3-8fda-dc7296553060",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a689770a-bbb3-4408-a74a-012449d6b084",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f4a116b6-eaf1-4b28-af6a-172f44d97a4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ff30ee29-a29e-44f1-8502-c40768305273",
"db_currency_id": "c6c4de3d-c483-4838-991f-e37e03588223",
"db_language_id": "e73894d6-a5ed-4716-ae24-de45356a1c20",
"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-07-13T22:54:17.5741117+00:00"
},
"modified_dateutc": "2026-07-13T22:54:17.5741117+00:00"
},
"equipment_family_id": "195023af-899d-4dd3-9510-1f7bd12d164f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f939cf00-65bd-4129-a020-f5b93899ad04",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "97f7289a-37f0-4643-956c-62023aa9e3c6",
"_parent_code": "sample string 6",
"sales_organization_id": "8e3b3138-e6ea-44a8-8750-f586e8bcaa3d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f4a116b6-eaf1-4b28-af6a-172f44d97a4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ff30ee29-a29e-44f1-8502-c40768305273",
"db_currency_id": "c6c4de3d-c483-4838-991f-e37e03588223",
"db_language_id": "e73894d6-a5ed-4716-ae24-de45356a1c20",
"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-07-13T22:54:17.5741117+00:00"
},
"modified_dateutc": "2026-07-13T22:54:17.5741117+00:00"
},
"date_in_production_since": "2026-07-13T22:54:17.5741117+00:00",
"date_out_of_production_since": "2026-07-13T22:54:17.5741117+00:00",
"date_end_support": "2026-07-13T22:54:17.5741117+00:00",
"sales_organization_id": "b8d0df16-1e17-4c27-8d2c-24cf5e5dd941",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f4a116b6-eaf1-4b28-af6a-172f44d97a4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ff30ee29-a29e-44f1-8502-c40768305273",
"db_currency_id": "c6c4de3d-c483-4838-991f-e37e03588223",
"db_language_id": "e73894d6-a5ed-4716-ae24-de45356a1c20",
"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-07-13T22:54:17.5741117+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-07-13T22:54:17.5741117+00:00"
},
"project_status_id": "22047d76-1b7f-4c59-b522-0bc151c138b6",
"project_status_code": "sample string 10",
"project_status": {
"id": "3bfdc06a-4217-4ede-b1a2-0e9a1c96ed71",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3d5e70b2-95f2-4485-874e-f44a0c8ee379",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f4a116b6-eaf1-4b28-af6a-172f44d97a4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ff30ee29-a29e-44f1-8502-c40768305273",
"db_currency_id": "c6c4de3d-c483-4838-991f-e37e03588223",
"db_language_id": "e73894d6-a5ed-4716-ae24-de45356a1c20",
"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-07-13T22:54:17.5741117+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-13T22:54:17.5741117+00:00"
},
"company_id": "c970db27-bff4-4649-9d13-a750a0bbf725",
"company_code": "sample string 12",
"db_address_id": "d0fb5ecd-ed29-42ad-869a-aab0d1e8b261",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "98f375ed-1928-45e8-9068-998ba9004599",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f274bb1b-c3b8-409e-8b20-46a7c38ff257",
"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-07-13T22:54:17.5741117+00:00",
"date_create": "2026-07-13T22:54:17.5741117+00:00",
"date_update": "2026-07-13T22:54:17.5741117+00:00",
"updated_by_user_id": "286508d4-7e2d-4346-a375-0da80f7f2b0a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-13T22:54:17.5741117+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-07-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-13T22:54:17.5741117+00:00",
"date_last_job": "2026-07-13T22:54:17.5741117+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-13T22:54:17.5741117+00:00",
"modified_dateutc": "2026-07-13T22:54:17.5741117+00:00",
"is_mobile_installation": true
},
"job_type_id": "96f67c15-cea7-47eb-8529-18e18dc6a2ac",
"job_type_code": "sample string 7",
"job_type": {
"id": "29708904-81b9-4331-87a2-70ec678b34d8",
"name": "sample string 2",
"sales_organization_id": "39d783b6-ae45-43bf-a58b-05e80850b077",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-13T22:54:17.5741117+00:00",
"code": "sample string 7"
},
"job_priority_id": "c8500156-3b7f-4919-be04-ae95e4eb9b05",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7e9baacd-0098-4b7e-8405-8eda1e872647",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c8962559-e390-4ed8-a9bf-75bce03440ad",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f4a116b6-eaf1-4b28-af6a-172f44d97a4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ff30ee29-a29e-44f1-8502-c40768305273",
"db_currency_id": "c6c4de3d-c483-4838-991f-e37e03588223",
"db_language_id": "e73894d6-a5ed-4716-ae24-de45356a1c20",
"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-07-13T22:54:17.5741117+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-13T22:54:17.5741117+00:00"
},
"job_status_id": "6ecbff27-05c6-4533-96c3-ba7ba8ea1e85",
"job_status_code": "sample string 11",
"db_address_id": "f4cb5a44-c6c5-4589-ab3f-d2f4835d71e4",
"contact_id": "d55534f9-41d8-41b8-8fe2-0fc754590c47",
"requested_by_company_id": "508b393e-6018-4188-874f-3b2ec18535b0",
"requested_by_contact_id": "e21d0d68-8e39-4d42-8c23-c5a4e23639d4",
"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-07-13T22:54:17.5741117+00:00",
"due_date": "2026-07-13T22:54:17.5741117+00:00",
"date_create": "2026-07-13T22:54:17.5741117+00:00",
"date_update": "2026-07-13T22:54:17.5741117+00:00",
"date_closed": "2026-07-13T22:54:17.5741117+00:00",
"suggested_user_id": "91b9effc-0f95-43de-9fac-5ce447234821",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b0507156-8400-4c9c-9e0a-95d4689c97a1",
"db_language_id": "5ab77797-b48a-4ede-a3bd-bace8f3aeb21",
"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-07-13T22:54:17.5741117+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b3abfe99-9b9d-466c-8e68-fc7bfbf8774e",
"sales_organization": {
"id": "f4a116b6-eaf1-4b28-af6a-172f44d97a4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ff30ee29-a29e-44f1-8502-c40768305273",
"db_currency_id": "c6c4de3d-c483-4838-991f-e37e03588223",
"db_language_id": "e73894d6-a5ed-4716-ae24-de45356a1c20",
"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-07-13T22:54:17.5741117+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3b1619da-71bc-4f34-aad5-9a7f1b4cc149",
"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": "22af226a-a3e0-451c-b233-d25261dc7c16",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-13T22:54:17.5741117+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2ff80e36-bebc-4e8f-b763-0cbd07c5588e"
},
"suggested_date_start": "2026-07-13T22:54:17.5741117+00:00",
"skill_id": "0a651976-7fdd-41ae-8ccd-64952271af81",
"skill_code": "sample string 32",
"skill": {
"id": "f2e5fae6-a0a2-4b88-9636-d72acb33c33b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3d396cf8-33e9-46ac-8dbd-a14cf0dfe460",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f4a116b6-eaf1-4b28-af6a-172f44d97a4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ff30ee29-a29e-44f1-8502-c40768305273",
"db_currency_id": "c6c4de3d-c483-4838-991f-e37e03588223",
"db_language_id": "e73894d6-a5ed-4716-ae24-de45356a1c20",
"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-07-13T22:54:17.5741117+00:00"
},
"modified_dateutc": "2026-07-13T22:54:17.5741117+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b3bd7ce3-4794-4709-9237-4ad8a53931c2",
"date_reported_by_company": "2026-07-13T22:54:17.5741117+00:00",
"id2": 36,
"company_id": "e240f817-8a05-4fcb-be3a-4e7786c6f150",
"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": "9e4138a0-85a3-4ad5-a03c-724e183b0cf4",
"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-07-13T22:54:17.5741117+00:00"
},
"work_instruction_details_id": "9c2070e5-df35-4cdf-8a2e-17086690006c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7fa27305-ff8b-4e5e-844e-2f36ed2e64bb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2dfb59b6-02ae-4f12-a7db-903f9a47e43e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-13T22:54:17.5741117+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": "ad2e747f-209d-4906-a731-47b2efeb33f9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-13T22:54:17.5741117+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.