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": "43068298-5f7b-4089-a0f1-11a88a657647",
"jobs_id": "ea782645-e159-4ba8-9f29-a167657b999a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "239b6bc5-bf9b-4d24-a1d2-c9bc605366af",
"_parent_id": "4c540891-7f27-46da-9508-a228e8f543da",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e451b7dc-b401-4232-bccf-7fb07ffba83e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "be167899-5caa-4151-a4dc-5efc865813b4",
"_parent_id": "90da8a68-778e-48eb-a35c-b9874cfbc917",
"root_parent_id": "8cae6471-f497-405f-b518-9dfd043d1e65",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4341c02d-368a-48cb-9964-dba101eb590e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "183cc3ac-060c-4807-90ee-8fe7825f441c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c3fcadfa-7f71-47c1-88bf-15a4c6104c50",
"_parent_code": "sample string 6",
"sales_organization_id": "3ac863fd-bdc2-4264-a118-a3a7c54dacb5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8e5df7df-b146-44df-aa86-7d8f459bf405",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcad67eb-2322-43bf-a697-8f2b0dd293b1",
"db_currency_id": "0d31c2b0-0862-444b-8a27-4c28294a2be3",
"db_language_id": "cae7ef11-b0b0-48d9-a990-26b1955dfcc0",
"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-15T18:33:19.1911594+00:00"
},
"modified_dateutc": "2026-09-15T18:33:19.1911594+00:00"
},
"equipment_model_id": "9a916dc5-a52b-454b-8774-218449dc74b9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "91f0790a-eaac-449d-976b-8d3f302aa84d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2403e0de-0f96-4d0e-b08d-5a8c8b9ed41e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fc182d63-8fd9-46cd-927d-5bbb32e31c49",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e0c4edaf-ad06-4dc8-bcab-cd8d82ca9a75",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8e5df7df-b146-44df-aa86-7d8f459bf405",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcad67eb-2322-43bf-a697-8f2b0dd293b1",
"db_currency_id": "0d31c2b0-0862-444b-8a27-4c28294a2be3",
"db_language_id": "cae7ef11-b0b0-48d9-a990-26b1955dfcc0",
"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-15T18:33:19.1911594+00:00"
},
"modified_dateutc": "2026-09-15T18:33:19.1911594+00:00"
},
"equipment_family_id": "688b224a-650a-4cb7-8197-db9025b59866",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "183cc3ac-060c-4807-90ee-8fe7825f441c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c3fcadfa-7f71-47c1-88bf-15a4c6104c50",
"_parent_code": "sample string 6",
"sales_organization_id": "3ac863fd-bdc2-4264-a118-a3a7c54dacb5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8e5df7df-b146-44df-aa86-7d8f459bf405",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcad67eb-2322-43bf-a697-8f2b0dd293b1",
"db_currency_id": "0d31c2b0-0862-444b-8a27-4c28294a2be3",
"db_language_id": "cae7ef11-b0b0-48d9-a990-26b1955dfcc0",
"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-15T18:33:19.1911594+00:00"
},
"modified_dateutc": "2026-09-15T18:33:19.1911594+00:00"
},
"date_in_production_since": "2026-09-15T18:33:19.1911594+00:00",
"date_out_of_production_since": "2026-09-15T18:33:19.1911594+00:00",
"date_end_support": "2026-09-15T18:33:19.1911594+00:00",
"sales_organization_id": "96c8b857-ecea-4078-be0b-b921bc7b7b77",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8e5df7df-b146-44df-aa86-7d8f459bf405",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcad67eb-2322-43bf-a697-8f2b0dd293b1",
"db_currency_id": "0d31c2b0-0862-444b-8a27-4c28294a2be3",
"db_language_id": "cae7ef11-b0b0-48d9-a990-26b1955dfcc0",
"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-15T18:33:19.1911594+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-15T18:33:19.1911594+00:00"
},
"project_status_id": "a36c60ee-fa79-4c23-bbbc-a17c6d4dbaca",
"project_status_code": "sample string 10",
"project_status": {
"id": "ddb25e14-6a20-4ed5-9732-4e71d2c0925c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5201e9ea-715d-40ed-b61a-4364dda6aa45",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8e5df7df-b146-44df-aa86-7d8f459bf405",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcad67eb-2322-43bf-a697-8f2b0dd293b1",
"db_currency_id": "0d31c2b0-0862-444b-8a27-4c28294a2be3",
"db_language_id": "cae7ef11-b0b0-48d9-a990-26b1955dfcc0",
"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-15T18:33:19.1911594+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-15T18:33:19.1911594+00:00"
},
"company_id": "06ded187-99e6-4781-b0b1-506414f7f5a8",
"company_code": "sample string 12",
"db_address_id": "0deb0f78-0d4c-4a8b-80ec-65ba71d5127a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b62c014b-a6f4-4548-92fd-21ea51f37f25",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "dcd38701-7df7-4fbc-aa96-aa797084189d",
"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-15T18:33:19.1911594+00:00",
"date_create": "2026-09-15T18:33:19.1911594+00:00",
"date_update": "2026-09-15T18:33:19.1911594+00:00",
"updated_by_user_id": "8677af2e-ba67-4397-b5cb-ed6dc58db4d9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-15T18:33:19.1911594+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-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-15T18:33:19.1911594+00:00",
"date_last_job": "2026-09-15T18:33:19.1911594+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-15T18:33:19.1911594+00:00",
"modified_dateutc": "2026-09-15T18:33:19.1911594+00:00",
"is_mobile_installation": true
},
"job_type_id": "3847dfd3-a7fe-4cb9-9c11-4c3ecf3af028",
"job_type_code": "sample string 7",
"job_type": {
"id": "432a3d6a-5c49-40fb-a7ed-180518eddff0",
"name": "sample string 2",
"sales_organization_id": "bc4e4728-50ff-457d-ba9e-7263e6ea6d73",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-15T18:33:19.1911594+00:00",
"code": "sample string 7"
},
"job_priority_id": "f758923c-fbf7-44e5-9daa-ce9138af0e25",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "da149bac-81f6-4563-992e-c9f0defa5c7f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "407b1edb-5729-4128-b136-d745888dd21c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8e5df7df-b146-44df-aa86-7d8f459bf405",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcad67eb-2322-43bf-a697-8f2b0dd293b1",
"db_currency_id": "0d31c2b0-0862-444b-8a27-4c28294a2be3",
"db_language_id": "cae7ef11-b0b0-48d9-a990-26b1955dfcc0",
"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-15T18:33:19.1911594+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-15T18:33:19.1911594+00:00"
},
"job_status_id": "bfd707c4-da28-40d3-869c-1b7645d9c4bb",
"job_status_code": "sample string 11",
"db_address_id": "9d3d7be5-fc30-44bf-b1b4-b5a4e9c2ff77",
"contact_id": "74bd99e4-6b6a-4231-a206-97b4b4064f58",
"requested_by_company_id": "4a458a26-2f02-4dba-8385-c362e6386342",
"requested_by_contact_id": "3c1f544a-3ebb-40a0-ae33-01f0402f3346",
"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-15T18:33:19.1911594+00:00",
"due_date": "2026-09-15T18:33:19.1911594+00:00",
"date_create": "2026-09-15T18:33:19.1911594+00:00",
"date_update": "2026-09-15T18:33:19.1911594+00:00",
"date_closed": "2026-09-15T18:33:19.1911594+00:00",
"suggested_user_id": "55d50832-45ea-47f0-a948-2b506f5fd59f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "13248e54-b41f-401c-a26f-5c1d9fac453f",
"db_language_id": "cd7cebd0-c410-4ea4-86cd-84099abc9309",
"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-15T18:33:19.1911594+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5022580c-188d-4fb5-ba32-42ca2c15d70e",
"sales_organization": {
"id": "8e5df7df-b146-44df-aa86-7d8f459bf405",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcad67eb-2322-43bf-a697-8f2b0dd293b1",
"db_currency_id": "0d31c2b0-0862-444b-8a27-4c28294a2be3",
"db_language_id": "cae7ef11-b0b0-48d9-a990-26b1955dfcc0",
"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-15T18:33:19.1911594+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "644c9f7b-15ad-41ae-a95e-f908559ddd55",
"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": "c028fe67-97f0-457f-91e6-247e05fcdf00",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-15T18:33:19.1911594+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9ec2195c-cdb4-42cd-b7ee-f7876b88bf89"
},
"suggested_date_start": "2026-09-15T18:33:19.1911594+00:00",
"skill_id": "66dd67df-38ab-4bbf-8f3d-311ca7b88ed0",
"skill_code": "sample string 32",
"skill": {
"id": "00d9cd87-ec20-475c-bc72-7a33512bc597",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "08c4012b-d28b-4d5b-a710-abe883fdc57c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8e5df7df-b146-44df-aa86-7d8f459bf405",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcad67eb-2322-43bf-a697-8f2b0dd293b1",
"db_currency_id": "0d31c2b0-0862-444b-8a27-4c28294a2be3",
"db_language_id": "cae7ef11-b0b0-48d9-a990-26b1955dfcc0",
"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-15T18:33:19.1911594+00:00"
},
"modified_dateutc": "2026-09-15T18:33:19.1911594+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "13064a5b-5b07-4262-bab2-78d938edec37",
"date_reported_by_company": "2026-09-15T18:33:19.1911594+00:00",
"id2": 36,
"company_id": "ad8548d9-30e9-4466-9df6-3fe12c04fe55",
"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": "b097a54c-b721-4152-be92-665941f2b5b8",
"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-15T18:33:19.1911594+00:00"
},
"work_instruction_details_id": "fd7e5da6-640f-4c34-924d-f69dd3d7bdab",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6cefd8a2-7832-46ee-8bfb-73d9d3c12eb0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bdc0dec6-0c3b-4089-acce-e7d924794ded",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-15T18:33:19.1911594+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": "2420c840-566f-4db6-ad9f-aa1af0e22931",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-15T18:33:19.1911594+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.