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": "72fe17ee-f4b3-45b2-b5eb-905912c01306",
"jobs_id": "b937d41e-c524-45e5-a172-fe03ffd06949",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "410d8d3a-7b0d-494e-83bd-6d57ec2080f4",
"_parent_id": "abcf9f68-2f9f-43b5-8aa8-2ad9f62f91bc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1185e16f-f29a-4259-b4d9-410bb8e48178",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b332f657-e39a-4e7a-b3c2-64f941f9b78f",
"_parent_id": "ff8cef3a-c7ec-42d6-a570-7666bce390d1",
"root_parent_id": "f44bb6d5-2219-4d72-a784-336d622c8fd2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "45b1cf70-005f-4f5a-8ede-4789b8ac2c04",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e1eaa7b1-35f9-488d-8d75-6ab02f450eb3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b029e3d2-d638-4b05-8cfe-c132de8f3d51",
"_parent_code": "sample string 6",
"sales_organization_id": "0cc69ecb-96cb-4b0d-a34c-4b2a74b11105",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2044ba7f-c668-4c74-84f4-905908c18f50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d415894-a075-4ac1-88ee-3ad29540ed6c",
"db_currency_id": "d7fd293d-5d9f-49fb-90f4-b6b2c65c128a",
"db_language_id": "f3ea71f9-4230-40d8-95f6-b8e3c5726e7b",
"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-01T22:04:44.7758768+00:00"
},
"modified_dateutc": "2026-09-01T22:04:44.7758768+00:00"
},
"equipment_model_id": "73603a0f-b93f-4f15-87cc-ea3e9032eab6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3bd993d4-d1b6-444f-9e91-1842a68fbcd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "999d1beb-68e1-48f4-848f-8bfdae7a3e33",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7b5a7a04-9b37-4a35-95b2-188b032751bb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3538e78d-501a-47db-b832-d572e19bfe24",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2044ba7f-c668-4c74-84f4-905908c18f50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d415894-a075-4ac1-88ee-3ad29540ed6c",
"db_currency_id": "d7fd293d-5d9f-49fb-90f4-b6b2c65c128a",
"db_language_id": "f3ea71f9-4230-40d8-95f6-b8e3c5726e7b",
"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-01T22:04:44.7758768+00:00"
},
"modified_dateutc": "2026-09-01T22:04:44.7758768+00:00"
},
"equipment_family_id": "5528b476-7421-4fdf-a725-1b4dc58f9a18",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e1eaa7b1-35f9-488d-8d75-6ab02f450eb3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b029e3d2-d638-4b05-8cfe-c132de8f3d51",
"_parent_code": "sample string 6",
"sales_organization_id": "0cc69ecb-96cb-4b0d-a34c-4b2a74b11105",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2044ba7f-c668-4c74-84f4-905908c18f50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d415894-a075-4ac1-88ee-3ad29540ed6c",
"db_currency_id": "d7fd293d-5d9f-49fb-90f4-b6b2c65c128a",
"db_language_id": "f3ea71f9-4230-40d8-95f6-b8e3c5726e7b",
"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-01T22:04:44.7758768+00:00"
},
"modified_dateutc": "2026-09-01T22:04:44.7758768+00:00"
},
"date_in_production_since": "2026-09-01T22:04:44.7758768+00:00",
"date_out_of_production_since": "2026-09-01T22:04:44.7758768+00:00",
"date_end_support": "2026-09-01T22:04:44.7758768+00:00",
"sales_organization_id": "8051004e-a061-4dc4-b820-5fd16d543d48",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2044ba7f-c668-4c74-84f4-905908c18f50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d415894-a075-4ac1-88ee-3ad29540ed6c",
"db_currency_id": "d7fd293d-5d9f-49fb-90f4-b6b2c65c128a",
"db_language_id": "f3ea71f9-4230-40d8-95f6-b8e3c5726e7b",
"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-01T22:04:44.7758768+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-01T22:04:44.7758768+00:00"
},
"project_status_id": "22a8a4e5-39de-4d99-af29-d72a8f4d2536",
"project_status_code": "sample string 10",
"project_status": {
"id": "01cfb6f0-762e-4e2a-9a14-2b54bd5b61b4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c171afd9-c4a7-4fd8-a49e-080112132b80",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2044ba7f-c668-4c74-84f4-905908c18f50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d415894-a075-4ac1-88ee-3ad29540ed6c",
"db_currency_id": "d7fd293d-5d9f-49fb-90f4-b6b2c65c128a",
"db_language_id": "f3ea71f9-4230-40d8-95f6-b8e3c5726e7b",
"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-01T22:04:44.7758768+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-01T22:04:44.7758768+00:00"
},
"company_id": "84b0cb43-c0b7-4534-b6b6-10a140a2733e",
"company_code": "sample string 12",
"db_address_id": "8b684962-47f3-4a9e-804e-39deb6753499",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "129d2fc6-01e7-4da9-9a13-db1b61c36035",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "aa48c45b-5ea6-4e85-a9f0-e7bc482d1b55",
"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-01T22:04:44.7758768+00:00",
"date_create": "2026-09-01T22:04:44.7758768+00:00",
"date_update": "2026-09-01T22:04:44.7758768+00:00",
"updated_by_user_id": "b8d96a38-8e92-4fe4-97bd-76eb4595e021",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-01T22:04:44.7758768+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-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-01T22:04:44.7758768+00:00",
"date_last_job": "2026-09-01T22:04:44.7758768+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-01T22:04:44.7758768+00:00",
"modified_dateutc": "2026-09-01T22:04:44.7758768+00:00",
"is_mobile_installation": true
},
"job_type_id": "0039cd64-09ca-4dd1-a398-5d9d81c3f6e2",
"job_type_code": "sample string 7",
"job_type": {
"id": "4eadf396-1f83-4ea8-beac-75cfa7f8ef97",
"name": "sample string 2",
"sales_organization_id": "d7461b4d-c378-414c-96df-a3451a82d43b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-01T22:04:44.7758768+00:00",
"code": "sample string 7"
},
"job_priority_id": "f7940a9d-b34a-4a06-a8a7-597a63b2d60f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "08e0de78-8903-4e86-865b-b89c1812112c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "96675406-04ee-4d07-be09-8a7c5626652d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2044ba7f-c668-4c74-84f4-905908c18f50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d415894-a075-4ac1-88ee-3ad29540ed6c",
"db_currency_id": "d7fd293d-5d9f-49fb-90f4-b6b2c65c128a",
"db_language_id": "f3ea71f9-4230-40d8-95f6-b8e3c5726e7b",
"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-01T22:04:44.7758768+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-01T22:04:44.7758768+00:00"
},
"job_status_id": "f6157236-9c8c-4e90-90b9-798ad65f4be5",
"job_status_code": "sample string 11",
"db_address_id": "67595dbc-50f1-4555-85c3-742d6622b879",
"contact_id": "372cdec3-a426-4b51-831a-a75cb4e4ece5",
"requested_by_company_id": "52636af3-3d50-4525-88e3-06743d50d6e0",
"requested_by_contact_id": "d0f41462-d67f-4f17-ac0d-61ddfb6ae184",
"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-01T22:04:44.7758768+00:00",
"due_date": "2026-09-01T22:04:44.7758768+00:00",
"date_create": "2026-09-01T22:04:44.7758768+00:00",
"date_update": "2026-09-01T22:04:44.7758768+00:00",
"date_closed": "2026-09-01T22:04:44.7758768+00:00",
"suggested_user_id": "b662f073-5a58-40ce-9b2c-5a157b9fa195",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "884fc227-f5cf-403b-9cde-3f0b4f160ed7",
"db_language_id": "b575a397-5e86-414c-97d9-80136f6ec4ae",
"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-01T22:04:44.7758768+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3804e395-832d-4505-880f-28b8a548ef96",
"sales_organization": {
"id": "2044ba7f-c668-4c74-84f4-905908c18f50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d415894-a075-4ac1-88ee-3ad29540ed6c",
"db_currency_id": "d7fd293d-5d9f-49fb-90f4-b6b2c65c128a",
"db_language_id": "f3ea71f9-4230-40d8-95f6-b8e3c5726e7b",
"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-01T22:04:44.7758768+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "708b715d-5fff-4a99-8866-4ec103a37302",
"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": "383767a5-4e76-4a33-bfae-31cdcfc3b423",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-01T22:04:44.7758768+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "017dc2c0-2454-4e78-ab76-6d12dda05cad"
},
"suggested_date_start": "2026-09-01T22:04:44.7758768+00:00",
"skill_id": "bc0f3794-67c4-4319-9a2c-302c0c5aae0a",
"skill_code": "sample string 32",
"skill": {
"id": "fd14e315-9c56-4246-acb5-e14b23d50023",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "faa5ea6f-92c7-4b8a-bbd0-21e6abf70ef5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2044ba7f-c668-4c74-84f4-905908c18f50",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4d415894-a075-4ac1-88ee-3ad29540ed6c",
"db_currency_id": "d7fd293d-5d9f-49fb-90f4-b6b2c65c128a",
"db_language_id": "f3ea71f9-4230-40d8-95f6-b8e3c5726e7b",
"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-01T22:04:44.7758768+00:00"
},
"modified_dateutc": "2026-09-01T22:04:44.7758768+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "68114bd4-9bd2-432c-8751-532168fbc1ca",
"date_reported_by_company": "2026-09-01T22:04:44.7758768+00:00",
"id2": 36,
"company_id": "8011b3dc-b1c8-4d18-b698-2f2bd300df1c",
"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": "a58c41d8-76b3-4268-879e-db9dbc95f197",
"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-01T22:04:44.7758768+00:00"
},
"work_instruction_details_id": "81f8d02f-1c2f-407a-ba4f-4cf6801b309a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e4a13b23-6831-4b09-9836-d7e501061667",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a3a80768-f005-48c2-bd11-c3b486f5fd80",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-01T22:04:44.7758768+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": "96d9b37d-d4bf-4129-90f5-a1c8ce51d6ee",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-01T22:04:44.7758768+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.