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": "94a35f49-5191-4a0a-b7ec-ab608eb8e2df",
"jobs_id": "696a8c6c-8ecc-4406-b0f7-cbb7d157c376",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8d51b061-2e5d-4a2f-8028-890124c0f07e",
"_parent_id": "49981113-e976-4624-b824-669bb3ccc2c6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6616c699-8bab-4ba8-be6c-c06463da5de9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6e1ad6e9-9503-46c0-a42a-b89d66041dba",
"_parent_id": "70fd6a3d-09a3-4ce9-a9b5-5e65a9fd56b4",
"root_parent_id": "b26ee669-c355-4294-83ac-1a7b6bc04463",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ea444dae-4145-4884-9ae7-695f19ae4307",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b11fb74c-24f0-4441-b9d7-b96271a31843",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "62b9ec89-9d6c-4247-a056-c8758c6db90d",
"_parent_code": "sample string 6",
"sales_organization_id": "3ec4c15d-205d-4052-b2c5-47cfde6953d9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e3f86d41-d316-47fd-8c88-f112d796ceea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "769d8ba8-4dbc-4550-b0fc-980f10601620",
"db_currency_id": "d0ee618e-2700-4f16-8bdb-aa398892d6b9",
"db_language_id": "13d57af2-c597-4a18-81ce-908695aff135",
"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-10T09:46:08.2398402+00:00"
},
"modified_dateutc": "2026-11-10T09:46:08.2398402+00:00"
},
"equipment_model_id": "1e5788b7-abdf-4d9f-9d97-7c5872adc5b1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4601a099-759f-4bc9-b1a5-3b55c15422aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0da81821-dd06-47f5-b2b5-db90b7303c6f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "777b550e-6f65-4dbe-b4a3-180762b1c9e9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6dbf028d-df22-4a6e-b732-7775c20a4d9b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e3f86d41-d316-47fd-8c88-f112d796ceea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "769d8ba8-4dbc-4550-b0fc-980f10601620",
"db_currency_id": "d0ee618e-2700-4f16-8bdb-aa398892d6b9",
"db_language_id": "13d57af2-c597-4a18-81ce-908695aff135",
"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-10T09:46:08.2398402+00:00"
},
"modified_dateutc": "2026-11-10T09:46:08.2398402+00:00"
},
"equipment_family_id": "62a087af-8355-4a20-9ded-be64f46cfd9c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b11fb74c-24f0-4441-b9d7-b96271a31843",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "62b9ec89-9d6c-4247-a056-c8758c6db90d",
"_parent_code": "sample string 6",
"sales_organization_id": "3ec4c15d-205d-4052-b2c5-47cfde6953d9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e3f86d41-d316-47fd-8c88-f112d796ceea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "769d8ba8-4dbc-4550-b0fc-980f10601620",
"db_currency_id": "d0ee618e-2700-4f16-8bdb-aa398892d6b9",
"db_language_id": "13d57af2-c597-4a18-81ce-908695aff135",
"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-10T09:46:08.2398402+00:00"
},
"modified_dateutc": "2026-11-10T09:46:08.2398402+00:00"
},
"date_in_production_since": "2026-11-10T09:46:08.2398402+00:00",
"date_out_of_production_since": "2026-11-10T09:46:08.2398402+00:00",
"date_end_support": "2026-11-10T09:46:08.2398402+00:00",
"sales_organization_id": "5772e488-6e66-447b-8ff6-b7cfae54e35f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e3f86d41-d316-47fd-8c88-f112d796ceea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "769d8ba8-4dbc-4550-b0fc-980f10601620",
"db_currency_id": "d0ee618e-2700-4f16-8bdb-aa398892d6b9",
"db_language_id": "13d57af2-c597-4a18-81ce-908695aff135",
"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-10T09:46:08.2398402+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-10T09:46:08.2398402+00:00"
},
"project_status_id": "0f4ed767-25d3-49fc-a2a5-8432f5a194b7",
"project_status_code": "sample string 10",
"project_status": {
"id": "f3cf3a45-7780-4b3c-ae24-ec68c5622879",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4ec39311-bd02-422d-8a4a-7f5bf76fa316",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e3f86d41-d316-47fd-8c88-f112d796ceea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "769d8ba8-4dbc-4550-b0fc-980f10601620",
"db_currency_id": "d0ee618e-2700-4f16-8bdb-aa398892d6b9",
"db_language_id": "13d57af2-c597-4a18-81ce-908695aff135",
"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-10T09:46:08.2398402+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-10T09:46:08.2398402+00:00"
},
"company_id": "25ac6842-f458-4947-9ea3-548964abb8e9",
"company_code": "sample string 12",
"db_address_id": "6a7ef63b-6dd3-4473-b10e-a21925ff2cd2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0e876037-f45b-42ae-9a4e-5417cf26dc0e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "35e93881-983f-4f08-b4e3-294f3040cd3f",
"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-10T09:46:08.2398402+00:00",
"date_create": "2026-11-10T09:46:08.2398402+00:00",
"date_update": "2026-11-10T09:46:08.2398402+00:00",
"updated_by_user_id": "8b85f408-5006-4895-a5af-6350b3c62137",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-10T09:46:08.2398402+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-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-10T09:46:08.2398402+00:00",
"date_last_job": "2026-11-10T09:46:08.2398402+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-10T09:46:08.2398402+00:00",
"modified_dateutc": "2026-11-10T09:46:08.2398402+00:00",
"is_mobile_installation": true
},
"job_type_id": "f7d8d8be-60a0-4fa5-bec5-1dd2647b426c",
"job_type_code": "sample string 7",
"job_type": {
"id": "b62ca46d-b2c4-48cf-888e-4fac65c6342b",
"name": "sample string 2",
"sales_organization_id": "68a2559b-e1c7-42d2-94d6-2332f2f1bb40",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-10T09:46:08.2398402+00:00",
"code": "sample string 7"
},
"job_priority_id": "581a93f4-93e3-40d6-847c-98fc261bba7c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "68988176-70c6-4be5-9163-0bc3edc12005",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7f803e5d-bc42-4294-bd2f-48cc2bf4cac2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e3f86d41-d316-47fd-8c88-f112d796ceea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "769d8ba8-4dbc-4550-b0fc-980f10601620",
"db_currency_id": "d0ee618e-2700-4f16-8bdb-aa398892d6b9",
"db_language_id": "13d57af2-c597-4a18-81ce-908695aff135",
"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-10T09:46:08.2398402+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-10T09:46:08.2398402+00:00"
},
"job_status_id": "0250f146-083f-48a7-9afc-0a86a177f3ff",
"job_status_code": "sample string 11",
"db_address_id": "f5dd80d9-f053-4834-af0a-bc78f81d6199",
"contact_id": "ff64ce7f-fff4-4ae0-842f-c9c983cc7a03",
"requested_by_company_id": "7cb5fb16-5fb1-4675-9363-e34166ad1787",
"requested_by_contact_id": "6820a963-f339-4156-b1e4-3598e44a1165",
"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-10T09:46:08.2398402+00:00",
"due_date": "2026-11-10T09:46:08.2398402+00:00",
"date_create": "2026-11-10T09:46:08.2398402+00:00",
"date_update": "2026-11-10T09:46:08.2398402+00:00",
"date_closed": "2026-11-10T09:46:08.2398402+00:00",
"suggested_user_id": "e889464c-612b-4e93-bd21-90ab38e1fcf6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8efd172f-42ea-4a14-882b-f964ae6b3b04",
"db_language_id": "e2e0f5fd-e6ac-44d4-b58a-c04ccc6af657",
"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-10T09:46:08.2398402+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4e4d2c41-ad57-4bd6-9aaa-03bfa0c996b1",
"sales_organization": {
"id": "e3f86d41-d316-47fd-8c88-f112d796ceea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "769d8ba8-4dbc-4550-b0fc-980f10601620",
"db_currency_id": "d0ee618e-2700-4f16-8bdb-aa398892d6b9",
"db_language_id": "13d57af2-c597-4a18-81ce-908695aff135",
"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-10T09:46:08.2398402+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "51b0bd59-d3dc-4525-b427-1afad5242f3f",
"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": "8ed1be13-ebff-47e9-86b6-b6b1fe441550",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-10T09:46:08.2398402+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "09f67c15-5994-4ad4-8d17-22851354b95b"
},
"suggested_date_start": "2026-11-10T09:46:08.2398402+00:00",
"skill_id": "af5c83b4-88ba-482e-9967-a4c8fbb491c2",
"skill_code": "sample string 32",
"skill": {
"id": "274d1484-7ae9-482f-9f27-af73434e3133",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cf39bd1f-6f3a-4558-8e48-0dc987ea8464",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e3f86d41-d316-47fd-8c88-f112d796ceea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "769d8ba8-4dbc-4550-b0fc-980f10601620",
"db_currency_id": "d0ee618e-2700-4f16-8bdb-aa398892d6b9",
"db_language_id": "13d57af2-c597-4a18-81ce-908695aff135",
"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-10T09:46:08.2398402+00:00"
},
"modified_dateutc": "2026-11-10T09:46:08.2398402+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "25702e3c-147f-455e-bd08-b16217a44f6f",
"date_reported_by_company": "2026-11-10T09:46:08.2398402+00:00",
"id2": 36,
"company_id": "373f8dc2-a73b-47ac-bfa3-eb8a4b0159eb",
"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": "8317d049-df33-47e5-8138-8d33d315fe59",
"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-10T09:46:08.2398402+00:00"
},
"work_instruction_details_id": "5dfec4fe-0fa8-42f2-9692-6a33c0399819",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "348cf3ab-850f-40a2-8f5e-ae7206cd4a2c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "13cdc571-3fe1-4b40-b90d-92fa5c360413",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-10T09:46:08.2587882+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": "b4ff6c16-e4cf-4f0e-83de-0a1e09dcaee1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-10T09:46:08.2587882+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.