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": "28440c88-228c-4ab8-a46f-66399a40fa10",
"jobs_id": "4a4db214-8a5b-422e-9209-8cd6a9a38f25",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7fe25c47-7a92-42d2-81b7-6a96d684404f",
"_parent_id": "31372dd6-c82d-4946-9f9b-edfdea994cdb",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "36331b59-1f19-4191-9c0e-ee5a52b6347f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "291b3a60-00ce-4a84-9c10-83edb1062232",
"_parent_id": "bc89e1a4-6095-48e3-9a80-5e7f24dbc393",
"root_parent_id": "daee31aa-575a-4039-89e2-d5b6d3fc60ba",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3702f4fa-8116-43af-a7aa-06c3dd0b2d7f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6087b8a9-da71-4e2c-b267-184547442220",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b14dc82f-0b1e-4ea5-9209-4d8248c11d78",
"_parent_code": "sample string 6",
"sales_organization_id": "e5847528-ae09-48dc-9230-e3535307437c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a5d4da95-810f-4cac-8b8e-fc14a10e3011",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47211276-4764-4d4f-b4bb-b59db4608c72",
"db_currency_id": "841a86d3-5b22-418b-9125-b302fdafd6ab",
"db_language_id": "10dce367-4e12-4642-95fb-2421e0e946b2",
"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-01-01T17:16:59.2786573+00:00"
},
"modified_dateutc": "2026-01-01T17:16:59.2786573+00:00"
},
"equipment_model_id": "afadfa78-cc36-46d2-8cbc-ac98ab62acd2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "736457d0-345e-4088-98d9-c3d18af41aeb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a64d215c-e34b-4b8f-9988-cd5b143d0593",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "416d88dd-269f-4cd4-abee-37b46a50f7c1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d948cc60-d0d4-4441-a9e7-eea8c4b805ce",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a5d4da95-810f-4cac-8b8e-fc14a10e3011",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47211276-4764-4d4f-b4bb-b59db4608c72",
"db_currency_id": "841a86d3-5b22-418b-9125-b302fdafd6ab",
"db_language_id": "10dce367-4e12-4642-95fb-2421e0e946b2",
"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-01-01T17:16:59.2786573+00:00"
},
"modified_dateutc": "2026-01-01T17:16:59.2786573+00:00"
},
"equipment_family_id": "23cccb5c-644e-4e96-b8b0-ae763a321689",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6087b8a9-da71-4e2c-b267-184547442220",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b14dc82f-0b1e-4ea5-9209-4d8248c11d78",
"_parent_code": "sample string 6",
"sales_organization_id": "e5847528-ae09-48dc-9230-e3535307437c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a5d4da95-810f-4cac-8b8e-fc14a10e3011",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47211276-4764-4d4f-b4bb-b59db4608c72",
"db_currency_id": "841a86d3-5b22-418b-9125-b302fdafd6ab",
"db_language_id": "10dce367-4e12-4642-95fb-2421e0e946b2",
"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-01-01T17:16:59.2786573+00:00"
},
"modified_dateutc": "2026-01-01T17:16:59.2786573+00:00"
},
"date_in_production_since": "2026-01-01T17:16:59.2786573+00:00",
"date_out_of_production_since": "2026-01-01T17:16:59.2786573+00:00",
"date_end_support": "2026-01-01T17:16:59.2786573+00:00",
"sales_organization_id": "939e7bc4-f2e2-4d0b-a9c5-acdcaabfafd3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a5d4da95-810f-4cac-8b8e-fc14a10e3011",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47211276-4764-4d4f-b4bb-b59db4608c72",
"db_currency_id": "841a86d3-5b22-418b-9125-b302fdafd6ab",
"db_language_id": "10dce367-4e12-4642-95fb-2421e0e946b2",
"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-01-01T17:16:59.2786573+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-01-01T17:16:59.2786573+00:00"
},
"project_status_id": "c6235e2c-6e5e-4307-b2a7-aaf805e7fcf5",
"project_status_code": "sample string 10",
"project_status": {
"id": "6ff1b034-4cfe-44b4-bb3a-2dd777e2581e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "74203140-3c5f-4431-8120-2f9d7b99663d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a5d4da95-810f-4cac-8b8e-fc14a10e3011",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47211276-4764-4d4f-b4bb-b59db4608c72",
"db_currency_id": "841a86d3-5b22-418b-9125-b302fdafd6ab",
"db_language_id": "10dce367-4e12-4642-95fb-2421e0e946b2",
"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-01-01T17:16:59.2786573+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-01T17:16:59.2786573+00:00"
},
"company_id": "126d80ea-18fc-4fb4-be55-7ffdfeef04dd",
"company_code": "sample string 12",
"db_address_id": "6ec639ee-ac66-4508-950c-0bf438cb5c05",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "774859dc-3086-4ce5-a862-80c1bba3e957",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1c3bc799-b39e-4130-bbfa-55b63154345d",
"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-01-01T17:16:59.2786573+00:00",
"date_create": "2026-01-01T17:16:59.2786573+00:00",
"date_update": "2026-01-01T17:16:59.2786573+00:00",
"updated_by_user_id": "81eeb179-18b9-445f-8fc3-9caff0973947",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-01T17:16:59.2786573+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-01-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-01T17:16:59.2786573+00:00",
"date_last_job": "2026-01-01T17:16:59.2786573+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-01T17:16:59.2786573+00:00",
"modified_dateutc": "2026-01-01T17:16:59.2786573+00:00",
"is_mobile_installation": true
},
"job_type_id": "6b30ab3d-b77e-4cf4-92c8-f5a2a33c215d",
"job_type_code": "sample string 7",
"job_type": {
"id": "44cae73f-f66b-4bab-9468-b42e1ec624bf",
"name": "sample string 2",
"sales_organization_id": "c4a485fe-dd62-4164-b08d-51fb9ce52f21",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-01T17:16:59.2786573+00:00",
"code": "sample string 7"
},
"job_priority_id": "7e66a195-8d80-411c-a145-3e7735de3e38",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "06b1455c-f463-4383-9f58-d039066a4c5d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7d81b530-a3be-4b81-b5ba-d08edd3ba32c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a5d4da95-810f-4cac-8b8e-fc14a10e3011",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47211276-4764-4d4f-b4bb-b59db4608c72",
"db_currency_id": "841a86d3-5b22-418b-9125-b302fdafd6ab",
"db_language_id": "10dce367-4e12-4642-95fb-2421e0e946b2",
"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-01-01T17:16:59.2786573+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-01T17:16:59.2786573+00:00"
},
"job_status_id": "9200f320-1571-446b-8329-1d456b7ab3ed",
"job_status_code": "sample string 11",
"db_address_id": "01cbf6ae-8b91-4375-a67c-9e1d40081002",
"contact_id": "b377c54d-54d6-4cc1-ad45-dbc79d2eba6a",
"requested_by_company_id": "ac6a9ac0-5496-4d73-84ce-5d976e07db61",
"requested_by_contact_id": "6cbdbdcd-7489-4e2e-8dbd-2705a241c558",
"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-01-01T17:16:59.2786573+00:00",
"due_date": "2026-01-01T17:16:59.2786573+00:00",
"date_create": "2026-01-01T17:16:59.2786573+00:00",
"date_update": "2026-01-01T17:16:59.2786573+00:00",
"date_closed": "2026-01-01T17:16:59.2786573+00:00",
"suggested_user_id": "cc151277-978b-48e6-9918-6b74d3877adb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2c11fdad-441b-45fc-a4e6-4dfd5d0abd1c",
"db_language_id": "6c67f86b-8c45-43d4-b465-a615d2693f02",
"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-01-01T17:16:59.2786573+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8f0455ef-39a6-455e-83c9-5f4f6ad9ee9a",
"sales_organization": {
"id": "a5d4da95-810f-4cac-8b8e-fc14a10e3011",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47211276-4764-4d4f-b4bb-b59db4608c72",
"db_currency_id": "841a86d3-5b22-418b-9125-b302fdafd6ab",
"db_language_id": "10dce367-4e12-4642-95fb-2421e0e946b2",
"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-01-01T17:16:59.2786573+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0eb1304c-a72f-4746-8588-1b1f142aa4aa",
"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": "02222813-21cb-4c7f-9802-e3a733bdaee8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-01T17:16:59.2786573+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7edf19e2-2e5a-4621-9373-077a78a7291c"
},
"suggested_date_start": "2026-01-01T17:16:59.2786573+00:00",
"skill_id": "5ed63136-9cb7-4afc-8b95-d679105f466d",
"skill_code": "sample string 32",
"skill": {
"id": "7d4f1d03-49f8-455a-a448-65267e3cf229",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2ef6c063-0d44-4612-be6a-79f8b8740df3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a5d4da95-810f-4cac-8b8e-fc14a10e3011",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "47211276-4764-4d4f-b4bb-b59db4608c72",
"db_currency_id": "841a86d3-5b22-418b-9125-b302fdafd6ab",
"db_language_id": "10dce367-4e12-4642-95fb-2421e0e946b2",
"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-01-01T17:16:59.2786573+00:00"
},
"modified_dateutc": "2026-01-01T17:16:59.2786573+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "72fc6a65-abc7-4e51-9712-e8da101ccd3e",
"date_reported_by_company": "2026-01-01T17:16:59.2786573+00:00",
"id2": 36,
"company_id": "64d3bba3-a982-4112-932b-3e119b0001b2",
"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": "9530b869-fa41-47a7-af43-9d3cf8eb2995",
"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-01-01T17:16:59.2786573+00:00"
},
"work_instruction_details_id": "d9deff8e-ff90-44a8-bcfc-aeca8257e798",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2d74334e-8bc2-401b-abd7-08a7699e479d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "20651714-78dc-442a-97d4-9463e0b93fad",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-01T17:16:59.2786573+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": "c0bca3a4-b806-4ac4-8a39-451581d81264",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-01T17:16:59.2786573+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.