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": "f1a5137c-74bf-4bd1-9661-2976ae10021a",
"jobs_id": "742b63da-f559-4eb8-8ca7-63d0efe6188f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8905884d-5d66-45d5-8bc3-dbfd8b8ba205",
"_parent_id": "b6f7692e-02ba-40d1-a2c4-4a6a7e8ebe47",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9ba6841d-83da-4275-81ea-4c996729e118",
"project_reference_back_office": "sample string 5",
"project": {
"id": "06e09711-939b-4c50-a028-27428a121ddb",
"_parent_id": "291feb89-c959-4f71-a9a6-16da75e040e5",
"root_parent_id": "310bc19f-3a7e-401d-b21a-0b9a2af5212e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "60c10c98-b897-43eb-9605-4aa0ee3e4aad",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "230ee856-4e91-49e7-a112-4f525733622d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5af38d5b-ad44-49de-b56e-a25f200da2a1",
"_parent_code": "sample string 6",
"sales_organization_id": "39497516-b8d2-4527-8222-bda27870b338",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "41172dd0-fb37-4db1-8e4e-e15c882983b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb504bb6-751d-4205-854a-4d4ab881aaac",
"db_currency_id": "c8dd53fe-d47f-46ae-93d6-88ff92acf8a8",
"db_language_id": "4ef29015-51e0-4b8f-82f9-667516fa78fb",
"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-05-23T05:04:41.8666878+00:00"
},
"modified_dateutc": "2026-05-23T05:04:41.8666878+00:00"
},
"equipment_model_id": "0516665e-10fb-406f-9bb0-06609ddd1e46",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f6782c65-cede-472c-a608-0242cc042482",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6ad76cc5-c3e4-482a-bf1b-ce9f94659e4e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5370d9f6-c1b9-4668-bf2c-dea1581521ee",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1d4f1e00-ac35-4861-b2f0-d90b2529c44b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "41172dd0-fb37-4db1-8e4e-e15c882983b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb504bb6-751d-4205-854a-4d4ab881aaac",
"db_currency_id": "c8dd53fe-d47f-46ae-93d6-88ff92acf8a8",
"db_language_id": "4ef29015-51e0-4b8f-82f9-667516fa78fb",
"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-05-23T05:04:41.8666878+00:00"
},
"modified_dateutc": "2026-05-23T05:04:41.8666878+00:00"
},
"equipment_family_id": "32aba267-baaf-43ac-8359-ca9777d6e254",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "230ee856-4e91-49e7-a112-4f525733622d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5af38d5b-ad44-49de-b56e-a25f200da2a1",
"_parent_code": "sample string 6",
"sales_organization_id": "39497516-b8d2-4527-8222-bda27870b338",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "41172dd0-fb37-4db1-8e4e-e15c882983b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb504bb6-751d-4205-854a-4d4ab881aaac",
"db_currency_id": "c8dd53fe-d47f-46ae-93d6-88ff92acf8a8",
"db_language_id": "4ef29015-51e0-4b8f-82f9-667516fa78fb",
"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-05-23T05:04:41.8666878+00:00"
},
"modified_dateutc": "2026-05-23T05:04:41.8666878+00:00"
},
"date_in_production_since": "2026-05-23T05:04:41.8666878+00:00",
"date_out_of_production_since": "2026-05-23T05:04:41.8666878+00:00",
"date_end_support": "2026-05-23T05:04:41.8666878+00:00",
"sales_organization_id": "a7ac69bb-fb55-4dfe-811b-20ddd51a64ea",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "41172dd0-fb37-4db1-8e4e-e15c882983b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb504bb6-751d-4205-854a-4d4ab881aaac",
"db_currency_id": "c8dd53fe-d47f-46ae-93d6-88ff92acf8a8",
"db_language_id": "4ef29015-51e0-4b8f-82f9-667516fa78fb",
"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-05-23T05:04:41.8666878+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-05-23T05:04:41.8666878+00:00"
},
"project_status_id": "98deefe2-7570-4c64-90b6-495deb221785",
"project_status_code": "sample string 10",
"project_status": {
"id": "ef873487-84f9-4f93-a929-e5d1957e067e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7dbe89ae-c346-4b52-aedb-1932ef3a3f1a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "41172dd0-fb37-4db1-8e4e-e15c882983b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb504bb6-751d-4205-854a-4d4ab881aaac",
"db_currency_id": "c8dd53fe-d47f-46ae-93d6-88ff92acf8a8",
"db_language_id": "4ef29015-51e0-4b8f-82f9-667516fa78fb",
"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-05-23T05:04:41.8666878+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-23T05:04:41.8666878+00:00"
},
"company_id": "5535b679-fcd8-4456-88fc-e0602b0a7028",
"company_code": "sample string 12",
"db_address_id": "7ebc1187-7235-4327-843b-3173a69342ca",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a742954e-d7ba-4aa8-9306-1c248775efc1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e8d58ca4-2032-4c54-a710-1e30bf48d250",
"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-05-23T05:04:41.8666878+00:00",
"date_create": "2026-05-23T05:04:41.8666878+00:00",
"date_update": "2026-05-23T05:04:41.8666878+00:00",
"updated_by_user_id": "afdef705-b093-403e-a6c2-f9745937b9f9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-23T05:04:41.8666878+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-05-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-23T05:04:41.8666878+00:00",
"date_last_job": "2026-05-23T05:04:41.8666878+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-23T05:04:41.8666878+00:00",
"modified_dateutc": "2026-05-23T05:04:41.8666878+00:00",
"is_mobile_installation": true
},
"job_type_id": "812565dc-4343-4f11-b27c-57dc84ed7096",
"job_type_code": "sample string 7",
"job_type": {
"id": "d900a087-5cce-4b6b-96a0-276b59b4a2c7",
"name": "sample string 2",
"sales_organization_id": "0075719f-92b4-4e20-a187-e400d92895c9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-23T05:04:41.8823145+00:00",
"code": "sample string 7"
},
"job_priority_id": "47d11c76-59d1-436b-8871-860010d3c181",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7a11c03e-db91-4854-a663-b5d5715d92d4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f5e310bd-eeff-423a-a708-43513b05c259",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "41172dd0-fb37-4db1-8e4e-e15c882983b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb504bb6-751d-4205-854a-4d4ab881aaac",
"db_currency_id": "c8dd53fe-d47f-46ae-93d6-88ff92acf8a8",
"db_language_id": "4ef29015-51e0-4b8f-82f9-667516fa78fb",
"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-05-23T05:04:41.8666878+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-23T05:04:41.8823145+00:00"
},
"job_status_id": "06e20823-e1a7-40e5-9c24-19060d1b7b86",
"job_status_code": "sample string 11",
"db_address_id": "847792c4-bfb2-4fa7-b247-e2ce26c4a51a",
"contact_id": "aa3c3eb2-a23c-411a-99a6-8edbcc6bd09b",
"requested_by_company_id": "62e059c8-ff52-4642-8fef-ec97143310dd",
"requested_by_contact_id": "ba9ad83d-4e32-4966-9a30-989a46e59436",
"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-05-23T05:04:41.8823145+00:00",
"due_date": "2026-05-23T05:04:41.8823145+00:00",
"date_create": "2026-05-23T05:04:41.8823145+00:00",
"date_update": "2026-05-23T05:04:41.8823145+00:00",
"date_closed": "2026-05-23T05:04:41.8823145+00:00",
"suggested_user_id": "78c18636-9c0b-4669-9493-d8a3d3b13899",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5a83a515-11e8-451d-95a6-e5ea0c563922",
"db_language_id": "b086900e-e644-42fa-83e3-e4cb839fa9dc",
"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-05-23T05:04:41.8823145+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7f3a010f-6ad6-44b2-a54d-93e365d9a7fe",
"sales_organization": {
"id": "41172dd0-fb37-4db1-8e4e-e15c882983b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb504bb6-751d-4205-854a-4d4ab881aaac",
"db_currency_id": "c8dd53fe-d47f-46ae-93d6-88ff92acf8a8",
"db_language_id": "4ef29015-51e0-4b8f-82f9-667516fa78fb",
"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-05-23T05:04:41.8666878+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7f592273-2c1a-4d82-b20e-7e4b06a6a787",
"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": "f535e032-1c82-4892-abbf-c3f8a0d18c5b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-23T05:04:41.8823145+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "85a106ae-eacd-46fa-9ff0-ff6257b99fb7"
},
"suggested_date_start": "2026-05-23T05:04:41.8823145+00:00",
"skill_id": "6c21178f-80c2-41e4-93d5-c5982db5055a",
"skill_code": "sample string 32",
"skill": {
"id": "1446868d-b792-4ba0-b76b-2b87cab9c1b1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d68c8d6f-0e07-41c5-ae71-e097cf4b415d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "41172dd0-fb37-4db1-8e4e-e15c882983b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eb504bb6-751d-4205-854a-4d4ab881aaac",
"db_currency_id": "c8dd53fe-d47f-46ae-93d6-88ff92acf8a8",
"db_language_id": "4ef29015-51e0-4b8f-82f9-667516fa78fb",
"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-05-23T05:04:41.8666878+00:00"
},
"modified_dateutc": "2026-05-23T05:04:41.8823145+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c819195c-9b0d-4441-80d4-2e71dce3adaf",
"date_reported_by_company": "2026-05-23T05:04:41.8823145+00:00",
"id2": 36,
"company_id": "a0037ffa-d5dc-4dca-8626-77b856022762",
"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": "3f57fc40-7f7f-4cfc-a9be-9150f2a5f4f6",
"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-05-23T05:04:41.8823145+00:00"
},
"work_instruction_details_id": "a248adb7-e33e-432e-82c7-bfb836946424",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "15f557f7-42ee-4304-b816-2ecbf9d0ce05",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e71aa597-bb9e-44e2-921d-f53c2c059484",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-23T05:04:41.8823145+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": "a2cc187e-8992-4251-9165-48c75e82f0ff",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-23T05:04:41.8823145+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.