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": "a1f0108e-5511-45e4-a85b-ca26e4b9c13c",
"jobs_id": "5c42da18-7627-41dc-ba9c-82d3290b490b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "084603c5-17c8-4687-86a2-7246d4a3a6ff",
"_parent_id": "3a1a5a45-f82d-4c39-a94e-861df744be76",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "caa1e15e-1ca1-49a1-a0e8-ef9b75cd4a0c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a1744a10-1358-49e6-92e2-f85ba1799cc6",
"_parent_id": "93500b22-2b8e-4380-8495-ce45f0be01f1",
"root_parent_id": "f58b2c64-9d66-4964-975e-7e6d28e1894a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8167bd2b-1f3f-4647-85da-4052fab99e40",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "30abaa40-5909-47af-8923-a889e8ac08c7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0f64aeb6-a058-4ec4-a4bb-9cedfb81a8f7",
"_parent_code": "sample string 6",
"sales_organization_id": "83ce60c0-59f7-4fcd-8f03-e42eb2df7317",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6ea3cbcd-a33f-40e8-8b89-596ef1872499",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c8b087c-20ce-4963-b8af-5d950b17adcd",
"db_currency_id": "de37eaa4-8cdf-425b-8ad5-f42a550870bb",
"db_language_id": "e11dfb9d-27ed-4314-81ae-1ef3bfff4d54",
"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-08-15T00:33:02.2967127+00:00"
},
"modified_dateutc": "2026-08-15T00:33:02.2967127+00:00"
},
"equipment_model_id": "559c6a10-aa6d-4b38-8774-173c80bce0ca",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5ff0fc9e-daec-455f-9862-08fa32de890d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "749f5d8f-846b-488a-9c75-c75e21a3fdf3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "05e95214-1cfb-48ac-9d22-d0f5aa66eed6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b551051d-a2f4-4cc6-8c10-e7ec46be09de",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6ea3cbcd-a33f-40e8-8b89-596ef1872499",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c8b087c-20ce-4963-b8af-5d950b17adcd",
"db_currency_id": "de37eaa4-8cdf-425b-8ad5-f42a550870bb",
"db_language_id": "e11dfb9d-27ed-4314-81ae-1ef3bfff4d54",
"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-08-15T00:33:02.2967127+00:00"
},
"modified_dateutc": "2026-08-15T00:33:02.2967127+00:00"
},
"equipment_family_id": "469b3983-333b-419f-b9ca-2449aec5b105",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "30abaa40-5909-47af-8923-a889e8ac08c7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0f64aeb6-a058-4ec4-a4bb-9cedfb81a8f7",
"_parent_code": "sample string 6",
"sales_organization_id": "83ce60c0-59f7-4fcd-8f03-e42eb2df7317",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6ea3cbcd-a33f-40e8-8b89-596ef1872499",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c8b087c-20ce-4963-b8af-5d950b17adcd",
"db_currency_id": "de37eaa4-8cdf-425b-8ad5-f42a550870bb",
"db_language_id": "e11dfb9d-27ed-4314-81ae-1ef3bfff4d54",
"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-08-15T00:33:02.2967127+00:00"
},
"modified_dateutc": "2026-08-15T00:33:02.2967127+00:00"
},
"date_in_production_since": "2026-08-15T00:33:02.2967127+00:00",
"date_out_of_production_since": "2026-08-15T00:33:02.2967127+00:00",
"date_end_support": "2026-08-15T00:33:02.2967127+00:00",
"sales_organization_id": "4421c76f-c731-4069-96ad-e4bbdfd5639e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6ea3cbcd-a33f-40e8-8b89-596ef1872499",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c8b087c-20ce-4963-b8af-5d950b17adcd",
"db_currency_id": "de37eaa4-8cdf-425b-8ad5-f42a550870bb",
"db_language_id": "e11dfb9d-27ed-4314-81ae-1ef3bfff4d54",
"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-08-15T00:33:02.2967127+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-08-15T00:33:02.2967127+00:00"
},
"project_status_id": "fbf6adb4-97f0-4f39-93fd-70117aaad257",
"project_status_code": "sample string 10",
"project_status": {
"id": "78f01a86-4b0c-41c1-8cb0-362a77fcfbc3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c0ad381e-5a34-470f-9b6b-bdfcb44748bf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6ea3cbcd-a33f-40e8-8b89-596ef1872499",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c8b087c-20ce-4963-b8af-5d950b17adcd",
"db_currency_id": "de37eaa4-8cdf-425b-8ad5-f42a550870bb",
"db_language_id": "e11dfb9d-27ed-4314-81ae-1ef3bfff4d54",
"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-08-15T00:33:02.2967127+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-15T00:33:02.2967127+00:00"
},
"company_id": "e41bb309-b50e-4d00-8a58-062a9c8e2a62",
"company_code": "sample string 12",
"db_address_id": "7b44a0fd-1b15-43e0-9dd1-5c7043860453",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "61cf983b-4613-4bc5-8bcb-ea62aa852193",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "286e6d81-c440-4bb6-b660-37e0e912a975",
"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-08-15T00:33:02.2967127+00:00",
"date_create": "2026-08-15T00:33:02.2967127+00:00",
"date_update": "2026-08-15T00:33:02.2967127+00:00",
"updated_by_user_id": "fbaee563-a557-4831-9ddf-7e200b7018aa",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-15T00:33:02.2967127+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-08-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-15T00:33:02.2967127+00:00",
"date_last_job": "2026-08-15T00:33:02.2967127+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-15T00:33:02.2967127+00:00",
"modified_dateutc": "2026-08-15T00:33:02.2967127+00:00",
"is_mobile_installation": true
},
"job_type_id": "e3855a83-5b4d-4390-9422-18057ef4aecd",
"job_type_code": "sample string 7",
"job_type": {
"id": "b3bd3dab-fdcb-42c4-bd4c-a60212202499",
"name": "sample string 2",
"sales_organization_id": "0fabfafe-59f2-4ee1-8f13-f1416bb8b39e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-15T00:33:02.2967127+00:00",
"code": "sample string 7"
},
"job_priority_id": "12a00384-9796-47d9-af7b-b0ce0d8484bc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7a577734-f12a-4cee-badc-258fe409e1dc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2005163e-9284-4c34-a6c9-874c012ecd3f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6ea3cbcd-a33f-40e8-8b89-596ef1872499",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c8b087c-20ce-4963-b8af-5d950b17adcd",
"db_currency_id": "de37eaa4-8cdf-425b-8ad5-f42a550870bb",
"db_language_id": "e11dfb9d-27ed-4314-81ae-1ef3bfff4d54",
"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-08-15T00:33:02.2967127+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-15T00:33:02.2967127+00:00"
},
"job_status_id": "c6c1c793-a9dc-4174-904a-0dfe4080338b",
"job_status_code": "sample string 11",
"db_address_id": "34dfa42c-3a4f-49f3-ae21-89263919411f",
"contact_id": "e8e5048a-bf20-4a92-a656-8d86611a7dbf",
"requested_by_company_id": "bec8f23c-e3a5-467f-b75f-93cfc1b5bad3",
"requested_by_contact_id": "aa263994-271d-46fa-b997-a9a8457870c4",
"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-08-15T00:33:02.2967127+00:00",
"due_date": "2026-08-15T00:33:02.2967127+00:00",
"date_create": "2026-08-15T00:33:02.2967127+00:00",
"date_update": "2026-08-15T00:33:02.2967127+00:00",
"date_closed": "2026-08-15T00:33:02.2967127+00:00",
"suggested_user_id": "6498dfc4-91e6-42fc-b783-8cd0c5acc75e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8e80f66b-4f7d-4911-803b-7a7f07382075",
"db_language_id": "a08e600f-0ec9-4dbd-bff8-5260ad67c576",
"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-08-15T00:33:02.2967127+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dc84a0f9-a285-4e73-b760-040359b746f1",
"sales_organization": {
"id": "6ea3cbcd-a33f-40e8-8b89-596ef1872499",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c8b087c-20ce-4963-b8af-5d950b17adcd",
"db_currency_id": "de37eaa4-8cdf-425b-8ad5-f42a550870bb",
"db_language_id": "e11dfb9d-27ed-4314-81ae-1ef3bfff4d54",
"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-08-15T00:33:02.2967127+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f53bf735-89f6-4efc-9957-9fe58c90b804",
"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": "7a868d60-ff36-4f9d-90d3-3407fb0c460c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-15T00:33:02.2967127+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "91e26c18-04fd-4cd5-97bc-64115cd6fb56"
},
"suggested_date_start": "2026-08-15T00:33:02.2967127+00:00",
"skill_id": "3338e4f6-b452-4c90-a531-631873d37427",
"skill_code": "sample string 32",
"skill": {
"id": "65bca2e4-330b-42e4-a223-ad66471b8481",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9cd2d1c7-ab9b-4581-b00f-cdcd980417f9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6ea3cbcd-a33f-40e8-8b89-596ef1872499",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2c8b087c-20ce-4963-b8af-5d950b17adcd",
"db_currency_id": "de37eaa4-8cdf-425b-8ad5-f42a550870bb",
"db_language_id": "e11dfb9d-27ed-4314-81ae-1ef3bfff4d54",
"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-08-15T00:33:02.2967127+00:00"
},
"modified_dateutc": "2026-08-15T00:33:02.2967127+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1a40f214-b357-47f1-b57a-e4f42f8196a7",
"date_reported_by_company": "2026-08-15T00:33:02.2967127+00:00",
"id2": 36,
"company_id": "2e9cc6fb-bbbf-43fe-a88e-41745651212d",
"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": "878aa7ae-aa5b-48a2-9ea0-3d50ea168174",
"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-08-15T00:33:02.2967127+00:00"
},
"work_instruction_details_id": "4f334a48-0d6a-4883-bef7-75abb411786b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "533caa94-7350-492f-b00f-596bf5d002f6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "96b9508f-773f-4800-8de8-53d676fc9381",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-15T00:33:02.2967127+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": "4bb8002d-7018-442a-874f-fb9fbc987818",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-15T00:33:02.2967127+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.