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": "e01cc6de-0ca1-4d14-a593-e0cf7059d6ea",
"jobs_id": "ef445eb5-45c8-489b-a9e4-3180920b5384",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "72f86ab2-b230-4333-8aab-071f6f369116",
"_parent_id": "5016149a-7c78-4e11-81cb-198b7fdf82af",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b3b47bd5-7dcf-496f-80ce-926be901637c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f5260b01-de28-4f93-8f8b-e8dc60683577",
"_parent_id": "c1cd1c50-4f18-4b5f-a2f6-a49b4964fc57",
"root_parent_id": "48e6008d-633c-4465-abe1-b38bfd425522",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "198e9016-6764-4d06-a49f-d2806549a327",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4ee038bb-bed5-45fd-9aa4-da2a221ac119",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "55005aab-fb47-4309-ad9c-acaed3f2c68b",
"_parent_code": "sample string 6",
"sales_organization_id": "55c14649-748d-4a90-bc21-2f3ac921400d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e4fbd4ba-546f-4bd9-88ec-20153e87f9bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9dfa39bc-d109-478f-9649-0e41f1f7b6ac",
"db_currency_id": "4b3019b7-a9da-4f48-b010-477a30fd7eb0",
"db_language_id": "cb93a8b5-007d-4eff-9008-2dbad6905e5d",
"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-07-06T12:24:07.4413148+00:00"
},
"modified_dateutc": "2026-07-06T12:24:07.4413148+00:00"
},
"equipment_model_id": "1e8d5f07-8047-4ad3-b6ef-a75ca649b6d4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f0fc6fbd-afc4-4a17-a799-21fbec3831b7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "065f2787-6f78-44f1-a813-62dc0a8d1783",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ae994ae9-ec4f-4dd2-9749-cd2a7f87c27b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cfadde65-ac45-4046-a491-e19051bd24c8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e4fbd4ba-546f-4bd9-88ec-20153e87f9bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9dfa39bc-d109-478f-9649-0e41f1f7b6ac",
"db_currency_id": "4b3019b7-a9da-4f48-b010-477a30fd7eb0",
"db_language_id": "cb93a8b5-007d-4eff-9008-2dbad6905e5d",
"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-07-06T12:24:07.4413148+00:00"
},
"modified_dateutc": "2026-07-06T12:24:07.4413148+00:00"
},
"equipment_family_id": "b3847d16-b9d5-44e0-aa14-05fe59d95058",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4ee038bb-bed5-45fd-9aa4-da2a221ac119",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "55005aab-fb47-4309-ad9c-acaed3f2c68b",
"_parent_code": "sample string 6",
"sales_organization_id": "55c14649-748d-4a90-bc21-2f3ac921400d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e4fbd4ba-546f-4bd9-88ec-20153e87f9bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9dfa39bc-d109-478f-9649-0e41f1f7b6ac",
"db_currency_id": "4b3019b7-a9da-4f48-b010-477a30fd7eb0",
"db_language_id": "cb93a8b5-007d-4eff-9008-2dbad6905e5d",
"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-07-06T12:24:07.4413148+00:00"
},
"modified_dateutc": "2026-07-06T12:24:07.4413148+00:00"
},
"date_in_production_since": "2026-07-06T12:24:07.4413148+00:00",
"date_out_of_production_since": "2026-07-06T12:24:07.4413148+00:00",
"date_end_support": "2026-07-06T12:24:07.4413148+00:00",
"sales_organization_id": "542bff6a-57a5-4f15-9239-73244b187162",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e4fbd4ba-546f-4bd9-88ec-20153e87f9bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9dfa39bc-d109-478f-9649-0e41f1f7b6ac",
"db_currency_id": "4b3019b7-a9da-4f48-b010-477a30fd7eb0",
"db_language_id": "cb93a8b5-007d-4eff-9008-2dbad6905e5d",
"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-07-06T12:24:07.4413148+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-07-06T12:24:07.4413148+00:00"
},
"project_status_id": "979fc54a-a892-40c4-8122-4bb24e936aa1",
"project_status_code": "sample string 10",
"project_status": {
"id": "0e9ded68-278e-4a4b-8dcd-b902e8c4f55b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d3aa8998-b253-4cc9-b2aa-141db3c6dded",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e4fbd4ba-546f-4bd9-88ec-20153e87f9bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9dfa39bc-d109-478f-9649-0e41f1f7b6ac",
"db_currency_id": "4b3019b7-a9da-4f48-b010-477a30fd7eb0",
"db_language_id": "cb93a8b5-007d-4eff-9008-2dbad6905e5d",
"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-07-06T12:24:07.4413148+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-06T12:24:07.4413148+00:00"
},
"company_id": "d40cc997-084f-4495-becd-ee8d6a07afa4",
"company_code": "sample string 12",
"db_address_id": "1e098fdb-db97-4ba4-8509-aaacbdada912",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "10dbd464-c4f0-4e2d-a316-06ec35472549",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "41dba784-d7c4-4935-ad4b-9658c0fa444a",
"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-07-06T12:24:07.4413148+00:00",
"date_create": "2026-07-06T12:24:07.4413148+00:00",
"date_update": "2026-07-06T12:24:07.4413148+00:00",
"updated_by_user_id": "760dd0d5-e9b2-4edf-a3f2-a78ca8fc5172",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-06T12:24:07.4413148+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-07-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-06T12:24:07.4413148+00:00",
"date_last_job": "2026-07-06T12:24:07.4413148+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-06T12:24:07.4413148+00:00",
"modified_dateutc": "2026-07-06T12:24:07.4413148+00:00",
"is_mobile_installation": true
},
"job_type_id": "b4ab9cef-ede6-4ac0-88f9-3bb990fcfd36",
"job_type_code": "sample string 7",
"job_type": {
"id": "ce39f29d-86c7-46e1-a3af-5ddc546aa414",
"name": "sample string 2",
"sales_organization_id": "6c4db383-533d-40d4-ba06-5ecd5edb0590",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-06T12:24:07.4413148+00:00",
"code": "sample string 7"
},
"job_priority_id": "ba106586-efc6-4f2a-b2e9-30b9156b4ee3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "20e1b787-d215-40b3-874e-e70dd3956d0a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8a8eafba-7ab9-45f2-bc50-eda0d920607b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e4fbd4ba-546f-4bd9-88ec-20153e87f9bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9dfa39bc-d109-478f-9649-0e41f1f7b6ac",
"db_currency_id": "4b3019b7-a9da-4f48-b010-477a30fd7eb0",
"db_language_id": "cb93a8b5-007d-4eff-9008-2dbad6905e5d",
"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-07-06T12:24:07.4413148+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-06T12:24:07.4413148+00:00"
},
"job_status_id": "26cbaec0-272e-4c6e-a6ab-5584f2e22c2e",
"job_status_code": "sample string 11",
"db_address_id": "56e580df-4ccf-4d49-b308-ddd17cb43eee",
"contact_id": "825874ac-493f-43eb-a03e-060229d0b884",
"requested_by_company_id": "65e5cec7-5de9-4f17-a574-ab12598bd038",
"requested_by_contact_id": "247ae725-02e3-48fa-bfd7-338a60a597e9",
"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-07-06T12:24:07.4413148+00:00",
"due_date": "2026-07-06T12:24:07.4413148+00:00",
"date_create": "2026-07-06T12:24:07.4413148+00:00",
"date_update": "2026-07-06T12:24:07.4413148+00:00",
"date_closed": "2026-07-06T12:24:07.4413148+00:00",
"suggested_user_id": "50e90ccf-2093-4202-967f-407522a51e3a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5edce030-bb4a-409b-b315-e359e05eb8ea",
"db_language_id": "49f1e529-aa0c-4fff-ab59-26809348c22a",
"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-07-06T12:24:07.4413148+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "816e9b80-744d-47db-a9fd-50bdbd455907",
"sales_organization": {
"id": "e4fbd4ba-546f-4bd9-88ec-20153e87f9bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9dfa39bc-d109-478f-9649-0e41f1f7b6ac",
"db_currency_id": "4b3019b7-a9da-4f48-b010-477a30fd7eb0",
"db_language_id": "cb93a8b5-007d-4eff-9008-2dbad6905e5d",
"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-07-06T12:24:07.4413148+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "29ece14b-4a34-4efa-8304-db856aaf2050",
"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": "7fdddaff-c312-43a2-a0c8-9ee7c1504787",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-06T12:24:07.4413148+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f025e246-a806-46c4-a2ec-152f8b377cab"
},
"suggested_date_start": "2026-07-06T12:24:07.4413148+00:00",
"skill_id": "6b1df700-3474-4cc8-8ae4-48ebc6a20932",
"skill_code": "sample string 32",
"skill": {
"id": "d5e5e809-94ed-4c4c-bae4-7b2a4cc0e6e8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1d966990-ebef-49cd-b791-4aa6045a7966",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e4fbd4ba-546f-4bd9-88ec-20153e87f9bc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9dfa39bc-d109-478f-9649-0e41f1f7b6ac",
"db_currency_id": "4b3019b7-a9da-4f48-b010-477a30fd7eb0",
"db_language_id": "cb93a8b5-007d-4eff-9008-2dbad6905e5d",
"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-07-06T12:24:07.4413148+00:00"
},
"modified_dateutc": "2026-07-06T12:24:07.4413148+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7007647a-ab97-45ca-bdf4-d0229119d9d1",
"date_reported_by_company": "2026-07-06T12:24:07.4413148+00:00",
"id2": 36,
"company_id": "e9cd50f1-33a3-4174-ba10-5c89676e3b69",
"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": "20ec8bd2-52d0-464a-8ffa-9790b4cd9008",
"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-07-06T12:24:07.4413148+00:00"
},
"work_instruction_details_id": "8c0e1835-b226-4393-8cdf-db43bd336d0f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f7b84ea2-5618-49e3-aa02-2cedc8f17c8f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a94b083a-b421-4d01-af9d-bff8df63a99b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-06T12:24:07.4413148+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": "8da38202-5f4f-4aeb-9579-4a1f7ab0b834",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-06T12:24:07.4413148+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.