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": "42918221-ab5e-4402-bc93-1be89b6032ca",
"jobs_id": "fa247000-3245-44fd-8cc4-44781c9ec68c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "390cbea8-9bb5-48e5-9e20-ac4c236b2adb",
"_parent_id": "09914cf0-9c4c-4db2-bd31-2a65f0afc03f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b0f929fc-efba-40da-8399-4785447097ef",
"project_reference_back_office": "sample string 5",
"project": {
"id": "920e5687-6fb6-4ca5-bdc2-6e3fedba7433",
"_parent_id": "5cfba72c-6de3-4e96-88cb-f99133dfb896",
"root_parent_id": "35c85d33-16ef-4d25-a2aa-bb1416105713",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ad7ea369-4295-443d-9402-b4b342243741",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ce07fd03-f8c6-4fe9-8a74-3e67d8dbc68f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d79b37ee-a4c6-4c5e-a3b6-dda29f64332f",
"_parent_code": "sample string 6",
"sales_organization_id": "7e1e6b5e-3e79-4d74-a1da-83860c76aa2a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bd9d022c-c4cd-4ae1-9852-9a32a62e5efa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86a0c9c4-ed4a-4065-8997-ab118dde74cd",
"db_currency_id": "a19723ed-dd18-45dc-90cf-300f73cfdc7d",
"db_language_id": "88195bff-4b8c-44d9-9bc2-cbe0bbc6c6b4",
"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-28T08:42:15.9016667+00:00"
},
"modified_dateutc": "2025-11-28T08:42:15.9016667+00:00"
},
"equipment_model_id": "0148f0e2-fa2c-41ba-b621-997f6951009f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "42547998-28b8-40ec-9b54-42120b56eb37",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c93e9794-6a57-4582-a711-b408e7e2c648",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fde12cd0-e062-43d2-b2ef-3d8474f4d213",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fef59145-3768-400f-ab5b-99f911d23aa4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bd9d022c-c4cd-4ae1-9852-9a32a62e5efa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86a0c9c4-ed4a-4065-8997-ab118dde74cd",
"db_currency_id": "a19723ed-dd18-45dc-90cf-300f73cfdc7d",
"db_language_id": "88195bff-4b8c-44d9-9bc2-cbe0bbc6c6b4",
"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-28T08:42:15.9016667+00:00"
},
"modified_dateutc": "2025-11-28T08:42:15.9016667+00:00"
},
"equipment_family_id": "bb164914-284d-4a15-a77a-27019555ad24",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ce07fd03-f8c6-4fe9-8a74-3e67d8dbc68f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d79b37ee-a4c6-4c5e-a3b6-dda29f64332f",
"_parent_code": "sample string 6",
"sales_organization_id": "7e1e6b5e-3e79-4d74-a1da-83860c76aa2a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bd9d022c-c4cd-4ae1-9852-9a32a62e5efa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86a0c9c4-ed4a-4065-8997-ab118dde74cd",
"db_currency_id": "a19723ed-dd18-45dc-90cf-300f73cfdc7d",
"db_language_id": "88195bff-4b8c-44d9-9bc2-cbe0bbc6c6b4",
"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-28T08:42:15.9016667+00:00"
},
"modified_dateutc": "2025-11-28T08:42:15.9016667+00:00"
},
"date_in_production_since": "2025-11-28T08:42:15.9016667+00:00",
"date_out_of_production_since": "2025-11-28T08:42:15.9016667+00:00",
"date_end_support": "2025-11-28T08:42:15.9016667+00:00",
"sales_organization_id": "24082f5a-78ac-453d-9c12-ff01dbfabcbb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "bd9d022c-c4cd-4ae1-9852-9a32a62e5efa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86a0c9c4-ed4a-4065-8997-ab118dde74cd",
"db_currency_id": "a19723ed-dd18-45dc-90cf-300f73cfdc7d",
"db_language_id": "88195bff-4b8c-44d9-9bc2-cbe0bbc6c6b4",
"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-28T08:42:15.9016667+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-28T08:42:15.9016667+00:00"
},
"project_status_id": "b938f5fe-1e0b-4a0e-83a8-006676cff053",
"project_status_code": "sample string 10",
"project_status": {
"id": "a5e40dd3-f215-4fe8-aa7b-fd1345810aea",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "328c8294-0c04-46b9-b3de-4ffa4d5c8113",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bd9d022c-c4cd-4ae1-9852-9a32a62e5efa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86a0c9c4-ed4a-4065-8997-ab118dde74cd",
"db_currency_id": "a19723ed-dd18-45dc-90cf-300f73cfdc7d",
"db_language_id": "88195bff-4b8c-44d9-9bc2-cbe0bbc6c6b4",
"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-28T08:42:15.9016667+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-28T08:42:15.9016667+00:00"
},
"company_id": "8108df4f-b139-48ac-ae7e-a15fe53ff3b3",
"company_code": "sample string 12",
"db_address_id": "5e18b4f9-0fac-432a-8385-46679b960a2b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "83c2f47a-26bf-43d9-9b00-0e91bc439156",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "580e198d-c42b-45df-a86e-a7e3c1c4fb62",
"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-28T08:42:15.9016667+00:00",
"date_create": "2025-11-28T08:42:15.9016667+00:00",
"date_update": "2025-11-28T08:42:15.9016667+00:00",
"updated_by_user_id": "8b5cbee9-4257-4648-8c92-a06ab516b631",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-28T08:42:15.9016667+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-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-28T08:42:15.9016667+00:00",
"date_last_job": "2025-11-28T08:42:15.9016667+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-28T08:42:15.9016667+00:00",
"modified_dateutc": "2025-11-28T08:42:15.9016667+00:00",
"is_mobile_installation": true
},
"job_type_id": "0ace33f9-fcdf-4bbd-aaf2-b2851efd4880",
"job_type_code": "sample string 7",
"job_type": {
"id": "24325c3b-16ce-472c-a077-f53b9472a695",
"name": "sample string 2",
"sales_organization_id": "09b4b34a-608c-4d96-a89d-2b1fb7b27810",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-28T08:42:15.9016667+00:00",
"code": "sample string 7"
},
"job_priority_id": "de133156-2937-4daa-a5b5-23fa8d941202",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fe2eaa5b-9296-4707-96cf-0299cc0ee704",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5fa83c2a-09b2-47c7-b111-97a2457e6d02",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bd9d022c-c4cd-4ae1-9852-9a32a62e5efa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86a0c9c4-ed4a-4065-8997-ab118dde74cd",
"db_currency_id": "a19723ed-dd18-45dc-90cf-300f73cfdc7d",
"db_language_id": "88195bff-4b8c-44d9-9bc2-cbe0bbc6c6b4",
"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-28T08:42:15.9016667+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-28T08:42:15.9172928+00:00"
},
"job_status_id": "36440cb3-65a6-46c0-9c58-c56daebb9e2a",
"job_status_code": "sample string 11",
"db_address_id": "ecd4cf79-9714-4d6e-ac8c-bfec07efc7da",
"contact_id": "8aeb5203-c235-43fb-9f52-c018d98c7b67",
"requested_by_company_id": "da8d34c6-d00c-4ead-85c8-ae8944457850",
"requested_by_contact_id": "d19b2d55-6034-48a2-b454-8c3fd67c869e",
"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-28T08:42:15.9172928+00:00",
"due_date": "2025-11-28T08:42:15.9172928+00:00",
"date_create": "2025-11-28T08:42:15.9172928+00:00",
"date_update": "2025-11-28T08:42:15.9172928+00:00",
"date_closed": "2025-11-28T08:42:15.9172928+00:00",
"suggested_user_id": "a7c148bc-4fe3-4d44-b7c1-dc000381592c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6c3f4dbb-3e4b-460c-a3e1-0cc10ff4f9a1",
"db_language_id": "eda56152-a4bc-4fac-8490-f8c0689214b3",
"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-28T08:42:15.9172928+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7c72cadd-f6a8-4d6e-bca3-be54b18af474",
"sales_organization": {
"id": "bd9d022c-c4cd-4ae1-9852-9a32a62e5efa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86a0c9c4-ed4a-4065-8997-ab118dde74cd",
"db_currency_id": "a19723ed-dd18-45dc-90cf-300f73cfdc7d",
"db_language_id": "88195bff-4b8c-44d9-9bc2-cbe0bbc6c6b4",
"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-28T08:42:15.9016667+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fe654a27-c64c-4c4b-b018-48ff2e3687f2",
"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": "0ec2bc09-5664-498a-9310-94c79214f6bd",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-28T08:42:15.9172928+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4ec5cf24-b1ca-4fc7-83e0-cb22c3b4af9c"
},
"suggested_date_start": "2025-11-28T08:42:15.9172928+00:00",
"skill_id": "25dd07dc-657c-4148-9722-914659c01ccc",
"skill_code": "sample string 32",
"skill": {
"id": "db307049-37e0-4264-bd2b-b450bd6ebe0f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "700c1f63-5d75-4481-8104-7b63aa44cd46",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bd9d022c-c4cd-4ae1-9852-9a32a62e5efa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86a0c9c4-ed4a-4065-8997-ab118dde74cd",
"db_currency_id": "a19723ed-dd18-45dc-90cf-300f73cfdc7d",
"db_language_id": "88195bff-4b8c-44d9-9bc2-cbe0bbc6c6b4",
"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-28T08:42:15.9016667+00:00"
},
"modified_dateutc": "2025-11-28T08:42:15.9172928+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "006512e6-a32e-4b8b-9934-7962b73d92d1",
"date_reported_by_company": "2025-11-28T08:42:15.9172928+00:00",
"id2": 36,
"company_id": "ed85ebb6-ef8a-42a5-a2a5-d548e90cf151",
"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": "ba730fa5-2ec2-47a2-a2b4-5d7e06ab58ae",
"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-28T08:42:15.9172928+00:00"
},
"work_instruction_details_id": "2976feaa-54d4-4c77-a01c-4a67824cd18a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f5ded134-2393-4f10-b47f-ecc2d11f4958",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "af1d2380-5850-467c-b603-887383e5db1e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-28T08:42:15.9172928+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": "deed5bf2-3888-4eed-8459-463dd31d0b72",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-28T08:42:15.9172928+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.