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": "be033a73-329f-4cd7-89b3-b297ab06cf7c",
"jobs_id": "737525b6-9ae7-4d95-b3d1-81550f14e0fe",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "57888e57-de7b-4d8f-928c-9b4d518f3a02",
"_parent_id": "d7ffd7b8-e4c0-4773-8921-1db51003c043",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7029e8e7-c8f4-4660-b40b-1bfed6d33977",
"project_reference_back_office": "sample string 5",
"project": {
"id": "974365d3-c6a4-49f5-a39c-1fdb7f82e6c1",
"_parent_id": "418c713f-3cb2-413c-afce-bf00a33972cc",
"root_parent_id": "b15647d4-a49e-42b5-910c-41e05e9e96e8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f1e3f77f-8960-4d90-8e4e-04d5897a8488",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "de58d231-dcc1-4ddc-8cc4-17b5f7571106",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "19949eb0-037d-417d-bf69-a74697ee0c53",
"_parent_code": "sample string 6",
"sales_organization_id": "011395db-e668-42ec-bbb4-05111e553960",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d7a4f79b-8da6-492d-9d5e-35c876b5577f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "943f7b83-0d24-45f5-a8fc-01e80796ce83",
"db_currency_id": "68b13c9f-01c3-48e8-ad27-49e5799eafc5",
"db_language_id": "272bf2e9-bcc0-48cf-a42e-6669a390a8d8",
"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-07T17:30:47.7500983+00:00"
},
"modified_dateutc": "2025-11-07T17:30:47.7500983+00:00"
},
"equipment_model_id": "ce1b997e-d764-41c8-8cc6-a27832fa3720",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "47511000-e0b2-4c5e-b3a2-f2b13cf901c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9308a166-2794-4140-9c5a-0f169bc53e04",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "86a6c3c3-e5b7-4c03-8de3-7ff29a9956d9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "88255f05-e241-46b9-be46-863c2a82a656",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d7a4f79b-8da6-492d-9d5e-35c876b5577f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "943f7b83-0d24-45f5-a8fc-01e80796ce83",
"db_currency_id": "68b13c9f-01c3-48e8-ad27-49e5799eafc5",
"db_language_id": "272bf2e9-bcc0-48cf-a42e-6669a390a8d8",
"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-07T17:30:47.7500983+00:00"
},
"modified_dateutc": "2025-11-07T17:30:47.7500983+00:00"
},
"equipment_family_id": "8033b966-b2a8-4107-911f-88c689fac77e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "de58d231-dcc1-4ddc-8cc4-17b5f7571106",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "19949eb0-037d-417d-bf69-a74697ee0c53",
"_parent_code": "sample string 6",
"sales_organization_id": "011395db-e668-42ec-bbb4-05111e553960",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d7a4f79b-8da6-492d-9d5e-35c876b5577f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "943f7b83-0d24-45f5-a8fc-01e80796ce83",
"db_currency_id": "68b13c9f-01c3-48e8-ad27-49e5799eafc5",
"db_language_id": "272bf2e9-bcc0-48cf-a42e-6669a390a8d8",
"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-07T17:30:47.7500983+00:00"
},
"modified_dateutc": "2025-11-07T17:30:47.7500983+00:00"
},
"date_in_production_since": "2025-11-07T17:30:47.7500983+00:00",
"date_out_of_production_since": "2025-11-07T17:30:47.7500983+00:00",
"date_end_support": "2025-11-07T17:30:47.7500983+00:00",
"sales_organization_id": "b440de2f-ab9e-4d67-9148-b3a232a44278",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d7a4f79b-8da6-492d-9d5e-35c876b5577f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "943f7b83-0d24-45f5-a8fc-01e80796ce83",
"db_currency_id": "68b13c9f-01c3-48e8-ad27-49e5799eafc5",
"db_language_id": "272bf2e9-bcc0-48cf-a42e-6669a390a8d8",
"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-07T17:30:47.7500983+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-07T17:30:47.7500983+00:00"
},
"project_status_id": "49970b13-9fb0-4b74-91a1-d58be16adb97",
"project_status_code": "sample string 10",
"project_status": {
"id": "7b91cb1e-ef84-4d7b-be9e-5f12dc50c136",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fb4418e1-aa94-4096-bcce-6a6e8c42f119",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7a4f79b-8da6-492d-9d5e-35c876b5577f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "943f7b83-0d24-45f5-a8fc-01e80796ce83",
"db_currency_id": "68b13c9f-01c3-48e8-ad27-49e5799eafc5",
"db_language_id": "272bf2e9-bcc0-48cf-a42e-6669a390a8d8",
"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-07T17:30:47.7500983+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-07T17:30:47.7500983+00:00"
},
"company_id": "e05cee2b-4c64-4627-83cf-fd8d3588e10d",
"company_code": "sample string 12",
"db_address_id": "1234c19e-ff56-4fd5-949a-a83e8c7d62b0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c393f3fd-f03d-4d23-a513-948caa4d95b4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1e14cdef-2d87-4e8d-aaa0-bfb1fb935efb",
"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-07T17:30:47.7500983+00:00",
"date_create": "2025-11-07T17:30:47.7500983+00:00",
"date_update": "2025-11-07T17:30:47.7500983+00:00",
"updated_by_user_id": "fc62348d-9316-4144-8ae5-85fbb3fe22db",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-07T17:30:47.7500983+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-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-07T17:30:47.7500983+00:00",
"date_last_job": "2025-11-07T17:30:47.7500983+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-07T17:30:47.7500983+00:00",
"modified_dateutc": "2025-11-07T17:30:47.7500983+00:00",
"is_mobile_installation": true
},
"job_type_id": "d8a2de71-ef84-4149-89e0-ca0e256ce532",
"job_type_code": "sample string 7",
"job_type": {
"id": "58043ec0-b57f-41dd-9324-536ac817e6be",
"name": "sample string 2",
"sales_organization_id": "88420acc-bbf3-4e41-9296-90b1ea8aa38b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-07T17:30:47.7500983+00:00",
"code": "sample string 7"
},
"job_priority_id": "b8e72dfe-9998-4e7b-9ad5-290fb35be9d2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a54204bd-fe74-4966-b2ed-cfb816cd45e7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2ba7c0fc-a164-4af8-b8e8-7bc6a360d47e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7a4f79b-8da6-492d-9d5e-35c876b5577f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "943f7b83-0d24-45f5-a8fc-01e80796ce83",
"db_currency_id": "68b13c9f-01c3-48e8-ad27-49e5799eafc5",
"db_language_id": "272bf2e9-bcc0-48cf-a42e-6669a390a8d8",
"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-07T17:30:47.7500983+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-07T17:30:47.7500983+00:00"
},
"job_status_id": "e2829f2b-c829-4979-99b0-bd5ce0396e55",
"job_status_code": "sample string 11",
"db_address_id": "95fba79a-f200-4cb5-a390-76f423586a7f",
"contact_id": "78e1b36b-4c8f-41e7-bff3-a4d451793cb2",
"requested_by_company_id": "4ed6a576-1c29-48ea-ad39-3fcf67bfd232",
"requested_by_contact_id": "7cd8dbff-e2d9-44fd-a844-40cf829d82e2",
"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-07T17:30:47.7500983+00:00",
"due_date": "2025-11-07T17:30:47.7500983+00:00",
"date_create": "2025-11-07T17:30:47.7500983+00:00",
"date_update": "2025-11-07T17:30:47.7500983+00:00",
"date_closed": "2025-11-07T17:30:47.7500983+00:00",
"suggested_user_id": "d570fa92-fdd4-4a1e-b52c-d21a881f363b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c5fbb4bf-828e-4070-adff-6f697d6b0a71",
"db_language_id": "3730c2e7-624b-4187-8c82-cdd5e8361d71",
"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-07T17:30:47.7500983+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4a07b8a9-b15e-4adb-9df8-49e6ee065b0d",
"sales_organization": {
"id": "d7a4f79b-8da6-492d-9d5e-35c876b5577f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "943f7b83-0d24-45f5-a8fc-01e80796ce83",
"db_currency_id": "68b13c9f-01c3-48e8-ad27-49e5799eafc5",
"db_language_id": "272bf2e9-bcc0-48cf-a42e-6669a390a8d8",
"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-07T17:30:47.7500983+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "50e53e48-973e-46ef-b5d4-62a144d4495d",
"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": "3b8b523d-5b79-4fb6-a1d6-9004373482bb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-07T17:30:47.7500983+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "367c525e-29dd-4fb3-bcfc-84ada63800a3"
},
"suggested_date_start": "2025-11-07T17:30:47.7500983+00:00",
"skill_id": "53d2026c-1ba8-4039-97ed-5e94169ea296",
"skill_code": "sample string 32",
"skill": {
"id": "ecc9acac-88fb-4c37-a8e6-4d2b05175ad6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5fa21cd0-d16a-46dd-a999-2580673454d0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d7a4f79b-8da6-492d-9d5e-35c876b5577f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "943f7b83-0d24-45f5-a8fc-01e80796ce83",
"db_currency_id": "68b13c9f-01c3-48e8-ad27-49e5799eafc5",
"db_language_id": "272bf2e9-bcc0-48cf-a42e-6669a390a8d8",
"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-07T17:30:47.7500983+00:00"
},
"modified_dateutc": "2025-11-07T17:30:47.7500983+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "45e39ccb-689b-4df5-95df-173b8848b612",
"date_reported_by_company": "2025-11-07T17:30:47.7500983+00:00",
"id2": 36,
"company_id": "3e455b4c-f7c1-4d62-ad67-e40a6f5b7094",
"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": "d5a425e5-c471-444d-b70b-362963c0f92e",
"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-07T17:30:47.7500983+00:00"
},
"work_instruction_details_id": "44d6e2a7-3393-41b0-b288-a93abb9c8ba1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4038631d-8d78-4723-ae59-ed7b89be587b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c5bed550-bf99-4055-9828-a6423d81e203",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-07T17:30:47.7500983+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": "aad3e2dc-cdce-49dd-96ea-501782ade156",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-07T17:30:47.7500983+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.