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": "7ab4ca5c-4151-4d56-8b96-4c1751b868de",
"jobs_id": "fc32eb4b-657f-4db8-80d9-6f043f9cc058",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "efa6577c-d3b2-4ef1-b97b-4e10ef3e7266",
"_parent_id": "b917f89c-5836-416c-a680-8aad7d215d3a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "be185516-7431-49e5-a465-65db4bc0b2f2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "da32e211-c830-4e61-b5b6-509ef5f72179",
"_parent_id": "6538248e-0426-4c6f-8053-d4af387e7b2e",
"root_parent_id": "9490e8c9-2f26-428f-bac6-f6d42adeaa08",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b3ab0c6b-64e5-44a2-8a54-9845f8024909",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "11d848a5-90a6-4845-9799-2c2a621cb83b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e4a976b0-382f-4720-90d5-26bea21c20ca",
"_parent_code": "sample string 6",
"sales_organization_id": "63426bb0-ea19-43b3-8e7f-e11fd1b6ccf3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0d26c4c6-24a2-40b5-a86d-fd9702f2747b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1999cdb7-de4e-4ac8-b6cf-a9873400262a",
"db_currency_id": "85dc2f4e-6977-4f08-aa83-a420487257c2",
"db_language_id": "060c346a-ecf2-4b68-b3cd-6bf45dc6aed0",
"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-06-14T03:05:21.5449676+00:00"
},
"modified_dateutc": "2026-06-14T03:05:21.5449676+00:00"
},
"equipment_model_id": "8f9c26d2-589f-4c72-aa06-3859db799a86",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4ebeda95-a053-4d61-99c9-352b9fba3627",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "55256e3c-32a5-4d2f-a4a0-87bd42612d34",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7a6ce240-98cd-4b31-9d87-5800be45b79c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ca6101a5-47f5-449b-9985-8c5d4c239ebf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0d26c4c6-24a2-40b5-a86d-fd9702f2747b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1999cdb7-de4e-4ac8-b6cf-a9873400262a",
"db_currency_id": "85dc2f4e-6977-4f08-aa83-a420487257c2",
"db_language_id": "060c346a-ecf2-4b68-b3cd-6bf45dc6aed0",
"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-06-14T03:05:21.5449676+00:00"
},
"modified_dateutc": "2026-06-14T03:05:21.5449676+00:00"
},
"equipment_family_id": "e9fa0761-1368-4ba3-8cb0-220d40151954",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "11d848a5-90a6-4845-9799-2c2a621cb83b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e4a976b0-382f-4720-90d5-26bea21c20ca",
"_parent_code": "sample string 6",
"sales_organization_id": "63426bb0-ea19-43b3-8e7f-e11fd1b6ccf3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0d26c4c6-24a2-40b5-a86d-fd9702f2747b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1999cdb7-de4e-4ac8-b6cf-a9873400262a",
"db_currency_id": "85dc2f4e-6977-4f08-aa83-a420487257c2",
"db_language_id": "060c346a-ecf2-4b68-b3cd-6bf45dc6aed0",
"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-06-14T03:05:21.5449676+00:00"
},
"modified_dateutc": "2026-06-14T03:05:21.5449676+00:00"
},
"date_in_production_since": "2026-06-14T03:05:21.5449676+00:00",
"date_out_of_production_since": "2026-06-14T03:05:21.5449676+00:00",
"date_end_support": "2026-06-14T03:05:21.5449676+00:00",
"sales_organization_id": "885f2461-4c18-455d-8fda-f3a424aa8d81",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0d26c4c6-24a2-40b5-a86d-fd9702f2747b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1999cdb7-de4e-4ac8-b6cf-a9873400262a",
"db_currency_id": "85dc2f4e-6977-4f08-aa83-a420487257c2",
"db_language_id": "060c346a-ecf2-4b68-b3cd-6bf45dc6aed0",
"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-06-14T03:05:21.5449676+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-06-14T03:05:21.5449676+00:00"
},
"project_status_id": "abd0db56-abb6-4489-a33a-9b00e2d5f6e6",
"project_status_code": "sample string 10",
"project_status": {
"id": "6d5a0bd9-044f-4e66-95ee-659ee7b4d691",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7daef566-1519-4e85-8368-d6d72ece2b2f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0d26c4c6-24a2-40b5-a86d-fd9702f2747b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1999cdb7-de4e-4ac8-b6cf-a9873400262a",
"db_currency_id": "85dc2f4e-6977-4f08-aa83-a420487257c2",
"db_language_id": "060c346a-ecf2-4b68-b3cd-6bf45dc6aed0",
"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-06-14T03:05:21.5449676+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-14T03:05:21.5449676+00:00"
},
"company_id": "a19a2641-f611-48d6-a55c-0a07771c7089",
"company_code": "sample string 12",
"db_address_id": "18c92a5d-4e5c-4c6a-919f-8f3f6c61fdbc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "09b3e3dd-e90b-4d23-928a-ea6ddd528a9f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "160675d4-9f9c-4edd-aca9-1b530e29e116",
"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-06-14T03:05:21.5449676+00:00",
"date_create": "2026-06-14T03:05:21.5449676+00:00",
"date_update": "2026-06-14T03:05:21.5449676+00:00",
"updated_by_user_id": "d407636c-5cca-49aa-9303-865f88ce4c26",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-14T03:05:21.5449676+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-06-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-14T03:05:21.5449676+00:00",
"date_last_job": "2026-06-14T03:05:21.5449676+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-14T03:05:21.5449676+00:00",
"modified_dateutc": "2026-06-14T03:05:21.5449676+00:00",
"is_mobile_installation": true
},
"job_type_id": "7bd4c1f3-2b49-4635-82b2-829d59c1f1c2",
"job_type_code": "sample string 7",
"job_type": {
"id": "b9765f38-133a-4444-8c13-bf692bc645a8",
"name": "sample string 2",
"sales_organization_id": "1f261bb7-bbfc-4de1-9ad2-843099b9284b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-14T03:05:21.5449676+00:00",
"code": "sample string 7"
},
"job_priority_id": "957348c2-5eb8-42ed-8116-4f525adb8f2f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fc6b5594-343c-40e2-b0d7-f67684dee155",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "54970e5b-f1ac-44f1-8aa5-a3f945a658f7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0d26c4c6-24a2-40b5-a86d-fd9702f2747b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1999cdb7-de4e-4ac8-b6cf-a9873400262a",
"db_currency_id": "85dc2f4e-6977-4f08-aa83-a420487257c2",
"db_language_id": "060c346a-ecf2-4b68-b3cd-6bf45dc6aed0",
"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-06-14T03:05:21.5449676+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-14T03:05:21.5449676+00:00"
},
"job_status_id": "d852e70d-1ee9-48c4-838b-a1c3ab57ef42",
"job_status_code": "sample string 11",
"db_address_id": "12f329ee-e921-4d12-82e0-cd4454c66156",
"contact_id": "129358b3-6e60-442a-ac36-042ed0372ce6",
"requested_by_company_id": "141c0fdc-ac76-44d1-a989-bdb1e668a7cf",
"requested_by_contact_id": "ef873e07-c2c9-4165-a53f-bb362b81d31d",
"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-06-14T03:05:21.5449676+00:00",
"due_date": "2026-06-14T03:05:21.5449676+00:00",
"date_create": "2026-06-14T03:05:21.5449676+00:00",
"date_update": "2026-06-14T03:05:21.5449676+00:00",
"date_closed": "2026-06-14T03:05:21.5449676+00:00",
"suggested_user_id": "c11ebf81-7bf0-4db1-97cf-21f41f072af4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7bad4671-a967-4478-8863-d41b9aae4ff7",
"db_language_id": "876db1a5-dc74-48ac-9a80-e6af10ef4470",
"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-06-14T03:05:21.5449676+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ab5b56b1-6f92-4881-ace7-4a191242bfb2",
"sales_organization": {
"id": "0d26c4c6-24a2-40b5-a86d-fd9702f2747b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1999cdb7-de4e-4ac8-b6cf-a9873400262a",
"db_currency_id": "85dc2f4e-6977-4f08-aa83-a420487257c2",
"db_language_id": "060c346a-ecf2-4b68-b3cd-6bf45dc6aed0",
"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-06-14T03:05:21.5449676+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e2e89831-b121-4c21-a2bc-c3e4a6002d77",
"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": "8b0e78e8-7bac-4349-9889-a5b5d6df6f95",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-14T03:05:21.5449676+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e165b201-3e1e-4546-8a1a-33f5c251a022"
},
"suggested_date_start": "2026-06-14T03:05:21.5449676+00:00",
"skill_id": "34370665-3c81-4f03-b8bc-a3d374fa9899",
"skill_code": "sample string 32",
"skill": {
"id": "00648df8-bc4a-4ed0-bd33-5e347cdbbdf3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c939d1f9-d61a-4d06-8f3f-b0bf1eed3e1b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0d26c4c6-24a2-40b5-a86d-fd9702f2747b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1999cdb7-de4e-4ac8-b6cf-a9873400262a",
"db_currency_id": "85dc2f4e-6977-4f08-aa83-a420487257c2",
"db_language_id": "060c346a-ecf2-4b68-b3cd-6bf45dc6aed0",
"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-06-14T03:05:21.5449676+00:00"
},
"modified_dateutc": "2026-06-14T03:05:21.5449676+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "523bbce2-38c0-433b-bbe0-a97f1b0b1f52",
"date_reported_by_company": "2026-06-14T03:05:21.5449676+00:00",
"id2": 36,
"company_id": "f990276e-9087-4a37-82c4-7266e993b5eb",
"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": "357f706b-3434-4e07-8102-c06cda319fdb",
"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-06-14T03:05:21.5449676+00:00"
},
"work_instruction_details_id": "ea7f73c6-51cc-4293-89f2-ad0bf447faba",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bdbde80f-35f4-4ea2-858f-82a13cfc94ed",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "eaafe88d-d701-4c7d-91f8-06df8f0dc727",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-14T03:05:21.5449676+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": "676a1890-c57c-4c47-bdba-b61902fd843a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-14T03:05:21.5449676+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.