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": "e2cdc712-bf9e-45ce-ba76-558ba631aecd",
"jobs_id": "347b22a8-9913-42c8-a135-d9b5350633d2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7559da62-9b72-4fe9-8bd7-590728189813",
"_parent_id": "3325ab2f-8cb5-4387-85ac-a82861b05e14",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0618987a-7845-44cc-a6a9-aa33c5ed301d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "cdfd3349-0a01-476f-a982-0ea40683c99f",
"_parent_id": "77684774-d2f7-4fef-8fbc-af691f4a334c",
"root_parent_id": "83aacf6c-36e5-4c9e-9ee5-9f1e90b69f91",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3d32a23a-a245-4459-9a6a-613ff333496b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1de3862b-9ee6-47a4-9a8f-0a58a4aab9cb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "74ad96f5-c6d7-46b7-91ae-9651737439e2",
"_parent_code": "sample string 6",
"sales_organization_id": "c8b98dc1-1dda-4385-903b-dacf8fca2e85",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ef29f42e-2d8e-4734-8217-8e5e60dc0e25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1ae4a13-1ab1-44af-a64e-c07bb00d7776",
"db_currency_id": "55bca3cb-498d-47c6-85ec-42e8d5cdcc51",
"db_language_id": "629b50c6-17bb-47b1-82e9-b0987a9fb624",
"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-08-17T05:26:39.8955503+00:00"
},
"modified_dateutc": "2026-08-17T05:26:39.8955503+00:00"
},
"equipment_model_id": "ba8c05dd-3c48-48c0-bb59-0c7b318219c9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c1914c80-fb2b-4663-bc0c-e3154c7368a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1b51fe6a-ca1e-405c-a890-74b64da895d0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "911fa482-0b6f-4d47-9355-506c198ee840",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6a6a5c88-31ff-4296-9cc8-3417197953bb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ef29f42e-2d8e-4734-8217-8e5e60dc0e25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1ae4a13-1ab1-44af-a64e-c07bb00d7776",
"db_currency_id": "55bca3cb-498d-47c6-85ec-42e8d5cdcc51",
"db_language_id": "629b50c6-17bb-47b1-82e9-b0987a9fb624",
"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-08-17T05:26:39.8955503+00:00"
},
"modified_dateutc": "2026-08-17T05:26:39.8955503+00:00"
},
"equipment_family_id": "276bd429-4be7-4c34-a721-1a4a037eeadc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1de3862b-9ee6-47a4-9a8f-0a58a4aab9cb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "74ad96f5-c6d7-46b7-91ae-9651737439e2",
"_parent_code": "sample string 6",
"sales_organization_id": "c8b98dc1-1dda-4385-903b-dacf8fca2e85",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ef29f42e-2d8e-4734-8217-8e5e60dc0e25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1ae4a13-1ab1-44af-a64e-c07bb00d7776",
"db_currency_id": "55bca3cb-498d-47c6-85ec-42e8d5cdcc51",
"db_language_id": "629b50c6-17bb-47b1-82e9-b0987a9fb624",
"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-08-17T05:26:39.8955503+00:00"
},
"modified_dateutc": "2026-08-17T05:26:39.8955503+00:00"
},
"date_in_production_since": "2026-08-17T05:26:39.8955503+00:00",
"date_out_of_production_since": "2026-08-17T05:26:39.8955503+00:00",
"date_end_support": "2026-08-17T05:26:39.8955503+00:00",
"sales_organization_id": "178e701f-edc1-4ccd-a90f-ae97f5cdf88a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ef29f42e-2d8e-4734-8217-8e5e60dc0e25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1ae4a13-1ab1-44af-a64e-c07bb00d7776",
"db_currency_id": "55bca3cb-498d-47c6-85ec-42e8d5cdcc51",
"db_language_id": "629b50c6-17bb-47b1-82e9-b0987a9fb624",
"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-08-17T05:26:39.8955503+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-08-17T05:26:39.8955503+00:00"
},
"project_status_id": "80f31e6f-5501-424d-ba2d-f09a333c418a",
"project_status_code": "sample string 10",
"project_status": {
"id": "5e3b0c5b-f6de-4bd0-9583-9a2b5d697c5a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8e4f7446-206e-450a-ba3f-5b9dd7682919",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ef29f42e-2d8e-4734-8217-8e5e60dc0e25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1ae4a13-1ab1-44af-a64e-c07bb00d7776",
"db_currency_id": "55bca3cb-498d-47c6-85ec-42e8d5cdcc51",
"db_language_id": "629b50c6-17bb-47b1-82e9-b0987a9fb624",
"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-08-17T05:26:39.8955503+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-17T05:26:39.8955503+00:00"
},
"company_id": "8710be9a-0ce7-42de-ab8a-76f1542d203b",
"company_code": "sample string 12",
"db_address_id": "89140c52-1dfa-4c96-9568-7ecc0c2dfeff",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2634aa2b-4bd0-4f5d-be8d-1cbba98700b4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e0e04142-b9a8-476b-a037-53f07a86daf5",
"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-08-17T05:26:39.8955503+00:00",
"date_create": "2026-08-17T05:26:39.8955503+00:00",
"date_update": "2026-08-17T05:26:39.8955503+00:00",
"updated_by_user_id": "19ab4d4f-86d7-4209-86ca-2c38775e55b3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-17T05:26:39.8955503+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-08-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-17T05:26:39.8955503+00:00",
"date_last_job": "2026-08-17T05:26:39.8955503+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-17T05:26:39.8955503+00:00",
"modified_dateutc": "2026-08-17T05:26:39.8955503+00:00",
"is_mobile_installation": true
},
"job_type_id": "207e226d-ee27-4a72-8b6a-94683a9abcb8",
"job_type_code": "sample string 7",
"job_type": {
"id": "9051ced4-2140-4e7c-9442-b86bfbbcdf54",
"name": "sample string 2",
"sales_organization_id": "99c3222f-1966-41f3-bf57-aa9df9e2f725",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-17T05:26:39.8955503+00:00",
"code": "sample string 7"
},
"job_priority_id": "2100e1c3-6be1-4448-9350-e2c34f61bd9b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6e7e3847-a781-4e25-a0a7-69e6f49e382e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5acd3438-46ec-41d1-979e-cbd15b7e923f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ef29f42e-2d8e-4734-8217-8e5e60dc0e25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1ae4a13-1ab1-44af-a64e-c07bb00d7776",
"db_currency_id": "55bca3cb-498d-47c6-85ec-42e8d5cdcc51",
"db_language_id": "629b50c6-17bb-47b1-82e9-b0987a9fb624",
"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-08-17T05:26:39.8955503+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-17T05:26:39.8955503+00:00"
},
"job_status_id": "5fabe796-107f-48f5-90fc-c1fc69a91a38",
"job_status_code": "sample string 11",
"db_address_id": "cc366c92-b17d-4fd3-8b8c-54d0a73d2298",
"contact_id": "e9ae609d-b1b9-45c3-a3b5-686cb98840ec",
"requested_by_company_id": "e31b9008-a495-4ff3-81d2-e09ab388ea31",
"requested_by_contact_id": "a30c0959-b7ec-4f64-a568-a893ba8e2780",
"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-08-17T05:26:39.8955503+00:00",
"due_date": "2026-08-17T05:26:39.8955503+00:00",
"date_create": "2026-08-17T05:26:39.8955503+00:00",
"date_update": "2026-08-17T05:26:39.8955503+00:00",
"date_closed": "2026-08-17T05:26:39.8955503+00:00",
"suggested_user_id": "961e1b2c-5c6c-4332-88a6-d8e1c21e63af",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6bff02ee-5f01-40bf-b497-22ec9206f34b",
"db_language_id": "1e95a4bf-c8dc-446f-aa84-23b0d252725a",
"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-08-17T05:26:39.8955503+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "aee6a9a3-8abe-42ff-bd9a-f48067823ce6",
"sales_organization": {
"id": "ef29f42e-2d8e-4734-8217-8e5e60dc0e25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1ae4a13-1ab1-44af-a64e-c07bb00d7776",
"db_currency_id": "55bca3cb-498d-47c6-85ec-42e8d5cdcc51",
"db_language_id": "629b50c6-17bb-47b1-82e9-b0987a9fb624",
"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-08-17T05:26:39.8955503+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "89f23b19-0a82-430f-888c-bf4a51b72a5f",
"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": "5020b371-3800-48fc-a45a-842fff24830a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-17T05:26:39.8955503+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ff4b2afe-cc61-4c09-a8b3-66d7868b5580"
},
"suggested_date_start": "2026-08-17T05:26:39.8955503+00:00",
"skill_id": "9bba101c-9399-446f-b173-12527db48613",
"skill_code": "sample string 32",
"skill": {
"id": "9913118b-b54c-4ea4-9e1c-a21f3b95127d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "018a1c9b-3f61-43f0-8c5a-3d9f2e2244fd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ef29f42e-2d8e-4734-8217-8e5e60dc0e25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d1ae4a13-1ab1-44af-a64e-c07bb00d7776",
"db_currency_id": "55bca3cb-498d-47c6-85ec-42e8d5cdcc51",
"db_language_id": "629b50c6-17bb-47b1-82e9-b0987a9fb624",
"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-08-17T05:26:39.8955503+00:00"
},
"modified_dateutc": "2026-08-17T05:26:39.8955503+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7028bd14-aa5b-4acb-9d40-1e786dd58c29",
"date_reported_by_company": "2026-08-17T05:26:39.9111663+00:00",
"id2": 36,
"company_id": "18093da6-a907-458c-9e58-ca41d0e4c887",
"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": "550dd405-11db-4f07-9b30-55393f282bc7",
"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-08-17T05:26:39.9111663+00:00"
},
"work_instruction_details_id": "8a281fe6-5df2-42a0-ae43-c995cee5f61c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b643d905-e1eb-4f24-a32d-344afb486934",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c525d6ae-5ce8-4836-abf7-9d9a212cc077",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-17T05:26:39.9111663+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": "860d4f79-33cb-481d-b611-b71f80bcd65c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-17T05:26:39.9111663+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.