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": "3d891dad-b4c5-4917-80ca-819c72e8c4d2",
"jobs_id": "78bd6302-a306-4608-b038-f861a77c0338",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3f02edca-45ec-4b7d-8687-8989b53202e2",
"_parent_id": "cd675099-d7b3-4b5e-ab57-30354eff885f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b816dded-6fd8-4081-ae68-ab0200739aea",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b291c855-d876-491c-b920-3de7d0a812e5",
"_parent_id": "f1a99611-fc0f-4653-b7e5-18dd7dbd3012",
"root_parent_id": "f5ed5fdb-3b15-4205-949b-c06d6c2e0c37",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "79dfbd06-f7a9-4711-8ea7-51be544891de",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "99992568-3c2e-4b3d-adfa-4fb63ddeac28",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "121c17e0-a549-4368-9b4c-e596b3ce2bbc",
"_parent_code": "sample string 6",
"sales_organization_id": "55f373de-d575-425f-bfa9-9d9d511d933b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9574f283-2498-4e53-971c-4f8ae858f06a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c12c2af-f83e-40bf-8a39-67300cd1037d",
"db_currency_id": "cd4e1287-fa8d-4633-a1d9-2f3c91cc0f7e",
"db_language_id": "3cd45d00-6825-4d70-abc7-f15f978a786e",
"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-09T14:06:41.4558554+00:00"
},
"modified_dateutc": "2026-07-09T14:06:41.4558554+00:00"
},
"equipment_model_id": "f5568043-343a-4cac-b3d4-99594c51e878",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4e497b4f-2ee8-4636-b6c1-dc0f7cca4d4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d6463d2d-e576-4c4e-85d2-fcccb7c258eb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d2af685d-2cb2-450b-8f64-d72edc3e53ff",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6b1a46dc-3623-4f75-9489-6bd7cbec9614",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9574f283-2498-4e53-971c-4f8ae858f06a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c12c2af-f83e-40bf-8a39-67300cd1037d",
"db_currency_id": "cd4e1287-fa8d-4633-a1d9-2f3c91cc0f7e",
"db_language_id": "3cd45d00-6825-4d70-abc7-f15f978a786e",
"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-09T14:06:41.4558554+00:00"
},
"modified_dateutc": "2026-07-09T14:06:41.4558554+00:00"
},
"equipment_family_id": "3da4fdc7-e8ee-44a5-b662-7e40a29611c1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "99992568-3c2e-4b3d-adfa-4fb63ddeac28",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "121c17e0-a549-4368-9b4c-e596b3ce2bbc",
"_parent_code": "sample string 6",
"sales_organization_id": "55f373de-d575-425f-bfa9-9d9d511d933b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9574f283-2498-4e53-971c-4f8ae858f06a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c12c2af-f83e-40bf-8a39-67300cd1037d",
"db_currency_id": "cd4e1287-fa8d-4633-a1d9-2f3c91cc0f7e",
"db_language_id": "3cd45d00-6825-4d70-abc7-f15f978a786e",
"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-09T14:06:41.4558554+00:00"
},
"modified_dateutc": "2026-07-09T14:06:41.4558554+00:00"
},
"date_in_production_since": "2026-07-09T14:06:41.4558554+00:00",
"date_out_of_production_since": "2026-07-09T14:06:41.4558554+00:00",
"date_end_support": "2026-07-09T14:06:41.4558554+00:00",
"sales_organization_id": "eb4036ee-a1a3-41c1-ae70-efa36c7d1332",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9574f283-2498-4e53-971c-4f8ae858f06a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c12c2af-f83e-40bf-8a39-67300cd1037d",
"db_currency_id": "cd4e1287-fa8d-4633-a1d9-2f3c91cc0f7e",
"db_language_id": "3cd45d00-6825-4d70-abc7-f15f978a786e",
"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-09T14:06:41.4558554+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-09T14:06:41.4558554+00:00"
},
"project_status_id": "f8dc93c2-c11a-4701-914b-4ee3203aa9f4",
"project_status_code": "sample string 10",
"project_status": {
"id": "86c474df-8245-45cd-b681-839f32fd180f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1a83945f-e1da-42dd-ad16-a26bda07fe4f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9574f283-2498-4e53-971c-4f8ae858f06a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c12c2af-f83e-40bf-8a39-67300cd1037d",
"db_currency_id": "cd4e1287-fa8d-4633-a1d9-2f3c91cc0f7e",
"db_language_id": "3cd45d00-6825-4d70-abc7-f15f978a786e",
"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-09T14:06:41.4558554+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-09T14:06:41.4558554+00:00"
},
"company_id": "45f03ef7-ffaf-4ebb-b484-81e162768641",
"company_code": "sample string 12",
"db_address_id": "8e0441fa-5978-48a5-890a-f09e0ec57961",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e203198b-5373-44bf-90c0-5464eff479bc",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b3e14424-8d87-4846-b2bd-9357fc0858cd",
"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-09T14:06:41.4558554+00:00",
"date_create": "2026-07-09T14:06:41.4558554+00:00",
"date_update": "2026-07-09T14:06:41.4558554+00:00",
"updated_by_user_id": "f8a11bca-a960-4d06-a510-b86ea31d4f6f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-09T14:06:41.4558554+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-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-09T14:06:41.4558554+00:00",
"date_last_job": "2026-07-09T14:06:41.4558554+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-09T14:06:41.4558554+00:00",
"modified_dateutc": "2026-07-09T14:06:41.4558554+00:00",
"is_mobile_installation": true
},
"job_type_id": "87b5044a-71a1-4c96-aa79-c764dae75611",
"job_type_code": "sample string 7",
"job_type": {
"id": "a1a71cc0-820e-40c2-9ada-4ee0ee190f05",
"name": "sample string 2",
"sales_organization_id": "ef5fb755-bf87-4051-b955-19dca0cf14c0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-09T14:06:41.4558554+00:00",
"code": "sample string 7"
},
"job_priority_id": "41c826be-4d8b-4dfd-9b2c-95d8bfd7bb59",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8a8abc20-deeb-4547-a0cd-bb765a9a6a20",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f9636b6c-0c89-42e5-9776-cfffbaea516f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9574f283-2498-4e53-971c-4f8ae858f06a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c12c2af-f83e-40bf-8a39-67300cd1037d",
"db_currency_id": "cd4e1287-fa8d-4633-a1d9-2f3c91cc0f7e",
"db_language_id": "3cd45d00-6825-4d70-abc7-f15f978a786e",
"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-09T14:06:41.4558554+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-09T14:06:41.4558554+00:00"
},
"job_status_id": "b0124526-ed9d-465e-9fcf-5508d830ac64",
"job_status_code": "sample string 11",
"db_address_id": "52029f9e-d5aa-419c-965e-ab1b475edfbf",
"contact_id": "1058808a-beaa-4df6-8304-6f2ffc6ed916",
"requested_by_company_id": "fc5748d1-e0b3-466e-8ae1-dd6399294b06",
"requested_by_contact_id": "417f6eaf-cf2c-4cdc-a5f2-c93130051186",
"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-09T14:06:41.4558554+00:00",
"due_date": "2026-07-09T14:06:41.4558554+00:00",
"date_create": "2026-07-09T14:06:41.4558554+00:00",
"date_update": "2026-07-09T14:06:41.4558554+00:00",
"date_closed": "2026-07-09T14:06:41.4558554+00:00",
"suggested_user_id": "4658ba33-671b-4247-9555-4a9373a42b37",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "151468ac-3d64-4ae7-8708-d941d2538bd4",
"db_language_id": "70aa0472-c73d-419e-8784-b6d5dff8418d",
"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-09T14:06:41.4558554+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5599b24d-6947-48b0-9c57-567d1875b7bb",
"sales_organization": {
"id": "9574f283-2498-4e53-971c-4f8ae858f06a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c12c2af-f83e-40bf-8a39-67300cd1037d",
"db_currency_id": "cd4e1287-fa8d-4633-a1d9-2f3c91cc0f7e",
"db_language_id": "3cd45d00-6825-4d70-abc7-f15f978a786e",
"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-09T14:06:41.4558554+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "460330d8-75c9-42b4-aaaa-c17cc38b2341",
"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": "9865cee9-3f29-4961-8437-15a6309cbb15",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-09T14:06:41.4558554+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b8b1c965-da2b-4977-8176-7477b0cc8213"
},
"suggested_date_start": "2026-07-09T14:06:41.4558554+00:00",
"skill_id": "0481b280-2d69-4f1d-b15a-7b26bcc223f2",
"skill_code": "sample string 32",
"skill": {
"id": "a7629a23-335e-4401-afca-c652cc186177",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "71660622-9cd3-453b-8c00-81dff6596720",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9574f283-2498-4e53-971c-4f8ae858f06a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c12c2af-f83e-40bf-8a39-67300cd1037d",
"db_currency_id": "cd4e1287-fa8d-4633-a1d9-2f3c91cc0f7e",
"db_language_id": "3cd45d00-6825-4d70-abc7-f15f978a786e",
"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-09T14:06:41.4558554+00:00"
},
"modified_dateutc": "2026-07-09T14:06:41.4558554+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1f070dff-1d57-4df1-934a-0ebbaf1a257f",
"date_reported_by_company": "2026-07-09T14:06:41.4558554+00:00",
"id2": 36,
"company_id": "46469f6f-efba-4b36-810f-3bc7da2929c3",
"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": "d785a5aa-1e2a-4524-a1fc-8b96601aba7e",
"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-09T14:06:41.4558554+00:00"
},
"work_instruction_details_id": "00db55ba-3019-4010-9158-bbe8c1e061e4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d5baa137-4bd3-46cb-bfba-b7e8cffc2f55",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "53d23c98-aceb-4494-a226-598cc28be631",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-09T14:06:41.4558554+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": "3ecad5a0-4c64-4363-8958-4317d0a30f6b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-09T14:06:41.4714786+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.