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": "81a7ff3e-1c44-4cb8-a332-2059fe3bd579",
"jobs_id": "1f86b9d3-1960-48cc-8b6f-a2ba288bf83a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b2694c55-adec-482e-b5bf-3983506f79ab",
"_parent_id": "a03e64ad-12fd-4628-92e1-a99041230ae7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e405c97d-4ea3-4aff-b9d6-bf7120938cf7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "04a5a100-5f8f-4850-a4bd-98123f813223",
"_parent_id": "89bdfa6c-589d-4f97-a9bb-299b7a882640",
"root_parent_id": "71d71c8c-9a20-42ac-a587-fcf704a29741",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e8981651-40d0-4fe2-a14f-7c3c1c47e1ce",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8aaa77e6-5092-4715-aca8-9febf3d0b3f6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8996ccd7-5502-4099-9698-dd403a60bbce",
"_parent_code": "sample string 6",
"sales_organization_id": "2c418be8-9390-4a85-a51e-cf9870bc6306",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "df5634bb-e03b-4764-ab8d-91fa4e5927d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f468176d-70ed-42ed-b884-2c80091c9d78",
"db_currency_id": "9f4bad76-f3f8-4edb-87b8-e1a25db1c765",
"db_language_id": "db174834-1e70-4d46-9ff5-089a2291bf96",
"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-09-16T22:16:23.3100253+00:00"
},
"modified_dateutc": "2025-09-16T22:16:23.3100253+00:00"
},
"equipment_model_id": "d4e69f23-46d5-43f5-9b33-d563e2bbce1c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "413aec79-b321-46ad-830d-6d7f27c9b159",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1a5994ec-ca1b-4bd9-8bfa-93ed79144117",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "696c1dc8-915e-4c19-be1b-d3d87742b3e3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "996052c5-e5d2-4a8a-8170-1b7f212ded2f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "df5634bb-e03b-4764-ab8d-91fa4e5927d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f468176d-70ed-42ed-b884-2c80091c9d78",
"db_currency_id": "9f4bad76-f3f8-4edb-87b8-e1a25db1c765",
"db_language_id": "db174834-1e70-4d46-9ff5-089a2291bf96",
"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-09-16T22:16:23.3100253+00:00"
},
"modified_dateutc": "2025-09-16T22:16:23.3100253+00:00"
},
"equipment_family_id": "3e28e22f-0c40-4cdb-ab3d-0f23ba338e2f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8aaa77e6-5092-4715-aca8-9febf3d0b3f6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8996ccd7-5502-4099-9698-dd403a60bbce",
"_parent_code": "sample string 6",
"sales_organization_id": "2c418be8-9390-4a85-a51e-cf9870bc6306",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "df5634bb-e03b-4764-ab8d-91fa4e5927d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f468176d-70ed-42ed-b884-2c80091c9d78",
"db_currency_id": "9f4bad76-f3f8-4edb-87b8-e1a25db1c765",
"db_language_id": "db174834-1e70-4d46-9ff5-089a2291bf96",
"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-09-16T22:16:23.3100253+00:00"
},
"modified_dateutc": "2025-09-16T22:16:23.3100253+00:00"
},
"date_in_production_since": "2025-09-16T22:16:23.3100253+00:00",
"date_out_of_production_since": "2025-09-16T22:16:23.3100253+00:00",
"date_end_support": "2025-09-16T22:16:23.3100253+00:00",
"sales_organization_id": "9fedcc32-bc82-40bf-9cc0-4920ea0564a8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "df5634bb-e03b-4764-ab8d-91fa4e5927d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f468176d-70ed-42ed-b884-2c80091c9d78",
"db_currency_id": "9f4bad76-f3f8-4edb-87b8-e1a25db1c765",
"db_language_id": "db174834-1e70-4d46-9ff5-089a2291bf96",
"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-09-16T22:16:23.3100253+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-09-16T22:16:23.3100253+00:00"
},
"project_status_id": "31e914e3-2265-4534-98aa-24a2875f9564",
"project_status_code": "sample string 10",
"project_status": {
"id": "c0a6bf8b-694f-48bf-9f1b-4698ae02d3c9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8d47a1ce-b072-4adf-a494-d00c690cd850",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "df5634bb-e03b-4764-ab8d-91fa4e5927d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f468176d-70ed-42ed-b884-2c80091c9d78",
"db_currency_id": "9f4bad76-f3f8-4edb-87b8-e1a25db1c765",
"db_language_id": "db174834-1e70-4d46-9ff5-089a2291bf96",
"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-09-16T22:16:23.3100253+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-16T22:16:23.3100253+00:00"
},
"company_id": "2ad06254-47df-4109-a32e-cdf9b04b856c",
"company_code": "sample string 12",
"db_address_id": "788941fd-6c25-440b-a51b-664ee6bb17af",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "219f3e15-0894-4dd6-be5c-28d44cd203f1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e17f1b6a-c02b-4eda-815d-6028eb6d323a",
"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-09-16T22:16:23.3100253+00:00",
"date_create": "2025-09-16T22:16:23.3100253+00:00",
"date_update": "2025-09-16T22:16:23.3100253+00:00",
"updated_by_user_id": "4c9f6d15-8c2f-46e4-a51d-5ce6a53ced45",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-16T22:16:23.3100253+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-09-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-16T22:16:23.3100253+00:00",
"date_last_job": "2025-09-16T22:16:23.3100253+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-16T22:16:23.3100253+00:00",
"modified_dateutc": "2025-09-16T22:16:23.3100253+00:00",
"is_mobile_installation": true
},
"job_type_id": "17903095-af34-4dbc-a519-00340bd04500",
"job_type_code": "sample string 7",
"job_type": {
"id": "76e59c13-6df1-470c-94bb-c2f41b4758e6",
"name": "sample string 2",
"sales_organization_id": "feb1e690-dc91-47b7-94fb-fa188a86183a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-16T22:16:23.3100253+00:00",
"code": "sample string 7"
},
"job_priority_id": "01e78eb3-ce53-4a2c-9966-643761f810cc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "293630dd-457e-4023-a4ad-e80360d624c4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1f7efeb1-7238-404d-84a6-51f689b960a3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "df5634bb-e03b-4764-ab8d-91fa4e5927d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f468176d-70ed-42ed-b884-2c80091c9d78",
"db_currency_id": "9f4bad76-f3f8-4edb-87b8-e1a25db1c765",
"db_language_id": "db174834-1e70-4d46-9ff5-089a2291bf96",
"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-09-16T22:16:23.3100253+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-16T22:16:23.3100253+00:00"
},
"job_status_id": "7d9a0461-e09a-4d00-b1c4-3b21a9ad0606",
"job_status_code": "sample string 11",
"db_address_id": "460de24b-ac5c-4fc7-b1d9-67956b559aae",
"contact_id": "383c18d1-2dd0-4881-9d0f-d7fdb1d4c3fe",
"requested_by_company_id": "d5e2322f-affa-43ae-b34d-3ef29ca73023",
"requested_by_contact_id": "ba429b92-be20-4df4-90d4-760c283addab",
"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-09-16T22:16:23.3100253+00:00",
"due_date": "2025-09-16T22:16:23.3100253+00:00",
"date_create": "2025-09-16T22:16:23.3100253+00:00",
"date_update": "2025-09-16T22:16:23.3100253+00:00",
"date_closed": "2025-09-16T22:16:23.3100253+00:00",
"suggested_user_id": "71605cf2-8d20-4b0e-b6d7-89c48572a5f5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "822a65c9-e20d-49bf-9886-a2f5d9587610",
"db_language_id": "aa881ccd-6a22-4ed2-858d-752eee1b7fe8",
"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-09-16T22:16:23.3100253+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "89d97f30-a50e-4c61-94f1-250b2406ffb9",
"sales_organization": {
"id": "df5634bb-e03b-4764-ab8d-91fa4e5927d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f468176d-70ed-42ed-b884-2c80091c9d78",
"db_currency_id": "9f4bad76-f3f8-4edb-87b8-e1a25db1c765",
"db_language_id": "db174834-1e70-4d46-9ff5-089a2291bf96",
"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-09-16T22:16:23.3100253+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "78081669-c4b4-4c8b-98dd-f67324051c6c",
"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": "d96d7a19-f67d-4e2e-b506-cb934fdfd538",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-16T22:16:23.3100253+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d85106d5-a431-4862-9785-de1722cc9641"
},
"suggested_date_start": "2025-09-16T22:16:23.3100253+00:00",
"skill_id": "3915c9a3-1cec-41b2-b5ae-9bd876370af9",
"skill_code": "sample string 32",
"skill": {
"id": "1c732503-f1f2-4314-a381-7bac81dd63ec",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c560f517-846f-4fd3-a15a-4aea4e51823e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "df5634bb-e03b-4764-ab8d-91fa4e5927d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f468176d-70ed-42ed-b884-2c80091c9d78",
"db_currency_id": "9f4bad76-f3f8-4edb-87b8-e1a25db1c765",
"db_language_id": "db174834-1e70-4d46-9ff5-089a2291bf96",
"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-09-16T22:16:23.3100253+00:00"
},
"modified_dateutc": "2025-09-16T22:16:23.3100253+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "22f7e948-b0f4-4bfe-b73b-590060cf34c9",
"date_reported_by_company": "2025-09-16T22:16:23.3100253+00:00",
"id2": 36,
"company_id": "421b4e92-e52b-4c01-832a-f1091ca5a18b",
"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": "3432be2b-aa74-4372-ab6e-48c7489da318",
"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-09-16T22:16:23.3100253+00:00"
},
"work_instruction_details_id": "d91ca9c1-c9f2-48fc-a67d-5f0168dbb9f2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9a43f951-6ebe-431a-8bd7-d67685e05147",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "96285f68-b5d5-4dd9-8634-0af47e03837f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-09-16T22:16:23.3100253+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": "25802d86-f4f3-4d6b-a9bc-656e33dbc11b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-09-16T22:16:23.3100253+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.