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": "d8f69e79-6a92-435b-8565-23310bb43f1b",
"jobs_id": "712f1978-4dc9-402f-b1ce-18561860d480",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ea5b9280-c2db-4fe8-82d0-78862a058cd3",
"_parent_id": "1099e5d6-8392-4cea-9391-d846d6fc1fd0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "667f1d16-1b0f-4938-b5ef-48c924321aa6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "927c433c-2bda-4892-b514-1ca8683accc0",
"_parent_id": "fda22e3f-0f88-4e02-b79d-360d229920e9",
"root_parent_id": "4a15c643-3d27-4fcc-85cb-f9555745f27b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "af4d9a57-19b4-4657-a971-3f23d40f134b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2750406d-2b1e-424b-ae8a-b4a3fd8a2b47",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "489d825a-e594-44c7-995e-b3d2ec25b49d",
"_parent_code": "sample string 6",
"sales_organization_id": "0a9f6d62-0c34-4d7d-a8eb-8c2dc75dc948",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2bddc486-cc48-4adc-89bb-56b2aab2bec6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d844057f-90da-419c-8699-9435203be327",
"db_currency_id": "8b39413b-f45f-469b-94df-0e2fb653d8b9",
"db_language_id": "11670fc0-ac7c-43df-a9bc-3a51d7285b1d",
"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-07-22T14:20:28.632802+00:00"
},
"modified_dateutc": "2026-07-22T14:20:28.632802+00:00"
},
"equipment_model_id": "aa9b4b6a-5590-4867-812c-3a03bf3b373f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "81c9d191-1c8f-4d8c-81b7-eab99afb74a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "19aa3496-07bb-41ac-ab47-4474b6ab62c7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bb5c4a29-ee00-443e-b28b-c4f533db651f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "eded6d8e-1075-4e69-bb02-256ad0e98d2c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2bddc486-cc48-4adc-89bb-56b2aab2bec6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d844057f-90da-419c-8699-9435203be327",
"db_currency_id": "8b39413b-f45f-469b-94df-0e2fb653d8b9",
"db_language_id": "11670fc0-ac7c-43df-a9bc-3a51d7285b1d",
"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-07-22T14:20:28.632802+00:00"
},
"modified_dateutc": "2026-07-22T14:20:28.632802+00:00"
},
"equipment_family_id": "49174959-5d57-4969-b1ff-1ba8e648b66d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2750406d-2b1e-424b-ae8a-b4a3fd8a2b47",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "489d825a-e594-44c7-995e-b3d2ec25b49d",
"_parent_code": "sample string 6",
"sales_organization_id": "0a9f6d62-0c34-4d7d-a8eb-8c2dc75dc948",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2bddc486-cc48-4adc-89bb-56b2aab2bec6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d844057f-90da-419c-8699-9435203be327",
"db_currency_id": "8b39413b-f45f-469b-94df-0e2fb653d8b9",
"db_language_id": "11670fc0-ac7c-43df-a9bc-3a51d7285b1d",
"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-07-22T14:20:28.632802+00:00"
},
"modified_dateutc": "2026-07-22T14:20:28.632802+00:00"
},
"date_in_production_since": "2026-07-22T14:20:28.632802+00:00",
"date_out_of_production_since": "2026-07-22T14:20:28.632802+00:00",
"date_end_support": "2026-07-22T14:20:28.632802+00:00",
"sales_organization_id": "2aed3a1c-f1cd-485c-ac1e-d19825daad87",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2bddc486-cc48-4adc-89bb-56b2aab2bec6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d844057f-90da-419c-8699-9435203be327",
"db_currency_id": "8b39413b-f45f-469b-94df-0e2fb653d8b9",
"db_language_id": "11670fc0-ac7c-43df-a9bc-3a51d7285b1d",
"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-07-22T14:20:28.632802+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-07-22T14:20:28.632802+00:00"
},
"project_status_id": "90665d0f-ce87-49ce-9b1c-3836de9bfc7b",
"project_status_code": "sample string 10",
"project_status": {
"id": "27ffc185-8520-4b49-9939-5ae4b64e6aef",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "50d9de33-bd50-4d98-96fb-e924159915d4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2bddc486-cc48-4adc-89bb-56b2aab2bec6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d844057f-90da-419c-8699-9435203be327",
"db_currency_id": "8b39413b-f45f-469b-94df-0e2fb653d8b9",
"db_language_id": "11670fc0-ac7c-43df-a9bc-3a51d7285b1d",
"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-07-22T14:20:28.632802+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-22T14:20:28.632802+00:00"
},
"company_id": "db449ada-f4d6-4f7b-a67f-aa4afb0317d3",
"company_code": "sample string 12",
"db_address_id": "2ccc3c64-fa78-447b-823e-8134d22a3090",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2ec8cbf3-5b04-471f-909c-3e3d9087716a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e8590a33-4bb7-4421-8882-54c59452c03c",
"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-07-22T14:20:28.632802+00:00",
"date_create": "2026-07-22T14:20:28.632802+00:00",
"date_update": "2026-07-22T14:20:28.632802+00:00",
"updated_by_user_id": "defedeb7-1d97-4a54-914d-55bf643b6c3f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-22T14:20:28.632802+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-07-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-22T14:20:28.632802+00:00",
"date_last_job": "2026-07-22T14:20:28.632802+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-22T14:20:28.632802+00:00",
"modified_dateutc": "2026-07-22T14:20:28.632802+00:00",
"is_mobile_installation": true
},
"job_type_id": "1746184f-5e15-449b-b753-d1e99ffcb07b",
"job_type_code": "sample string 7",
"job_type": {
"id": "aea4dbca-8533-4759-a6a9-9a27584e42f9",
"name": "sample string 2",
"sales_organization_id": "ed4d7fc8-d81b-4a56-8017-64f56ec4f734",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-22T14:20:28.632802+00:00",
"code": "sample string 7"
},
"job_priority_id": "983b4993-58e2-41f2-8f4d-972a952d9b18",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e2711250-f3b4-45fc-ad34-930f46870acc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "45dab1c9-d71a-4f0d-a864-b87d649535e7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2bddc486-cc48-4adc-89bb-56b2aab2bec6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d844057f-90da-419c-8699-9435203be327",
"db_currency_id": "8b39413b-f45f-469b-94df-0e2fb653d8b9",
"db_language_id": "11670fc0-ac7c-43df-a9bc-3a51d7285b1d",
"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-07-22T14:20:28.632802+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-22T14:20:28.632802+00:00"
},
"job_status_id": "d66f5450-d219-4213-8c7b-3ec8fabe9de6",
"job_status_code": "sample string 11",
"db_address_id": "95d884f4-7902-457a-a85e-a8c34a97a006",
"contact_id": "03b01dee-0684-426e-839a-bb51cdd364e0",
"requested_by_company_id": "3ab4b4cd-9ae3-4352-9f91-f5836176e94e",
"requested_by_contact_id": "2a47e8ba-1c80-41ae-9a7c-45ec4ff8b909",
"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-07-22T14:20:28.632802+00:00",
"due_date": "2026-07-22T14:20:28.632802+00:00",
"date_create": "2026-07-22T14:20:28.632802+00:00",
"date_update": "2026-07-22T14:20:28.632802+00:00",
"date_closed": "2026-07-22T14:20:28.632802+00:00",
"suggested_user_id": "659cf645-63f8-4831-98d7-c8aa4c212310",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2980fd0e-694e-4d7f-8a59-620c0a58da07",
"db_language_id": "db29bd42-eed4-4a30-8dfc-eee58a10babc",
"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-07-22T14:20:28.632802+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0b059029-b06c-4749-989c-7d766b671f56",
"sales_organization": {
"id": "2bddc486-cc48-4adc-89bb-56b2aab2bec6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d844057f-90da-419c-8699-9435203be327",
"db_currency_id": "8b39413b-f45f-469b-94df-0e2fb653d8b9",
"db_language_id": "11670fc0-ac7c-43df-a9bc-3a51d7285b1d",
"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-07-22T14:20:28.632802+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "dac6c4a4-ae77-4639-8467-3438db7b7762",
"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": "4b1598cc-63a8-48b7-9ab9-4337818eba96",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-22T14:20:28.632802+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "85955a25-a752-4edd-8748-1687729ce6be"
},
"suggested_date_start": "2026-07-22T14:20:28.632802+00:00",
"skill_id": "bb41445e-71c0-431b-bb23-87b19762ebe7",
"skill_code": "sample string 32",
"skill": {
"id": "5dd478af-b7fc-4d99-93eb-af440d803366",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ce6c9f69-00ce-453f-a105-5b65de8fd1fe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2bddc486-cc48-4adc-89bb-56b2aab2bec6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d844057f-90da-419c-8699-9435203be327",
"db_currency_id": "8b39413b-f45f-469b-94df-0e2fb653d8b9",
"db_language_id": "11670fc0-ac7c-43df-a9bc-3a51d7285b1d",
"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-07-22T14:20:28.632802+00:00"
},
"modified_dateutc": "2026-07-22T14:20:28.632802+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "afa20cae-303a-4a60-9eea-05f78eb94088",
"date_reported_by_company": "2026-07-22T14:20:28.632802+00:00",
"id2": 36,
"company_id": "ed123d43-2556-4668-8815-4b15e0b581df",
"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": "6b41641f-be95-4d17-ad9d-9ad1974acdac",
"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-07-22T14:20:28.632802+00:00"
},
"work_instruction_details_id": "8c187f76-83fb-4387-96f0-dc4305045111",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4e5f20c9-f9ce-41d7-a426-f87cd38150bc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8f228c85-1c59-4f30-b477-f932d4f7f599",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-22T14:20:28.632802+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": "7b1b9601-6784-4513-a429-45ba20eb4cba",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-22T14:20:28.632802+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.