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": "3ebd8c57-2e34-406a-95c7-590921926b0e",
"jobs_id": "61428080-b0ae-4602-a579-f9f4e55e0cf9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d4742bed-3997-42b4-98a7-2118834ab3fe",
"_parent_id": "2dbe6873-e38e-465c-abaf-912124b5c606",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "02e52c11-4fd5-4a70-84db-0536e156c300",
"project_reference_back_office": "sample string 5",
"project": {
"id": "aa35aedf-4924-43cd-8758-563ceed02311",
"_parent_id": "390e08fc-2b95-4cf3-8f4d-79dda584e9ce",
"root_parent_id": "e1c6763d-b555-4c99-8964-39714ef8a3cb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "97f0e1c0-41bd-43fd-b870-99a79a814a7c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "42828c18-a7c4-4211-97d4-ddd3ab8bc4b8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1e1e685b-6386-482c-a7d6-7c6b028f56d5",
"_parent_code": "sample string 6",
"sales_organization_id": "c45049d0-cf87-43a6-af4d-05e60319d22b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8685979d-75a0-411a-ad04-31e23fa7d7ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5ce58e0-1cd8-47df-9e34-020ed169a640",
"db_currency_id": "47bad044-787d-48ad-ab59-0ca90506f297",
"db_language_id": "4ac16108-41be-49e3-b111-63e4e0cedb1b",
"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-04-24T11:01:49.9154363+00:00"
},
"modified_dateutc": "2026-04-24T11:01:49.9154363+00:00"
},
"equipment_model_id": "7c28f7c2-f8e7-4cb4-b7c6-116ec9c6b3c1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "afb62f6a-fdcb-4ebf-89ee-bbd063f188d3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1667f2bf-f9fb-474f-bf12-fe930f3f32f6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "903ac999-adeb-4253-8efd-f86f8e84b946",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "89fdbe2d-8e7e-4039-9a66-fe0086fd9acc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8685979d-75a0-411a-ad04-31e23fa7d7ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5ce58e0-1cd8-47df-9e34-020ed169a640",
"db_currency_id": "47bad044-787d-48ad-ab59-0ca90506f297",
"db_language_id": "4ac16108-41be-49e3-b111-63e4e0cedb1b",
"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-04-24T11:01:49.9154363+00:00"
},
"modified_dateutc": "2026-04-24T11:01:49.9154363+00:00"
},
"equipment_family_id": "f39025d0-e5d4-4c21-98a5-48635fa896f0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "42828c18-a7c4-4211-97d4-ddd3ab8bc4b8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1e1e685b-6386-482c-a7d6-7c6b028f56d5",
"_parent_code": "sample string 6",
"sales_organization_id": "c45049d0-cf87-43a6-af4d-05e60319d22b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8685979d-75a0-411a-ad04-31e23fa7d7ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5ce58e0-1cd8-47df-9e34-020ed169a640",
"db_currency_id": "47bad044-787d-48ad-ab59-0ca90506f297",
"db_language_id": "4ac16108-41be-49e3-b111-63e4e0cedb1b",
"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-04-24T11:01:49.9154363+00:00"
},
"modified_dateutc": "2026-04-24T11:01:49.9154363+00:00"
},
"date_in_production_since": "2026-04-24T11:01:49.9154363+00:00",
"date_out_of_production_since": "2026-04-24T11:01:49.9154363+00:00",
"date_end_support": "2026-04-24T11:01:49.9154363+00:00",
"sales_organization_id": "080c7f63-d79c-4fc9-a08d-1852fc297300",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8685979d-75a0-411a-ad04-31e23fa7d7ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5ce58e0-1cd8-47df-9e34-020ed169a640",
"db_currency_id": "47bad044-787d-48ad-ab59-0ca90506f297",
"db_language_id": "4ac16108-41be-49e3-b111-63e4e0cedb1b",
"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-04-24T11:01:49.9154363+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-04-24T11:01:49.9154363+00:00"
},
"project_status_id": "97c36662-665e-4f1d-af66-4e066342b52d",
"project_status_code": "sample string 10",
"project_status": {
"id": "77036f73-2e8a-4e58-bca5-7baec0ce8649",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "41553c42-0510-4c1a-a200-fd17fe1d1fe4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8685979d-75a0-411a-ad04-31e23fa7d7ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5ce58e0-1cd8-47df-9e34-020ed169a640",
"db_currency_id": "47bad044-787d-48ad-ab59-0ca90506f297",
"db_language_id": "4ac16108-41be-49e3-b111-63e4e0cedb1b",
"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-04-24T11:01:49.9154363+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-24T11:01:49.9154363+00:00"
},
"company_id": "261f3aef-6639-4515-adb0-7ec565c4c5c4",
"company_code": "sample string 12",
"db_address_id": "281e0752-b85a-49c1-856e-f9df6238d56f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f50b96c8-9f15-4a76-b937-0bf74a069ec8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a028aef6-8161-42a7-9ba5-964176f3b025",
"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-04-24T11:01:49.9154363+00:00",
"date_create": "2026-04-24T11:01:49.9154363+00:00",
"date_update": "2026-04-24T11:01:49.9154363+00:00",
"updated_by_user_id": "9b618d1b-e969-476c-acc1-32968efec7e5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-24T11:01:49.9154363+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-04-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-24T11:01:49.9154363+00:00",
"date_last_job": "2026-04-24T11:01:49.9154363+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-24T11:01:49.9154363+00:00",
"modified_dateutc": "2026-04-24T11:01:49.9154363+00:00",
"is_mobile_installation": true
},
"job_type_id": "1503cf3a-feaa-423d-9d11-4627d98fc231",
"job_type_code": "sample string 7",
"job_type": {
"id": "b7b72e62-465b-448e-be02-afbef9139d37",
"name": "sample string 2",
"sales_organization_id": "1037830b-3819-43e2-adda-6f502d0fedca",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-24T11:01:49.9154363+00:00",
"code": "sample string 7"
},
"job_priority_id": "1b7b2821-9325-4a77-b7a3-f86c7cc4d3b3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b9bf55bc-a611-4487-b5cd-075ff804cd40",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "02fa5dd2-9861-4889-ae42-24e9554115af",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8685979d-75a0-411a-ad04-31e23fa7d7ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5ce58e0-1cd8-47df-9e34-020ed169a640",
"db_currency_id": "47bad044-787d-48ad-ab59-0ca90506f297",
"db_language_id": "4ac16108-41be-49e3-b111-63e4e0cedb1b",
"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-04-24T11:01:49.9154363+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-24T11:01:49.9154363+00:00"
},
"job_status_id": "1fbd5774-e1f1-4e2a-80d3-e69a4b26de4f",
"job_status_code": "sample string 11",
"db_address_id": "86c97ecb-5d60-46f1-aa24-67e13180eb42",
"contact_id": "9884d17b-144b-48d4-a48f-b17f5597653b",
"requested_by_company_id": "6ec1cb42-3b15-40ef-bf75-df47adb845ff",
"requested_by_contact_id": "70c5168e-a7e2-4edd-af15-ae84b0b87883",
"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-04-24T11:01:49.9154363+00:00",
"due_date": "2026-04-24T11:01:49.9154363+00:00",
"date_create": "2026-04-24T11:01:49.9154363+00:00",
"date_update": "2026-04-24T11:01:49.9154363+00:00",
"date_closed": "2026-04-24T11:01:49.9154363+00:00",
"suggested_user_id": "2f1c4f68-7f79-4a8d-87e8-2296204b508e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f0b93888-be12-4c0b-8f08-42bdd1132ed2",
"db_language_id": "81ba09c5-0dc4-4789-b606-77fe3427aa8f",
"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-04-24T11:01:49.9154363+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fbd08cd0-5fa8-4764-85c3-c2cfa0c29f9f",
"sales_organization": {
"id": "8685979d-75a0-411a-ad04-31e23fa7d7ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5ce58e0-1cd8-47df-9e34-020ed169a640",
"db_currency_id": "47bad044-787d-48ad-ab59-0ca90506f297",
"db_language_id": "4ac16108-41be-49e3-b111-63e4e0cedb1b",
"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-04-24T11:01:49.9154363+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "21537a3f-f7da-43fb-9f95-d36985f08b6e",
"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": "dc44e193-378e-49ed-8344-b3ff324a12f1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-24T11:01:49.9154363+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5eb7daf5-8ad5-4398-82d8-4ae3b72623be"
},
"suggested_date_start": "2026-04-24T11:01:49.9154363+00:00",
"skill_id": "775a5837-f0f4-4c83-bd98-302bbd0b479c",
"skill_code": "sample string 32",
"skill": {
"id": "32802516-32de-4b9e-9b92-4c20d7eb98d8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7c95e045-3fd1-4997-80c3-cb65646d7cef",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8685979d-75a0-411a-ad04-31e23fa7d7ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5ce58e0-1cd8-47df-9e34-020ed169a640",
"db_currency_id": "47bad044-787d-48ad-ab59-0ca90506f297",
"db_language_id": "4ac16108-41be-49e3-b111-63e4e0cedb1b",
"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-04-24T11:01:49.9154363+00:00"
},
"modified_dateutc": "2026-04-24T11:01:49.9154363+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "242efdb9-8ab5-48d6-b6b0-c1fe341aeaaf",
"date_reported_by_company": "2026-04-24T11:01:49.9154363+00:00",
"id2": 36,
"company_id": "adc83f04-7b26-47a9-be0c-e1aa52594ea1",
"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": "2daeb942-d99b-41e0-b710-3cc83723d285",
"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-04-24T11:01:49.9154363+00:00"
},
"work_instruction_details_id": "3f7d243a-120c-4874-99d1-09e69cc441b2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f74380a3-cd97-4589-a67e-b18705a95ff5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6060488b-04cc-434a-9555-85d8c076fb48",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-24T11:01:49.9154363+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": "b52d1a8c-5082-4f66-9f25-758c8caacbcb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-24T11:01:49.9154363+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.