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": "86e093ba-ad7c-4d75-af2b-c20f8c888c3f",
"jobs_id": "be04bcb4-b7a9-4911-80cc-6199e98703b4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3b5f8418-b62c-4872-9ee7-e9b669d782c7",
"_parent_id": "f257db15-ddb9-4f99-913a-d97c9ec2f855",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8903a562-464a-4f00-bf8f-af983ef06e74",
"project_reference_back_office": "sample string 5",
"project": {
"id": "67ce0c34-abba-40a1-a087-22753fd4c995",
"_parent_id": "5756dbc9-e824-4a08-8822-da8712d2d68a",
"root_parent_id": "00373916-03fa-41ce-b7b4-43420a3ad52e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "14efc9c1-c7e6-4aa5-aa5d-35b7c07edd63",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "30e5183a-28c2-4dc4-b4d2-97ac8c77166b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ed1c9d81-e5e2-4c14-9035-574983c273cb",
"_parent_code": "sample string 6",
"sales_organization_id": "ae818014-8f0c-4526-9846-b0e3c7d6ee05",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6cd370e2-babf-4bb0-935c-b84d91f553a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b99385f0-9959-4196-b1a7-f87e36a5eb28",
"db_currency_id": "ee6e43c7-aeb2-4a10-8998-3965882124df",
"db_language_id": "cf115161-799f-4159-97e1-b9665ceb6325",
"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-08T01:04:35.5834276+00:00"
},
"modified_dateutc": "2026-09-08T01:04:35.5834276+00:00"
},
"equipment_model_id": "d5109ff3-38c1-46ca-8b26-8ccf946272a7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "74b6532e-596e-401b-bb8a-0de394ce49a9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ca175929-04e0-422a-87b9-3ca257fad85f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e7f65d62-7693-4ca7-ba15-246a5b5d15f5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "099dc3fa-7f5a-4e24-b25f-fed6f11c7926",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6cd370e2-babf-4bb0-935c-b84d91f553a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b99385f0-9959-4196-b1a7-f87e36a5eb28",
"db_currency_id": "ee6e43c7-aeb2-4a10-8998-3965882124df",
"db_language_id": "cf115161-799f-4159-97e1-b9665ceb6325",
"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-08T01:04:35.5834276+00:00"
},
"modified_dateutc": "2026-09-08T01:04:35.5834276+00:00"
},
"equipment_family_id": "76df1f97-c546-419f-ba3e-8d67e186c129",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "30e5183a-28c2-4dc4-b4d2-97ac8c77166b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ed1c9d81-e5e2-4c14-9035-574983c273cb",
"_parent_code": "sample string 6",
"sales_organization_id": "ae818014-8f0c-4526-9846-b0e3c7d6ee05",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6cd370e2-babf-4bb0-935c-b84d91f553a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b99385f0-9959-4196-b1a7-f87e36a5eb28",
"db_currency_id": "ee6e43c7-aeb2-4a10-8998-3965882124df",
"db_language_id": "cf115161-799f-4159-97e1-b9665ceb6325",
"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-08T01:04:35.5834276+00:00"
},
"modified_dateutc": "2026-09-08T01:04:35.5834276+00:00"
},
"date_in_production_since": "2026-09-08T01:04:35.5834276+00:00",
"date_out_of_production_since": "2026-09-08T01:04:35.5834276+00:00",
"date_end_support": "2026-09-08T01:04:35.5834276+00:00",
"sales_organization_id": "1a917392-7ee0-4538-9549-442aa918580e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6cd370e2-babf-4bb0-935c-b84d91f553a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b99385f0-9959-4196-b1a7-f87e36a5eb28",
"db_currency_id": "ee6e43c7-aeb2-4a10-8998-3965882124df",
"db_language_id": "cf115161-799f-4159-97e1-b9665ceb6325",
"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-08T01:04:35.5834276+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-08T01:04:35.599052+00:00"
},
"project_status_id": "3a6839e2-156a-4655-8071-0c67fb187781",
"project_status_code": "sample string 10",
"project_status": {
"id": "2e1305f0-5e3d-43de-824a-33f3f9a0fb13",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "35ad97a0-9051-47d1-b3e9-0ca0ce0c51df",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6cd370e2-babf-4bb0-935c-b84d91f553a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b99385f0-9959-4196-b1a7-f87e36a5eb28",
"db_currency_id": "ee6e43c7-aeb2-4a10-8998-3965882124df",
"db_language_id": "cf115161-799f-4159-97e1-b9665ceb6325",
"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-08T01:04:35.5834276+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-08T01:04:35.599052+00:00"
},
"company_id": "9ccd9722-a3d1-42a9-9bd8-9b056221cf2f",
"company_code": "sample string 12",
"db_address_id": "f44d1e38-e740-4e9b-83f0-4008d8818943",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "94adee4d-418c-431e-98cd-d02380bc03c8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "79bc65f3-c1c1-456b-b732-007abcde5ad4",
"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-08T01:04:35.599052+00:00",
"date_create": "2026-09-08T01:04:35.599052+00:00",
"date_update": "2026-09-08T01:04:35.599052+00:00",
"updated_by_user_id": "ae9e179c-a18b-412c-9f7c-6b6c664c1cdf",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-08T01:04:35.599052+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-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-08T01:04:35.599052+00:00",
"date_last_job": "2026-09-08T01:04:35.599052+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-08T01:04:35.599052+00:00",
"modified_dateutc": "2026-09-08T01:04:35.599052+00:00",
"is_mobile_installation": true
},
"job_type_id": "33849c9b-0be9-4703-9e86-023f719d9b09",
"job_type_code": "sample string 7",
"job_type": {
"id": "83d88ad5-8214-4ecb-926e-94193144fcdc",
"name": "sample string 2",
"sales_organization_id": "beb4b4ad-e752-44d2-87ea-56e6ef0985e8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-08T01:04:35.599052+00:00",
"code": "sample string 7"
},
"job_priority_id": "33013129-afd9-4e6a-8a3a-79f9e4300ddb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "814b8a97-93a7-427e-b8cf-e220b07be5f3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1de9a6d0-24d3-453d-9119-2678959bb2b0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6cd370e2-babf-4bb0-935c-b84d91f553a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b99385f0-9959-4196-b1a7-f87e36a5eb28",
"db_currency_id": "ee6e43c7-aeb2-4a10-8998-3965882124df",
"db_language_id": "cf115161-799f-4159-97e1-b9665ceb6325",
"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-08T01:04:35.5834276+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-08T01:04:35.599052+00:00"
},
"job_status_id": "5fe5593f-558b-47b9-8427-d61fdc35b350",
"job_status_code": "sample string 11",
"db_address_id": "c519fd37-a6d9-4c1c-9406-29d11681c9b7",
"contact_id": "52befc26-e52c-490d-b04c-732a7b016c51",
"requested_by_company_id": "3b754a4a-7d41-4832-9897-2f756e0f3be5",
"requested_by_contact_id": "ffed6872-c098-47e1-8b3c-0009ff799cc0",
"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-08T01:04:35.599052+00:00",
"due_date": "2026-09-08T01:04:35.599052+00:00",
"date_create": "2026-09-08T01:04:35.599052+00:00",
"date_update": "2026-09-08T01:04:35.599052+00:00",
"date_closed": "2026-09-08T01:04:35.599052+00:00",
"suggested_user_id": "c4f279b0-3a71-4643-a504-caa3a633017b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "62ff100c-5c03-42e8-83b6-ac08300be508",
"db_language_id": "a31037f2-873d-45bb-899d-ad105e111c80",
"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-08T01:04:35.599052+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c790b3dd-f89c-45ce-b9ab-914d7359dd84",
"sales_organization": {
"id": "6cd370e2-babf-4bb0-935c-b84d91f553a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b99385f0-9959-4196-b1a7-f87e36a5eb28",
"db_currency_id": "ee6e43c7-aeb2-4a10-8998-3965882124df",
"db_language_id": "cf115161-799f-4159-97e1-b9665ceb6325",
"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-08T01:04:35.5834276+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8bdd864b-eb02-49e2-9304-78a654c9237d",
"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": "e1443c94-a0e4-45a9-b04b-cd6d286d5ba2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-08T01:04:35.599052+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e906c521-dae4-4393-a14d-dfd6e4e5612f"
},
"suggested_date_start": "2026-09-08T01:04:35.599052+00:00",
"skill_id": "a7d7d83f-92d8-44db-9fb8-03d4a4ef36ce",
"skill_code": "sample string 32",
"skill": {
"id": "463e903d-f74e-4bf6-b71d-951b367f3d8d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1612ffbf-b9fa-4077-8d05-71fa5e986971",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6cd370e2-babf-4bb0-935c-b84d91f553a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b99385f0-9959-4196-b1a7-f87e36a5eb28",
"db_currency_id": "ee6e43c7-aeb2-4a10-8998-3965882124df",
"db_language_id": "cf115161-799f-4159-97e1-b9665ceb6325",
"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-08T01:04:35.5834276+00:00"
},
"modified_dateutc": "2026-09-08T01:04:35.599052+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "dccf5ffd-aaba-4400-92d1-43506cb9cbc3",
"date_reported_by_company": "2026-09-08T01:04:35.599052+00:00",
"id2": 36,
"company_id": "53ec8199-95af-42ec-8d9c-3e1da74b336c",
"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": "242bcc06-e28d-41dc-9c8a-3a6052c92224",
"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-08T01:04:35.599052+00:00"
},
"work_instruction_details_id": "a84eb68e-573c-4836-a533-5bcf8f966f5f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1538f57d-b328-45fc-b32d-c26b69b44822",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ff4ae337-df3c-4e24-b5d9-304d81997c8c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-08T01:04:35.599052+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": "c2c1e4c8-0fc1-433c-b01b-563f521eb3e9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-08T01:04:35.599052+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.