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": "db2e2da7-9e1c-4ccb-b2dc-6114dae11b62",
"jobs_id": "c70f1a7e-8020-4bb7-ae6a-9c87c0983aa0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4ee7701a-9e51-4ee7-be53-e96fe8f44ba9",
"_parent_id": "83141975-ca7e-4ea9-bd4d-bebf39ceb25d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ccb9e913-568e-4927-82f5-a3d7819c9720",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d99e5437-efe5-45c6-8234-420498b076bc",
"_parent_id": "1ea6f865-9d51-43a1-b541-705316d89a5e",
"root_parent_id": "a711fa45-4669-4e16-a422-150d46a3ff92",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "52207632-2144-46af-b4e6-7f480d3eda96",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9afb0216-e923-49d1-bac7-6caadeacf52d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "85064247-b88e-4cb6-81ca-f621ef02025a",
"_parent_code": "sample string 6",
"sales_organization_id": "a863f2fa-df29-4f80-b034-70879bd80b99",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "aff2da65-4914-4fe2-a60d-c1b815a8f442",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1a06270-6c07-4ac2-bb22-da295935d925",
"db_currency_id": "59bbecd7-32ab-447f-8773-c446bec14a36",
"db_language_id": "e6085b6f-4aff-456f-916a-e930e0cf4efe",
"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-08T18:59:22.0449708+00:00"
},
"modified_dateutc": "2025-11-08T18:59:22.060588+00:00"
},
"equipment_model_id": "b7d7c07b-07ee-4c0d-af34-01d8a5b48063",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7f273b86-d7b2-46d9-a2ee-51111e768cf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f59a1fbc-789b-44f4-9e5e-1a07f90084cc",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "896637d6-10ef-475f-8684-b2079d41196a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "016bc5ff-9d23-4e3b-b573-125959e08bd8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "aff2da65-4914-4fe2-a60d-c1b815a8f442",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1a06270-6c07-4ac2-bb22-da295935d925",
"db_currency_id": "59bbecd7-32ab-447f-8773-c446bec14a36",
"db_language_id": "e6085b6f-4aff-456f-916a-e930e0cf4efe",
"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-08T18:59:22.0449708+00:00"
},
"modified_dateutc": "2025-11-08T18:59:22.060588+00:00"
},
"equipment_family_id": "b12cff6c-027d-4989-b98e-939a3efa2c0b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9afb0216-e923-49d1-bac7-6caadeacf52d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "85064247-b88e-4cb6-81ca-f621ef02025a",
"_parent_code": "sample string 6",
"sales_organization_id": "a863f2fa-df29-4f80-b034-70879bd80b99",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "aff2da65-4914-4fe2-a60d-c1b815a8f442",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1a06270-6c07-4ac2-bb22-da295935d925",
"db_currency_id": "59bbecd7-32ab-447f-8773-c446bec14a36",
"db_language_id": "e6085b6f-4aff-456f-916a-e930e0cf4efe",
"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-08T18:59:22.0449708+00:00"
},
"modified_dateutc": "2025-11-08T18:59:22.060588+00:00"
},
"date_in_production_since": "2025-11-08T18:59:22.060588+00:00",
"date_out_of_production_since": "2025-11-08T18:59:22.060588+00:00",
"date_end_support": "2025-11-08T18:59:22.060588+00:00",
"sales_organization_id": "a839652d-b57a-483f-ad6a-8f3f270d7e93",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "aff2da65-4914-4fe2-a60d-c1b815a8f442",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1a06270-6c07-4ac2-bb22-da295935d925",
"db_currency_id": "59bbecd7-32ab-447f-8773-c446bec14a36",
"db_language_id": "e6085b6f-4aff-456f-916a-e930e0cf4efe",
"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-08T18:59:22.0449708+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-08T18:59:22.060588+00:00"
},
"project_status_id": "39463656-b61b-46d9-8cdd-af1abdd050ea",
"project_status_code": "sample string 10",
"project_status": {
"id": "19bac262-89ef-44e0-966b-5706f4b6a974",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1c66f36d-a455-4b63-91b1-d791c24dc960",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aff2da65-4914-4fe2-a60d-c1b815a8f442",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1a06270-6c07-4ac2-bb22-da295935d925",
"db_currency_id": "59bbecd7-32ab-447f-8773-c446bec14a36",
"db_language_id": "e6085b6f-4aff-456f-916a-e930e0cf4efe",
"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-08T18:59:22.0449708+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-08T18:59:22.060588+00:00"
},
"company_id": "f0e24cce-2863-434c-bef3-9adf6ebd3857",
"company_code": "sample string 12",
"db_address_id": "5b8cb32f-9ff9-403d-9154-c323406bfc91",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fc709516-a5fc-48bb-b001-3a3875c2caaf",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "62e319c4-b2b4-4380-8770-2341b3dfa813",
"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-08T18:59:22.060588+00:00",
"date_create": "2025-11-08T18:59:22.060588+00:00",
"date_update": "2025-11-08T18:59:22.060588+00:00",
"updated_by_user_id": "7d498ad6-8f84-4174-943b-3921d8219a7c",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-08T18:59:22.060588+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-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-08T18:59:22.060588+00:00",
"date_last_job": "2025-11-08T18:59:22.060588+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-08T18:59:22.060588+00:00",
"modified_dateutc": "2025-11-08T18:59:22.060588+00:00",
"is_mobile_installation": true
},
"job_type_id": "0147485c-7de7-4444-82e1-45d66045cbe7",
"job_type_code": "sample string 7",
"job_type": {
"id": "2304cc1a-ec38-4135-8173-dc3a6ebe5e8a",
"name": "sample string 2",
"sales_organization_id": "8c7a2615-2b07-4c25-9147-7ef1dfd9ad77",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-08T18:59:22.060588+00:00",
"code": "sample string 7"
},
"job_priority_id": "ad3ecac8-923b-4367-819e-b2e6ed926afa",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3b75f21b-122c-4f52-a943-737ef4c58548",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "54272ea2-c462-48d3-9c02-10dc717a31bf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aff2da65-4914-4fe2-a60d-c1b815a8f442",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1a06270-6c07-4ac2-bb22-da295935d925",
"db_currency_id": "59bbecd7-32ab-447f-8773-c446bec14a36",
"db_language_id": "e6085b6f-4aff-456f-916a-e930e0cf4efe",
"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-08T18:59:22.0449708+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-08T18:59:22.060588+00:00"
},
"job_status_id": "6bc67556-29b6-4112-806b-1f32d546add1",
"job_status_code": "sample string 11",
"db_address_id": "33924f5e-5743-4e40-8533-59a29a52673d",
"contact_id": "b2450af9-e64e-4de3-b39b-cd598fc7ef4f",
"requested_by_company_id": "c1733bf5-e2d9-469b-b402-fa659927bdeb",
"requested_by_contact_id": "36355ad8-c901-4cfa-890f-3164b7b07a64",
"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-08T18:59:22.060588+00:00",
"due_date": "2025-11-08T18:59:22.060588+00:00",
"date_create": "2025-11-08T18:59:22.060588+00:00",
"date_update": "2025-11-08T18:59:22.060588+00:00",
"date_closed": "2025-11-08T18:59:22.060588+00:00",
"suggested_user_id": "92993c11-fcd3-4c05-9647-186a1ba70135",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "12d1b964-2db0-4b1b-84f4-6aeeefbbb554",
"db_language_id": "1410d879-0408-4d3b-abc1-9fa062e4ea60",
"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-08T18:59:22.060588+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b3286f97-2101-4fdf-ba7c-e169423754c9",
"sales_organization": {
"id": "aff2da65-4914-4fe2-a60d-c1b815a8f442",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1a06270-6c07-4ac2-bb22-da295935d925",
"db_currency_id": "59bbecd7-32ab-447f-8773-c446bec14a36",
"db_language_id": "e6085b6f-4aff-456f-916a-e930e0cf4efe",
"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-08T18:59:22.0449708+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a3fc2508-34ac-4538-b1fd-76755956ea37",
"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": "5ccd1198-2ff2-4262-9f1b-b8498e4275ca",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-08T18:59:22.060588+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7c45a565-815b-4aef-8024-fc6d5976ec6f"
},
"suggested_date_start": "2025-11-08T18:59:22.060588+00:00",
"skill_id": "fcaadded-1af6-4795-b5c2-91ae63f06ad2",
"skill_code": "sample string 32",
"skill": {
"id": "058ffa7a-a305-42cf-b00b-28f74b875012",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d46f3e36-6171-4d52-adde-e4ba34cc9bf2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aff2da65-4914-4fe2-a60d-c1b815a8f442",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f1a06270-6c07-4ac2-bb22-da295935d925",
"db_currency_id": "59bbecd7-32ab-447f-8773-c446bec14a36",
"db_language_id": "e6085b6f-4aff-456f-916a-e930e0cf4efe",
"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-08T18:59:22.0449708+00:00"
},
"modified_dateutc": "2025-11-08T18:59:22.060588+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7b8e5eb9-52bf-4a3e-ac73-a11218f6fd12",
"date_reported_by_company": "2025-11-08T18:59:22.060588+00:00",
"id2": 36,
"company_id": "82360761-3ce8-4eb8-87ef-5bbe26b99471",
"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": "e4a57d80-3480-4553-8871-bf4c4372edc1",
"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-08T18:59:22.060588+00:00"
},
"work_instruction_details_id": "f8f97e38-3a0c-48b0-8679-b6ee5593c592",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8c00f091-ae16-43f9-a801-35914ddc31c7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dbb4985e-4edb-4dc2-9b5a-4d641a130c19",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-08T18:59:22.060588+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": "b32b278c-4461-4e80-9764-78674f006ff8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-08T18:59:22.060588+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.