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": "bbf1eb54-bb74-405c-b371-bb39f1c151ac",
"jobs_id": "8ac95e96-22c3-4b94-b7f1-70bf2cf71b25",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f08e571b-2491-4b83-841f-362fdbe3c811",
"_parent_id": "a5e91f28-75c0-459c-bd17-1a54f2c09b6a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9d50a655-6e76-40cc-9912-df76a4f28948",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0e776e60-dcef-4811-b8f7-4c5e30ce8d8d",
"_parent_id": "1cd00f54-101b-49e2-bda5-f71717ffae00",
"root_parent_id": "b17ee5bc-29e8-4239-94ec-4351447d3929",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "34027af9-1a05-46a9-9d83-f632567fd6c8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6ac01ff5-8e86-4e64-9a40-321d59b9bbed",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9303df6d-ac5c-4123-9b41-28801fe4b63f",
"_parent_code": "sample string 6",
"sales_organization_id": "2e31ba42-d6b6-4cd2-87ea-f63592f52dc2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "123fe1e7-2446-4266-9d9c-19024c3c936b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7974af7-2b71-45c5-80fa-03a5cbe3bc07",
"db_currency_id": "a8499e15-c5be-475f-a5ea-e48920db8b42",
"db_language_id": "59a47e86-32a9-45d4-8f03-9f9cda50d198",
"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": "2025-11-12T01:16:07.8452725+00:00"
},
"modified_dateutc": "2025-11-12T01:16:07.8452725+00:00"
},
"equipment_model_id": "93374586-5eec-4235-9c11-ec6fd90ef29a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e940009b-3803-4eb4-87b2-80d9cd82c8c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "abee6a90-710b-446b-8ebd-08d73b36de1c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "950359b8-d051-49a4-ad8e-a10e0ccfdf62",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "743acff0-5e1a-45a7-abf3-25b803a9b047",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "123fe1e7-2446-4266-9d9c-19024c3c936b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7974af7-2b71-45c5-80fa-03a5cbe3bc07",
"db_currency_id": "a8499e15-c5be-475f-a5ea-e48920db8b42",
"db_language_id": "59a47e86-32a9-45d4-8f03-9f9cda50d198",
"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": "2025-11-12T01:16:07.8452725+00:00"
},
"modified_dateutc": "2025-11-12T01:16:07.8452725+00:00"
},
"equipment_family_id": "5ac7c735-3067-4013-a277-733c9e2a70c3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6ac01ff5-8e86-4e64-9a40-321d59b9bbed",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9303df6d-ac5c-4123-9b41-28801fe4b63f",
"_parent_code": "sample string 6",
"sales_organization_id": "2e31ba42-d6b6-4cd2-87ea-f63592f52dc2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "123fe1e7-2446-4266-9d9c-19024c3c936b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7974af7-2b71-45c5-80fa-03a5cbe3bc07",
"db_currency_id": "a8499e15-c5be-475f-a5ea-e48920db8b42",
"db_language_id": "59a47e86-32a9-45d4-8f03-9f9cda50d198",
"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": "2025-11-12T01:16:07.8452725+00:00"
},
"modified_dateutc": "2025-11-12T01:16:07.8452725+00:00"
},
"date_in_production_since": "2025-11-12T01:16:07.8452725+00:00",
"date_out_of_production_since": "2025-11-12T01:16:07.8452725+00:00",
"date_end_support": "2025-11-12T01:16:07.8452725+00:00",
"sales_organization_id": "55138fa3-fee4-4a0e-b2d3-77b98d0ef8ad",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "123fe1e7-2446-4266-9d9c-19024c3c936b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7974af7-2b71-45c5-80fa-03a5cbe3bc07",
"db_currency_id": "a8499e15-c5be-475f-a5ea-e48920db8b42",
"db_language_id": "59a47e86-32a9-45d4-8f03-9f9cda50d198",
"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": "2025-11-12T01:16:07.8452725+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": "2025-11-12T01:16:07.8452725+00:00"
},
"project_status_id": "da985917-0b37-4435-8990-862b31ff3180",
"project_status_code": "sample string 10",
"project_status": {
"id": "db66a7d2-bde2-42b3-a06c-c14ac391c2e6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ea2a8eb8-bd28-4772-9d62-b8f7acb83a6a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "123fe1e7-2446-4266-9d9c-19024c3c936b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7974af7-2b71-45c5-80fa-03a5cbe3bc07",
"db_currency_id": "a8499e15-c5be-475f-a5ea-e48920db8b42",
"db_language_id": "59a47e86-32a9-45d4-8f03-9f9cda50d198",
"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": "2025-11-12T01:16:07.8452725+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-12T01:16:07.8452725+00:00"
},
"company_id": "94f026f3-cd7b-41c2-acf7-e195e030a515",
"company_code": "sample string 12",
"db_address_id": "d9b8e98c-66a8-4b9c-ad22-4be7bcf49ded",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3f8a1917-e39a-4f5d-8b25-305ef6394f9d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b0f69d6d-ee42-4b02-9f27-c236ac061c67",
"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": "2025-11-12T01:16:07.8452725+00:00",
"date_create": "2025-11-12T01:16:07.8452725+00:00",
"date_update": "2025-11-12T01:16:07.8452725+00:00",
"updated_by_user_id": "fb217cfc-601d-4f9e-9e95-bed5da5b0492",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-12T01:16:07.8452725+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": "2025-11-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-12T01:16:07.8452725+00:00",
"date_last_job": "2025-11-12T01:16:07.8452725+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-12T01:16:07.8452725+00:00",
"modified_dateutc": "2025-11-12T01:16:07.8452725+00:00",
"is_mobile_installation": true
},
"job_type_id": "52612efd-6491-4323-8b18-7c8c2ba527b1",
"job_type_code": "sample string 7",
"job_type": {
"id": "4eb3f3d9-0333-42f5-adfc-9d4641f76d92",
"name": "sample string 2",
"sales_organization_id": "5e1ac198-3239-4c99-b54b-a49d29d22257",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-12T01:16:07.8452725+00:00",
"code": "sample string 7"
},
"job_priority_id": "ad9acb9a-06d6-4594-9125-5b6662b097f4",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3b2d7306-f9be-4672-bde3-9ed7130960c7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ca43264f-33c7-4e29-88eb-aebde7cbe56b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "123fe1e7-2446-4266-9d9c-19024c3c936b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7974af7-2b71-45c5-80fa-03a5cbe3bc07",
"db_currency_id": "a8499e15-c5be-475f-a5ea-e48920db8b42",
"db_language_id": "59a47e86-32a9-45d4-8f03-9f9cda50d198",
"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": "2025-11-12T01:16:07.8452725+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-12T01:16:07.8452725+00:00"
},
"job_status_id": "5cdd65aa-42e9-4b15-a79f-11fc35460e06",
"job_status_code": "sample string 11",
"db_address_id": "86797d0a-eb55-45d4-a0a0-1296c662953a",
"contact_id": "35e892af-5987-4f78-9ef9-bbf622acfaef",
"requested_by_company_id": "bc305fbc-7177-47ee-a275-527e30e03bb1",
"requested_by_contact_id": "e65b82b0-e6b7-426d-bef9-e252926f1903",
"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": "2025-11-12T01:16:07.8452725+00:00",
"due_date": "2025-11-12T01:16:07.8452725+00:00",
"date_create": "2025-11-12T01:16:07.8452725+00:00",
"date_update": "2025-11-12T01:16:07.8452725+00:00",
"date_closed": "2025-11-12T01:16:07.8452725+00:00",
"suggested_user_id": "f0eeba0c-5273-4e1e-9b71-3923051e5584",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7f72d98d-858d-4e1f-8a14-be1a5278ceba",
"db_language_id": "38aea96f-5ffe-4b82-9929-58425f3980ba",
"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": "2025-11-12T01:16:07.8452725+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c78b16a5-2295-4e80-9160-7e94a0e57403",
"sales_organization": {
"id": "123fe1e7-2446-4266-9d9c-19024c3c936b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7974af7-2b71-45c5-80fa-03a5cbe3bc07",
"db_currency_id": "a8499e15-c5be-475f-a5ea-e48920db8b42",
"db_language_id": "59a47e86-32a9-45d4-8f03-9f9cda50d198",
"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": "2025-11-12T01:16:07.8452725+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a6d9fc4a-eed7-482a-b589-7562a433b7c6",
"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": "286470fa-8b98-492e-8c15-b6ab78fb34c5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-12T01:16:07.8452725+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3f6eef83-8f03-4128-a21b-46388cfe83fb"
},
"suggested_date_start": "2025-11-12T01:16:07.8452725+00:00",
"skill_id": "55f24320-6d57-4226-9551-3fe61e53c707",
"skill_code": "sample string 32",
"skill": {
"id": "df6de04b-e374-4166-9b66-5a28f3b091c1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "264546b6-9f18-471d-83bb-9281199e3c32",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "123fe1e7-2446-4266-9d9c-19024c3c936b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e7974af7-2b71-45c5-80fa-03a5cbe3bc07",
"db_currency_id": "a8499e15-c5be-475f-a5ea-e48920db8b42",
"db_language_id": "59a47e86-32a9-45d4-8f03-9f9cda50d198",
"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": "2025-11-12T01:16:07.8452725+00:00"
},
"modified_dateutc": "2025-11-12T01:16:07.8452725+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a9fdbf2e-bca3-4a79-8cea-3a7fb11b0f16",
"date_reported_by_company": "2025-11-12T01:16:07.8452725+00:00",
"id2": 36,
"company_id": "2bfcce18-30f1-462c-96ab-5ad4f4ca0da1",
"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": "b273609a-918b-4c7d-bf70-35aeed986dba",
"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": "2025-11-12T01:16:07.8452725+00:00"
},
"work_instruction_details_id": "fbca93b1-59cf-4fe4-8cc8-dba7db9db6d1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0a2a9791-db32-4803-8d17-b68d6ce0728d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4d5bd01f-cfb7-431d-8fe0-6361cd652bc6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-12T01:16:07.8452725+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": "dec49c1f-d0b2-4840-bfa1-62a7cc519004",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-12T01:16:07.8452725+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.