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": "4ed226be-3c24-4849-9bcc-8f3daec7fea9",
"jobs_id": "5925b559-3f10-406c-9663-181bfb7ab642",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6a9e83ac-a77c-4d7f-97fc-fe9428ae61be",
"_parent_id": "87844864-beb3-4403-b696-f21386ee9c14",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4f49a190-4ebf-416a-8bf1-9c85ca8e7bac",
"project_reference_back_office": "sample string 5",
"project": {
"id": "52579e5b-f54f-45c6-b0a8-b8d75af91a5c",
"_parent_id": "847321cd-b7ec-435c-8b2d-669415a2d22b",
"root_parent_id": "954bfdc8-30cc-47ec-87ed-fd9b1edccdbd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "761aa95d-0ee3-4537-bd59-46331d58bff3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "54ee1555-a741-402c-84ca-8c73443a1c15",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1bb11b8d-f1ac-4ff0-957a-f094b4a20fbe",
"_parent_code": "sample string 6",
"sales_organization_id": "d6324494-e128-494e-ade7-655350836a05",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f2de2710-936a-4125-abde-8e073522004f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95ed233c-15d5-43a6-ab0d-c6b8f9b63f3f",
"db_currency_id": "d957dcf8-09f4-4150-9cc5-7f1b471cec9d",
"db_language_id": "9a24b120-fb93-4e11-b720-9786cd074645",
"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-09-10T05:03:37.7857399+00:00"
},
"modified_dateutc": "2026-09-10T05:03:37.7857399+00:00"
},
"equipment_model_id": "e2ad1ae9-c862-4b32-8d7b-7ce1ee603e26",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "aeca08af-bda8-46de-af50-d142563c4dc4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5b20cda5-a9a1-4bba-8031-041b04f049d5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d92cf63c-a1eb-48ce-bb7b-4148dc5c8529",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a813e2ef-4d2d-47af-a186-f107ec50744b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f2de2710-936a-4125-abde-8e073522004f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95ed233c-15d5-43a6-ab0d-c6b8f9b63f3f",
"db_currency_id": "d957dcf8-09f4-4150-9cc5-7f1b471cec9d",
"db_language_id": "9a24b120-fb93-4e11-b720-9786cd074645",
"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-09-10T05:03:37.7857399+00:00"
},
"modified_dateutc": "2026-09-10T05:03:37.7857399+00:00"
},
"equipment_family_id": "eb1d94c4-7d9b-4f81-9f8e-5f698669c0bb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "54ee1555-a741-402c-84ca-8c73443a1c15",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1bb11b8d-f1ac-4ff0-957a-f094b4a20fbe",
"_parent_code": "sample string 6",
"sales_organization_id": "d6324494-e128-494e-ade7-655350836a05",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f2de2710-936a-4125-abde-8e073522004f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95ed233c-15d5-43a6-ab0d-c6b8f9b63f3f",
"db_currency_id": "d957dcf8-09f4-4150-9cc5-7f1b471cec9d",
"db_language_id": "9a24b120-fb93-4e11-b720-9786cd074645",
"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-09-10T05:03:37.7857399+00:00"
},
"modified_dateutc": "2026-09-10T05:03:37.7857399+00:00"
},
"date_in_production_since": "2026-09-10T05:03:37.7857399+00:00",
"date_out_of_production_since": "2026-09-10T05:03:37.7857399+00:00",
"date_end_support": "2026-09-10T05:03:37.7857399+00:00",
"sales_organization_id": "68a28b89-1e35-4108-a533-51840b513ba1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f2de2710-936a-4125-abde-8e073522004f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95ed233c-15d5-43a6-ab0d-c6b8f9b63f3f",
"db_currency_id": "d957dcf8-09f4-4150-9cc5-7f1b471cec9d",
"db_language_id": "9a24b120-fb93-4e11-b720-9786cd074645",
"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-09-10T05:03:37.7857399+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-09-10T05:03:37.7857399+00:00"
},
"project_status_id": "d00bb7ff-6114-4e24-9e65-fa0b22a1e1d1",
"project_status_code": "sample string 10",
"project_status": {
"id": "b7450bad-e5f5-4aa2-b5ad-f469c3271de8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "95c674f1-9def-4824-9ca9-b5e55ac57454",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f2de2710-936a-4125-abde-8e073522004f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95ed233c-15d5-43a6-ab0d-c6b8f9b63f3f",
"db_currency_id": "d957dcf8-09f4-4150-9cc5-7f1b471cec9d",
"db_language_id": "9a24b120-fb93-4e11-b720-9786cd074645",
"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-09-10T05:03:37.7857399+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-10T05:03:37.7857399+00:00"
},
"company_id": "14a6b881-4eef-4a88-b533-1d0e5e82c18e",
"company_code": "sample string 12",
"db_address_id": "710c916f-c764-4d85-a395-e89288870b4f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c91e0c8e-e784-464a-b931-a27fababc0db",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ff72f512-de10-4cdd-b827-42817828fbbb",
"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-09-10T05:03:37.7857399+00:00",
"date_create": "2026-09-10T05:03:37.7857399+00:00",
"date_update": "2026-09-10T05:03:37.7857399+00:00",
"updated_by_user_id": "b190def2-a910-4d60-a400-1feed9837ca2",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-10T05:03:37.7857399+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-09-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-10T05:03:37.7857399+00:00",
"date_last_job": "2026-09-10T05:03:37.7857399+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-10T05:03:37.7857399+00:00",
"modified_dateutc": "2026-09-10T05:03:37.7857399+00:00",
"is_mobile_installation": true
},
"job_type_id": "9a9b5faa-2f05-4f10-9a6f-e5bc98d82680",
"job_type_code": "sample string 7",
"job_type": {
"id": "9d766bad-dcee-4540-aefe-671de70a3b3a",
"name": "sample string 2",
"sales_organization_id": "87d0543b-31c1-480b-ad01-2eeb127eaf3d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-10T05:03:37.7857399+00:00",
"code": "sample string 7"
},
"job_priority_id": "120e28ff-24c3-4d18-8a6c-a47b183a9065",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8d35322b-3f2c-46af-8064-23ba91a30011",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f179bdf0-bafd-46ae-93dd-d5195f121db1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f2de2710-936a-4125-abde-8e073522004f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95ed233c-15d5-43a6-ab0d-c6b8f9b63f3f",
"db_currency_id": "d957dcf8-09f4-4150-9cc5-7f1b471cec9d",
"db_language_id": "9a24b120-fb93-4e11-b720-9786cd074645",
"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-09-10T05:03:37.7857399+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-10T05:03:37.7857399+00:00"
},
"job_status_id": "b014542e-4621-4b19-b1f7-140aeb30cba7",
"job_status_code": "sample string 11",
"db_address_id": "3c231ee6-a79e-44e2-8bac-ba3f2ccf99c0",
"contact_id": "0333e4c5-9b64-4d8a-bbed-e089919ac131",
"requested_by_company_id": "e20e42bb-9e9e-4e31-9102-9165ab61dcdd",
"requested_by_contact_id": "45321418-8cdd-4953-ac5b-28ff42fbf5bd",
"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-09-10T05:03:37.7857399+00:00",
"due_date": "2026-09-10T05:03:37.7857399+00:00",
"date_create": "2026-09-10T05:03:37.7857399+00:00",
"date_update": "2026-09-10T05:03:37.7857399+00:00",
"date_closed": "2026-09-10T05:03:37.7857399+00:00",
"suggested_user_id": "b403322b-20ef-4029-8103-41d44fecaf98",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f9bb20b5-d9be-4bf2-b1f0-0f1d38a3bc48",
"db_language_id": "99d32e07-a6d4-4e98-abc9-d0a5445eeecb",
"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-09-10T05:03:37.7857399+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "06e57275-1618-4f75-866a-741a63eb9ae9",
"sales_organization": {
"id": "f2de2710-936a-4125-abde-8e073522004f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95ed233c-15d5-43a6-ab0d-c6b8f9b63f3f",
"db_currency_id": "d957dcf8-09f4-4150-9cc5-7f1b471cec9d",
"db_language_id": "9a24b120-fb93-4e11-b720-9786cd074645",
"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-09-10T05:03:37.7857399+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "90140e02-77d1-45df-8a26-3698b0c7cfbc",
"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": "282c2b1a-65e4-493b-a137-01ef8ae3c75a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-10T05:03:37.7857399+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9fb7ba07-2169-4045-b41b-b2893d1296f3"
},
"suggested_date_start": "2026-09-10T05:03:37.7857399+00:00",
"skill_id": "e18d26b5-3dc7-4fd5-80fb-f5456668dfb4",
"skill_code": "sample string 32",
"skill": {
"id": "d29afac2-641d-41ce-a8b1-f0e214f6f2b5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d989a1f7-9393-4df2-a2ee-ecbfdf6e0b14",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f2de2710-936a-4125-abde-8e073522004f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "95ed233c-15d5-43a6-ab0d-c6b8f9b63f3f",
"db_currency_id": "d957dcf8-09f4-4150-9cc5-7f1b471cec9d",
"db_language_id": "9a24b120-fb93-4e11-b720-9786cd074645",
"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-09-10T05:03:37.7857399+00:00"
},
"modified_dateutc": "2026-09-10T05:03:37.7857399+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c16746c3-3d32-4ed0-b192-f0a6aa5582c4",
"date_reported_by_company": "2026-09-10T05:03:37.7857399+00:00",
"id2": 36,
"company_id": "b298d64b-d8d6-46b3-b45c-c1000ed535a4",
"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": "26bcba78-a953-4395-b622-bc7f7565b610",
"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-09-10T05:03:37.7857399+00:00"
},
"work_instruction_details_id": "86212944-4bf7-4c26-9b32-7219d0a1fee0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "14c2e44e-ce47-42cb-9a90-b0e974e91922",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "36dca2f2-e628-4fef-a0db-99717b582aa6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-10T05:03:37.7857399+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": "e0976f4e-6e63-4b51-a8e5-1ff3fa9b67e9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-10T05:03:37.7857399+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.