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": "42624c72-3b12-4eee-bc9c-383d4c4d54e2",
"jobs_id": "800a120e-567c-45dd-9206-11632176695a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5e37eafa-89a1-41ec-853e-904406dad8c8",
"_parent_id": "7628c838-d272-4680-bc1b-64cf4b652b5c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "79672e23-15dc-4333-a13f-1802b34c61f0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "68d0fa31-bb78-4cb6-890b-7a0ed6a18d19",
"_parent_id": "72b89329-6749-46c0-bf71-e12e79f97ff7",
"root_parent_id": "afd693c3-6540-4df0-a107-f40ff6bd8def",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4d136b45-8d71-4681-9c2b-5df2c84dc9f5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9a23c9a1-8aaa-431a-8f43-2cf01352bbaf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "886805c7-d633-43e4-8a4f-1ffed40dd842",
"_parent_code": "sample string 6",
"sales_organization_id": "2520e5e7-d025-4c8f-a2f1-a3b44c2546da",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "04267ab5-9b9d-4f47-99bf-351aa4331d5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "818575b0-1d2e-4fab-902e-06fac6d6216e",
"db_currency_id": "7ac512c3-7795-4c5f-aa37-634e9d3dbb6e",
"db_language_id": "ad85335c-d908-403b-8e61-93c55e0b34db",
"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-11-02T05:08:58.9686796+00:00"
},
"modified_dateutc": "2026-11-02T05:08:58.9686796+00:00"
},
"equipment_model_id": "6f388c6c-03d1-4903-a7ea-d449f8106c01",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "14b0ad01-1602-4f5d-8627-bbe30079cf8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5d1b3ca9-bba6-49bd-9148-89e2e2952908",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d20ee0f9-0b2d-4e84-9fac-79c727a4695b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5188e0b2-9703-48e8-8635-feb3c895251d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "04267ab5-9b9d-4f47-99bf-351aa4331d5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "818575b0-1d2e-4fab-902e-06fac6d6216e",
"db_currency_id": "7ac512c3-7795-4c5f-aa37-634e9d3dbb6e",
"db_language_id": "ad85335c-d908-403b-8e61-93c55e0b34db",
"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-11-02T05:08:58.9686796+00:00"
},
"modified_dateutc": "2026-11-02T05:08:58.9686796+00:00"
},
"equipment_family_id": "708e05ed-d2d9-4ad6-b258-69fb7deda666",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9a23c9a1-8aaa-431a-8f43-2cf01352bbaf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "886805c7-d633-43e4-8a4f-1ffed40dd842",
"_parent_code": "sample string 6",
"sales_organization_id": "2520e5e7-d025-4c8f-a2f1-a3b44c2546da",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "04267ab5-9b9d-4f47-99bf-351aa4331d5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "818575b0-1d2e-4fab-902e-06fac6d6216e",
"db_currency_id": "7ac512c3-7795-4c5f-aa37-634e9d3dbb6e",
"db_language_id": "ad85335c-d908-403b-8e61-93c55e0b34db",
"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-11-02T05:08:58.9686796+00:00"
},
"modified_dateutc": "2026-11-02T05:08:58.9686796+00:00"
},
"date_in_production_since": "2026-11-02T05:08:58.9686796+00:00",
"date_out_of_production_since": "2026-11-02T05:08:58.9686796+00:00",
"date_end_support": "2026-11-02T05:08:58.9686796+00:00",
"sales_organization_id": "da4ddfae-869a-41a0-8877-4259c58a0d7b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "04267ab5-9b9d-4f47-99bf-351aa4331d5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "818575b0-1d2e-4fab-902e-06fac6d6216e",
"db_currency_id": "7ac512c3-7795-4c5f-aa37-634e9d3dbb6e",
"db_language_id": "ad85335c-d908-403b-8e61-93c55e0b34db",
"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-11-02T05:08:58.9686796+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-11-02T05:08:58.9686796+00:00"
},
"project_status_id": "e6a6cb48-9da3-4d38-ba48-21ff8bbe66d2",
"project_status_code": "sample string 10",
"project_status": {
"id": "c2105d18-5e5e-494b-b8a8-6fd80ce213d8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "453ac0a5-06b6-46e3-a543-b59e2f3b34e7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "04267ab5-9b9d-4f47-99bf-351aa4331d5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "818575b0-1d2e-4fab-902e-06fac6d6216e",
"db_currency_id": "7ac512c3-7795-4c5f-aa37-634e9d3dbb6e",
"db_language_id": "ad85335c-d908-403b-8e61-93c55e0b34db",
"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-11-02T05:08:58.9686796+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-02T05:08:58.9686796+00:00"
},
"company_id": "1d1bbb64-7730-403e-b2c7-1d37db70b268",
"company_code": "sample string 12",
"db_address_id": "1672daed-09ef-4442-8714-a16a894b83ff",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5e1fd48b-f210-4d84-b2a8-2d46681edd51",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "01db5dc2-d091-4f0e-a70c-cf0edab2f279",
"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-11-02T05:08:58.9686796+00:00",
"date_create": "2026-11-02T05:08:58.9686796+00:00",
"date_update": "2026-11-02T05:08:58.9686796+00:00",
"updated_by_user_id": "50d722e6-d7f3-4a51-ae56-5cbdeb96f2dc",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-02T05:08:58.9686796+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-11-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-02T05:08:58.9686796+00:00",
"date_last_job": "2026-11-02T05:08:58.9686796+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-02T05:08:58.9686796+00:00",
"modified_dateutc": "2026-11-02T05:08:58.9686796+00:00",
"is_mobile_installation": true
},
"job_type_id": "bf26b834-de34-4702-9a81-fe5a0e152bb3",
"job_type_code": "sample string 7",
"job_type": {
"id": "da7dce7b-6cd5-48aa-bf97-e3c50049ba3f",
"name": "sample string 2",
"sales_organization_id": "c98ccf4d-469d-4787-a325-9ce22397e18a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-02T05:08:58.9686796+00:00",
"code": "sample string 7"
},
"job_priority_id": "81e83834-435f-410a-abb6-0e10a13ffd2d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8484c568-d1fb-45fc-828e-a40f0df0aeea",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ded53ed6-5289-43f8-b659-f25cf7a5e069",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "04267ab5-9b9d-4f47-99bf-351aa4331d5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "818575b0-1d2e-4fab-902e-06fac6d6216e",
"db_currency_id": "7ac512c3-7795-4c5f-aa37-634e9d3dbb6e",
"db_language_id": "ad85335c-d908-403b-8e61-93c55e0b34db",
"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-11-02T05:08:58.9686796+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-02T05:08:58.9686796+00:00"
},
"job_status_id": "95769976-1cdf-4978-aa75-703630fa5b39",
"job_status_code": "sample string 11",
"db_address_id": "44a629d4-0cfd-4818-91db-0923d8063c77",
"contact_id": "93b9996c-cb95-41c8-9c85-407815fa082d",
"requested_by_company_id": "01c50ab1-24e7-4ac8-9c4c-f076b3914a1d",
"requested_by_contact_id": "21c34566-fef4-4f0b-bd1c-871e0710f07f",
"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-11-02T05:08:58.9686796+00:00",
"due_date": "2026-11-02T05:08:58.9686796+00:00",
"date_create": "2026-11-02T05:08:58.9686796+00:00",
"date_update": "2026-11-02T05:08:58.9686796+00:00",
"date_closed": "2026-11-02T05:08:58.9686796+00:00",
"suggested_user_id": "226dab57-631f-442c-9048-c1fbf0af0f63",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "af211af4-0fc1-42d8-8179-b7557a662548",
"db_language_id": "1028139e-a3b1-4f73-b88b-4e29a75f3052",
"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-11-02T05:08:58.9686796+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "66c3b4c9-1a47-40ec-a92a-1030dc8e1709",
"sales_organization": {
"id": "04267ab5-9b9d-4f47-99bf-351aa4331d5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "818575b0-1d2e-4fab-902e-06fac6d6216e",
"db_currency_id": "7ac512c3-7795-4c5f-aa37-634e9d3dbb6e",
"db_language_id": "ad85335c-d908-403b-8e61-93c55e0b34db",
"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-11-02T05:08:58.9686796+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "03b3feb9-90e3-4e34-a981-08c2949487a5",
"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": "b2a9f8a5-9994-4a3a-a6cc-f22cb415572a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-02T05:08:58.9686796+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f31a4644-0d4a-4371-9005-ead40638084e"
},
"suggested_date_start": "2026-11-02T05:08:58.9686796+00:00",
"skill_id": "46162e1b-e6e5-4bce-afad-9e25c687b83c",
"skill_code": "sample string 32",
"skill": {
"id": "dd348235-ee8a-4c13-b293-5076562bf46a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9a6bfac2-0bb6-4ba7-aeca-5695b8adc9d9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "04267ab5-9b9d-4f47-99bf-351aa4331d5f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "818575b0-1d2e-4fab-902e-06fac6d6216e",
"db_currency_id": "7ac512c3-7795-4c5f-aa37-634e9d3dbb6e",
"db_language_id": "ad85335c-d908-403b-8e61-93c55e0b34db",
"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-11-02T05:08:58.9686796+00:00"
},
"modified_dateutc": "2026-11-02T05:08:58.9686796+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4f04737c-f824-4932-9a50-e6adbf2f001c",
"date_reported_by_company": "2026-11-02T05:08:58.9686796+00:00",
"id2": 36,
"company_id": "d259f687-537b-4589-891a-0dcab45f5768",
"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": "ed5233fb-24af-4166-8c56-75061ead1e79",
"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-11-02T05:08:58.9686796+00:00"
},
"work_instruction_details_id": "6eac35b1-9f15-45a3-8691-6db2e20a3cea",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3dee5f48-12c8-4245-a314-c3b702e493c8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "01285f9d-9d9a-4723-879f-c5350f19fb43",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-02T05:08:58.9686796+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": "9dcf2d47-ab3c-4372-b5f9-abb026297cad",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-02T05:08:58.9686796+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.