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": "1fd7210d-d55d-45a2-8264-943bfe368ccf",
"jobs_id": "0dbb5ed5-ef02-4557-a2f7-9b6abfa7f9dc",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "cbb38ba5-acea-49b2-befa-2e32d3074e85",
"_parent_id": "47c6ad40-0666-4601-a8f5-4a5bc2f98906",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6a906f3d-5ef4-470a-8391-3b352ff911b6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1c6d8bd5-3c79-47ee-af52-22cfc8070bfb",
"_parent_id": "03b59dbe-8c81-4b96-80a7-69d1c7a5027c",
"root_parent_id": "ef45f9d6-c538-4014-bfec-3428ef4dcd9e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "32c6d394-4608-40a6-829d-e95610c0a9f4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f920b921-94c0-42c6-8e8f-0bd9880d9ae7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5ace7b4e-c258-4599-b820-f8a0059c6af0",
"_parent_code": "sample string 6",
"sales_organization_id": "bbfcff62-8f2b-423d-8a57-c143bf4d01b6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fb99175b-3313-4516-86b1-3b1e882e9856",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d633775-db83-4ab9-9507-b0a0b3ca0aa4",
"db_currency_id": "edcbd1e7-2c8e-4f70-aeae-444a8e83d2d4",
"db_language_id": "479be8f4-5339-4c70-a0b1-273aa2ba4665",
"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-11-06T18:16:24.6736348+00:00"
},
"modified_dateutc": "2026-11-06T18:16:24.6736348+00:00"
},
"equipment_model_id": "3de631f8-46a7-422d-b754-e01e575deebe",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6efd2d14-7742-474d-8343-d4b324847503",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8ce155a1-5f17-42c7-a058-823c802c2d69",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1700b5ee-137f-4257-bb21-b6f56f9e1361",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c06ad8fc-f672-4547-b42f-9f87cd736dfb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fb99175b-3313-4516-86b1-3b1e882e9856",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d633775-db83-4ab9-9507-b0a0b3ca0aa4",
"db_currency_id": "edcbd1e7-2c8e-4f70-aeae-444a8e83d2d4",
"db_language_id": "479be8f4-5339-4c70-a0b1-273aa2ba4665",
"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-11-06T18:16:24.6736348+00:00"
},
"modified_dateutc": "2026-11-06T18:16:24.6736348+00:00"
},
"equipment_family_id": "32d571d7-df90-41cc-a8ac-d1e3fc73d827",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f920b921-94c0-42c6-8e8f-0bd9880d9ae7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5ace7b4e-c258-4599-b820-f8a0059c6af0",
"_parent_code": "sample string 6",
"sales_organization_id": "bbfcff62-8f2b-423d-8a57-c143bf4d01b6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fb99175b-3313-4516-86b1-3b1e882e9856",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d633775-db83-4ab9-9507-b0a0b3ca0aa4",
"db_currency_id": "edcbd1e7-2c8e-4f70-aeae-444a8e83d2d4",
"db_language_id": "479be8f4-5339-4c70-a0b1-273aa2ba4665",
"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-11-06T18:16:24.6736348+00:00"
},
"modified_dateutc": "2026-11-06T18:16:24.6736348+00:00"
},
"date_in_production_since": "2026-11-06T18:16:24.6736348+00:00",
"date_out_of_production_since": "2026-11-06T18:16:24.6736348+00:00",
"date_end_support": "2026-11-06T18:16:24.6736348+00:00",
"sales_organization_id": "f255867e-890c-4477-875d-dcc6af760c61",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fb99175b-3313-4516-86b1-3b1e882e9856",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d633775-db83-4ab9-9507-b0a0b3ca0aa4",
"db_currency_id": "edcbd1e7-2c8e-4f70-aeae-444a8e83d2d4",
"db_language_id": "479be8f4-5339-4c70-a0b1-273aa2ba4665",
"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-11-06T18:16:24.6736348+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-11-06T18:16:24.6932718+00:00"
},
"project_status_id": "33e5ceeb-c6a1-4e5e-aa81-441057ebaf5f",
"project_status_code": "sample string 10",
"project_status": {
"id": "4fcc6980-0bc0-4f1d-9ef2-9f8cbab42efc",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9c8480ee-9892-4f86-a6a8-9d1bdb9a96b7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fb99175b-3313-4516-86b1-3b1e882e9856",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d633775-db83-4ab9-9507-b0a0b3ca0aa4",
"db_currency_id": "edcbd1e7-2c8e-4f70-aeae-444a8e83d2d4",
"db_language_id": "479be8f4-5339-4c70-a0b1-273aa2ba4665",
"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-11-06T18:16:24.6736348+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-06T18:16:24.6932718+00:00"
},
"company_id": "ac6e977f-4ca8-4f7e-a2c3-c5e2b40ab8f6",
"company_code": "sample string 12",
"db_address_id": "fe48fab9-be6b-4e99-989c-9189b61f05ea",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "185e2353-b305-4364-9f81-03b7479c48be",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "df711135-a523-4376-83a7-942926642239",
"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-11-06T18:16:24.6932718+00:00",
"date_create": "2026-11-06T18:16:24.6932718+00:00",
"date_update": "2026-11-06T18:16:24.6932718+00:00",
"updated_by_user_id": "c6a0dad9-e123-4c0f-af2a-874403f47624",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-06T18:16:24.6932718+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-11-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-06T18:16:24.6932718+00:00",
"date_last_job": "2026-11-06T18:16:24.6932718+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-06T18:16:24.6932718+00:00",
"modified_dateutc": "2026-11-06T18:16:24.6932718+00:00",
"is_mobile_installation": true
},
"job_type_id": "1e6d4bac-f468-4827-ab8c-d7fb4e0dd586",
"job_type_code": "sample string 7",
"job_type": {
"id": "22e8b42b-8b22-4441-864a-7df52305fd00",
"name": "sample string 2",
"sales_organization_id": "eddcc673-cbe0-499a-a1c1-576057bf6302",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-06T18:16:24.6932718+00:00",
"code": "sample string 7"
},
"job_priority_id": "763c2c96-4515-419f-86be-fe17e1d60313",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "aebb3e0c-acba-47da-9306-2a53ec5596e3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "61637478-a7a1-48f8-85dd-7d39a3e678e9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fb99175b-3313-4516-86b1-3b1e882e9856",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d633775-db83-4ab9-9507-b0a0b3ca0aa4",
"db_currency_id": "edcbd1e7-2c8e-4f70-aeae-444a8e83d2d4",
"db_language_id": "479be8f4-5339-4c70-a0b1-273aa2ba4665",
"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-11-06T18:16:24.6736348+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-06T18:16:24.6932718+00:00"
},
"job_status_id": "52b7c575-863d-4506-8a6a-39504db3db20",
"job_status_code": "sample string 11",
"db_address_id": "be9851dc-7d3b-4573-96a9-c95f4187f68f",
"contact_id": "0be75aa3-8536-43a4-baba-7b00b3267f50",
"requested_by_company_id": "82e86576-6a00-4b2d-b6c8-a0ba67594189",
"requested_by_contact_id": "5353d563-9bbe-4b81-9bcb-582f6a16a226",
"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-11-06T18:16:24.6932718+00:00",
"due_date": "2026-11-06T18:16:24.6932718+00:00",
"date_create": "2026-11-06T18:16:24.6932718+00:00",
"date_update": "2026-11-06T18:16:24.6932718+00:00",
"date_closed": "2026-11-06T18:16:24.6932718+00:00",
"suggested_user_id": "43cbc9b5-cd9a-4d68-8ed0-4cb3e1fb8615",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3d6bdcca-a1b7-4f65-8ba8-19c4605474be",
"db_language_id": "b2909fb5-3a9a-4f3d-9693-a091b7caa3fe",
"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-11-06T18:16:24.6932718+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b31be717-e48e-411b-9cd4-19ac23424794",
"sales_organization": {
"id": "fb99175b-3313-4516-86b1-3b1e882e9856",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d633775-db83-4ab9-9507-b0a0b3ca0aa4",
"db_currency_id": "edcbd1e7-2c8e-4f70-aeae-444a8e83d2d4",
"db_language_id": "479be8f4-5339-4c70-a0b1-273aa2ba4665",
"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-11-06T18:16:24.6736348+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9d227dba-7549-46c9-b117-fc7a09946523",
"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": "520d41c9-a356-4088-8225-1b065b044d74",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-06T18:16:24.6932718+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "50a4d8be-91e6-4568-b4e2-8351d64cccdc"
},
"suggested_date_start": "2026-11-06T18:16:24.6932718+00:00",
"skill_id": "42b2bdee-30c9-4a66-b4c4-820489fee8eb",
"skill_code": "sample string 32",
"skill": {
"id": "70fa6834-657b-49c7-a0b3-d2085cd260e2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "dca4a2ba-ba9a-49ef-9bb8-5e99ad1caafc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fb99175b-3313-4516-86b1-3b1e882e9856",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d633775-db83-4ab9-9507-b0a0b3ca0aa4",
"db_currency_id": "edcbd1e7-2c8e-4f70-aeae-444a8e83d2d4",
"db_language_id": "479be8f4-5339-4c70-a0b1-273aa2ba4665",
"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-11-06T18:16:24.6736348+00:00"
},
"modified_dateutc": "2026-11-06T18:16:24.6932718+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "cfddb12f-64f6-42b3-b9d2-e5af46b16c24",
"date_reported_by_company": "2026-11-06T18:16:24.6932718+00:00",
"id2": 36,
"company_id": "b766a8c3-7aa9-4b89-af9d-8756c032bb17",
"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": "25aa4908-309c-4539-9442-e241e15f50a1",
"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-11-06T18:16:24.6932718+00:00"
},
"work_instruction_details_id": "00103370-530a-49b1-b526-dd4bb652d77a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "18be5e8c-9f40-4e51-8e58-67d9fb56947f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "67497e25-23d6-4e5d-aa9b-aebab0a43a6c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-06T18:16:24.6932718+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": "139208b3-1542-4367-b0bb-dca2320c8edf",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-06T18:16:24.7033653+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.