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": "1576b633-16db-4ace-80a7-9553e8cb1658",
"jobs_id": "697f1cdd-0361-40e1-9649-702e7a07ed44",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "730a6543-8ead-483b-b105-24de0c895c2b",
"_parent_id": "eb5881e1-c16a-4915-a095-fa23c9688bf0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2a89585f-b0a4-4ceb-8659-5908b2d81464",
"project_reference_back_office": "sample string 5",
"project": {
"id": "805abe75-ad7b-4fee-8355-3155582e8955",
"_parent_id": "390c31f1-3096-48f0-902e-a466cda2db8a",
"root_parent_id": "7f9c0209-7d18-4b67-8756-0233ae2d0060",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6723defe-6ab0-4c4e-8551-584d20f89c65",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "68137c42-a848-4074-94c6-75a48ce1aee0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b0f82df9-cbb9-4193-9528-755bbb437296",
"_parent_code": "sample string 6",
"sales_organization_id": "6adc0ba7-93b4-4335-ab05-31e7861a3328",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "454037ea-efe6-4d20-8232-6a481b2aa72c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d953ec4-9321-4b45-b14d-12542ea71de3",
"db_currency_id": "fca1eb15-cf97-4048-ae7d-58daf42509c3",
"db_language_id": "2ab07230-c114-4057-aed7-ab82997ad491",
"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-10-17T15:43:55.3007795+00:00"
},
"modified_dateutc": "2026-10-17T15:43:55.3007795+00:00"
},
"equipment_model_id": "c20cdc2e-432b-4dc4-9aa7-263dac5061ad",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f5912dd9-ac0c-425c-8808-c2a83abcfe11",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2b360810-e3c8-4aa3-91f8-4aa882100079",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "faabcd45-29b4-401d-9939-38bd409d2740",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a98ae26a-ecba-4246-8470-311282a4ed99",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "454037ea-efe6-4d20-8232-6a481b2aa72c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d953ec4-9321-4b45-b14d-12542ea71de3",
"db_currency_id": "fca1eb15-cf97-4048-ae7d-58daf42509c3",
"db_language_id": "2ab07230-c114-4057-aed7-ab82997ad491",
"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-10-17T15:43:55.3007795+00:00"
},
"modified_dateutc": "2026-10-17T15:43:55.312247+00:00"
},
"equipment_family_id": "32fff643-c469-42ab-8e57-289881b4ad0d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "68137c42-a848-4074-94c6-75a48ce1aee0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b0f82df9-cbb9-4193-9528-755bbb437296",
"_parent_code": "sample string 6",
"sales_organization_id": "6adc0ba7-93b4-4335-ab05-31e7861a3328",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "454037ea-efe6-4d20-8232-6a481b2aa72c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d953ec4-9321-4b45-b14d-12542ea71de3",
"db_currency_id": "fca1eb15-cf97-4048-ae7d-58daf42509c3",
"db_language_id": "2ab07230-c114-4057-aed7-ab82997ad491",
"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-10-17T15:43:55.3007795+00:00"
},
"modified_dateutc": "2026-10-17T15:43:55.3007795+00:00"
},
"date_in_production_since": "2026-10-17T15:43:55.312247+00:00",
"date_out_of_production_since": "2026-10-17T15:43:55.312247+00:00",
"date_end_support": "2026-10-17T15:43:55.312247+00:00",
"sales_organization_id": "5f683a0f-09f9-4f9c-8cdc-116710314f97",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "454037ea-efe6-4d20-8232-6a481b2aa72c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d953ec4-9321-4b45-b14d-12542ea71de3",
"db_currency_id": "fca1eb15-cf97-4048-ae7d-58daf42509c3",
"db_language_id": "2ab07230-c114-4057-aed7-ab82997ad491",
"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-10-17T15:43:55.3007795+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-10-17T15:43:55.312247+00:00"
},
"project_status_id": "1c713cbd-3136-4248-8252-83c46f8d2eb4",
"project_status_code": "sample string 10",
"project_status": {
"id": "ecc789df-95fd-4e11-9686-0e78545e1f6c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c3746005-7fcb-407a-a703-380f6c94375f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "454037ea-efe6-4d20-8232-6a481b2aa72c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d953ec4-9321-4b45-b14d-12542ea71de3",
"db_currency_id": "fca1eb15-cf97-4048-ae7d-58daf42509c3",
"db_language_id": "2ab07230-c114-4057-aed7-ab82997ad491",
"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-10-17T15:43:55.3007795+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-17T15:43:55.312247+00:00"
},
"company_id": "01d70436-97c0-4de5-a548-4d867bb2a428",
"company_code": "sample string 12",
"db_address_id": "d1b1f5d1-8092-4fe9-bf35-571a49677d2c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9c29be49-e352-4a0f-a908-71885b6245cf",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "05048f89-0bb1-4237-ad27-d93a29ba308e",
"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-10-17T15:43:55.312247+00:00",
"date_create": "2026-10-17T15:43:55.312247+00:00",
"date_update": "2026-10-17T15:43:55.312247+00:00",
"updated_by_user_id": "9781af56-3803-4dd5-9f4c-9c6fc6ef50ae",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-17T15:43:55.312247+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-10-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-17T15:43:55.312247+00:00",
"date_last_job": "2026-10-17T15:43:55.312247+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-17T15:43:55.312247+00:00",
"modified_dateutc": "2026-10-17T15:43:55.312247+00:00",
"is_mobile_installation": true
},
"job_type_id": "784c1b2a-6452-4ca2-870c-f5c2e7f941e0",
"job_type_code": "sample string 7",
"job_type": {
"id": "6e9a71ba-c59c-41d5-bd08-baac61377b99",
"name": "sample string 2",
"sales_organization_id": "1af36b94-7062-474d-86a4-a354652a2cbf",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-17T15:43:55.312247+00:00",
"code": "sample string 7"
},
"job_priority_id": "9bf793a9-f0b0-49d7-8e78-b3e306aa7dc3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "90d6562f-beb5-4f61-98dc-a6794431b777",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0f1f16d1-4ed5-40d7-9faf-631affd0bdbe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "454037ea-efe6-4d20-8232-6a481b2aa72c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d953ec4-9321-4b45-b14d-12542ea71de3",
"db_currency_id": "fca1eb15-cf97-4048-ae7d-58daf42509c3",
"db_language_id": "2ab07230-c114-4057-aed7-ab82997ad491",
"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-10-17T15:43:55.3007795+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-17T15:43:55.312247+00:00"
},
"job_status_id": "d84bb84f-02f0-470f-8ef7-cfcaa105a693",
"job_status_code": "sample string 11",
"db_address_id": "f769afe3-7a82-40ba-a83e-bc0bb9e2dd0e",
"contact_id": "6f0fcf81-45d3-4c4f-bdde-83711b801fd9",
"requested_by_company_id": "62953d21-d2f1-45ef-8e06-6f5eb5702420",
"requested_by_contact_id": "dc9f47bc-56f8-4e68-af6b-26dd02679ae4",
"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-10-17T15:43:55.312247+00:00",
"due_date": "2026-10-17T15:43:55.312247+00:00",
"date_create": "2026-10-17T15:43:55.312247+00:00",
"date_update": "2026-10-17T15:43:55.312247+00:00",
"date_closed": "2026-10-17T15:43:55.312247+00:00",
"suggested_user_id": "503eeb8a-2758-44e2-9f07-13814b51c2ab",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "aa15c3b7-cc79-4964-9dd0-da08ab115562",
"db_language_id": "22744595-fcd9-4388-b96e-b6658572677a",
"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-10-17T15:43:55.312247+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "362945dd-9fc4-4aff-8282-cf39bd840e86",
"sales_organization": {
"id": "454037ea-efe6-4d20-8232-6a481b2aa72c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d953ec4-9321-4b45-b14d-12542ea71de3",
"db_currency_id": "fca1eb15-cf97-4048-ae7d-58daf42509c3",
"db_language_id": "2ab07230-c114-4057-aed7-ab82997ad491",
"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-10-17T15:43:55.3007795+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "81ba79f5-a491-4e82-9389-a8b6fde0b727",
"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": "4b7c75ba-6ea3-445f-95a6-6b05f652c2d1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-17T15:43:55.312247+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "de98e4bd-2870-4cf8-8481-af59ee1b04c6"
},
"suggested_date_start": "2026-10-17T15:43:55.312247+00:00",
"skill_id": "c8c5e442-01e7-4116-9138-24ee9350fbe0",
"skill_code": "sample string 32",
"skill": {
"id": "5e277332-763b-43be-802a-980e30a6a30c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c46b6d18-653f-4c35-bcc5-c5edd68633fa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "454037ea-efe6-4d20-8232-6a481b2aa72c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d953ec4-9321-4b45-b14d-12542ea71de3",
"db_currency_id": "fca1eb15-cf97-4048-ae7d-58daf42509c3",
"db_language_id": "2ab07230-c114-4057-aed7-ab82997ad491",
"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-10-17T15:43:55.3007795+00:00"
},
"modified_dateutc": "2026-10-17T15:43:55.312247+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "77f5dfde-b184-4f70-90b9-b8d84811e9b0",
"date_reported_by_company": "2026-10-17T15:43:55.312247+00:00",
"id2": 36,
"company_id": "7519c6cb-6c9e-49e5-bcca-4531a0fd10f9",
"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": "f3770b8b-0cab-4602-b6e2-ab01e503172b",
"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-10-17T15:43:55.312247+00:00"
},
"work_instruction_details_id": "249605e4-c28b-4b65-9e5e-ee0ff5d2d31c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bf4c2344-361f-492e-8729-2beac62bff5b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3b961e04-dcf9-4bf9-8d1d-045244e63224",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-17T15:43:55.312247+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": "224ac3dd-f2c1-424e-9e5d-ffee516b89da",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-17T15:43:55.312247+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.