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": "2cc48322-85da-4fc7-aac1-f51fb034aaa5",
"jobs_id": "27852bc2-842a-436f-883d-236dd8e3deca",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "47e7adc8-2583-4627-9c31-f80924ff29a3",
"_parent_id": "0cb8fa1b-4516-481c-a435-07cae5818811",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ce1b57c5-89ea-4321-aab0-da70cb48b827",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2b9d5359-49bf-48ca-992a-22b461c453fd",
"_parent_id": "6593e97c-2b11-4362-ae0c-3704eb61fd6a",
"root_parent_id": "7958e092-49d0-46e6-8577-8691702e631e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4ea41106-fc6d-4585-a7cf-28aecde9ab93",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "57a07fc4-e178-4516-8c86-2d14fa364be9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7f1d78f6-063f-444c-a7f6-6585c29d3a70",
"_parent_code": "sample string 6",
"sales_organization_id": "5cba4a18-ef74-4dc8-bf88-fd6c4a944627",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b4ae927c-d0b3-4fe3-898b-c0cefd7c7b09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ac813e9-fe09-4a96-94c4-3e223ea2e4b0",
"db_currency_id": "13b71264-3fa6-4b12-b90f-5280a44358a8",
"db_language_id": "665858e5-2139-45e0-8e13-03476d4038a9",
"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-05-06T20:23:03.7816504+00:00"
},
"modified_dateutc": "2026-05-06T20:23:03.7972716+00:00"
},
"equipment_model_id": "73d9298f-50f1-4417-9c1f-1a3350bc5610",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8b061a63-d661-4f34-a7b4-3e6b58b13775",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7f1bbd4a-39fd-4120-89cd-bbdfcb248092",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "eb1810e8-d399-4866-a6c2-3f23ceba27a0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5401d7a8-6e8e-4f5b-b9b7-2144f27f49fd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b4ae927c-d0b3-4fe3-898b-c0cefd7c7b09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ac813e9-fe09-4a96-94c4-3e223ea2e4b0",
"db_currency_id": "13b71264-3fa6-4b12-b90f-5280a44358a8",
"db_language_id": "665858e5-2139-45e0-8e13-03476d4038a9",
"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-05-06T20:23:03.7816504+00:00"
},
"modified_dateutc": "2026-05-06T20:23:03.7972716+00:00"
},
"equipment_family_id": "20759a73-b9a9-46b2-9a0a-7b73204606be",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "57a07fc4-e178-4516-8c86-2d14fa364be9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7f1d78f6-063f-444c-a7f6-6585c29d3a70",
"_parent_code": "sample string 6",
"sales_organization_id": "5cba4a18-ef74-4dc8-bf88-fd6c4a944627",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b4ae927c-d0b3-4fe3-898b-c0cefd7c7b09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ac813e9-fe09-4a96-94c4-3e223ea2e4b0",
"db_currency_id": "13b71264-3fa6-4b12-b90f-5280a44358a8",
"db_language_id": "665858e5-2139-45e0-8e13-03476d4038a9",
"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-05-06T20:23:03.7816504+00:00"
},
"modified_dateutc": "2026-05-06T20:23:03.7972716+00:00"
},
"date_in_production_since": "2026-05-06T20:23:03.7972716+00:00",
"date_out_of_production_since": "2026-05-06T20:23:03.7972716+00:00",
"date_end_support": "2026-05-06T20:23:03.7972716+00:00",
"sales_organization_id": "d52071fc-7d89-4c59-9f46-b2819b7ccf23",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b4ae927c-d0b3-4fe3-898b-c0cefd7c7b09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ac813e9-fe09-4a96-94c4-3e223ea2e4b0",
"db_currency_id": "13b71264-3fa6-4b12-b90f-5280a44358a8",
"db_language_id": "665858e5-2139-45e0-8e13-03476d4038a9",
"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-05-06T20:23:03.7816504+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-05-06T20:23:03.7972716+00:00"
},
"project_status_id": "dbcffc26-e937-44d7-9e18-9087a357aed7",
"project_status_code": "sample string 10",
"project_status": {
"id": "a8a67e48-582c-4cbf-8db1-92434a23d178",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "98aa3162-3138-4afb-9711-3a2db1ebb59f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b4ae927c-d0b3-4fe3-898b-c0cefd7c7b09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ac813e9-fe09-4a96-94c4-3e223ea2e4b0",
"db_currency_id": "13b71264-3fa6-4b12-b90f-5280a44358a8",
"db_language_id": "665858e5-2139-45e0-8e13-03476d4038a9",
"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-05-06T20:23:03.7816504+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-06T20:23:03.7972716+00:00"
},
"company_id": "10667774-f4db-455a-beb0-89df959cb1c5",
"company_code": "sample string 12",
"db_address_id": "b338404e-df41-4d7d-966b-cf936dd4f059",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "442bcd3b-158f-40be-b919-e2aa8ab0b043",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "454117cb-feb0-4bc7-b7e3-5055af63c6f3",
"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-05-06T20:23:03.7972716+00:00",
"date_create": "2026-05-06T20:23:03.7972716+00:00",
"date_update": "2026-05-06T20:23:03.7972716+00:00",
"updated_by_user_id": "44ce57a3-0bb0-4375-8da3-c9221456e8a2",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-06T20:23:03.7972716+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-05-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-06T20:23:03.7972716+00:00",
"date_last_job": "2026-05-06T20:23:03.7972716+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-06T20:23:03.7972716+00:00",
"modified_dateutc": "2026-05-06T20:23:03.7972716+00:00",
"is_mobile_installation": true
},
"job_type_id": "5681c37a-9cc1-425c-8218-52db58ed2759",
"job_type_code": "sample string 7",
"job_type": {
"id": "cff8c678-22a2-4759-8796-52bf6800308b",
"name": "sample string 2",
"sales_organization_id": "2d9c36d5-4eab-47e4-a639-3753dd9b8665",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-06T20:23:03.7972716+00:00",
"code": "sample string 7"
},
"job_priority_id": "7308c130-42a7-4103-b662-b01636cf22aa",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fbdea2b2-2202-4c29-95ad-bffa42aaef99",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ea8a082e-a1f6-470d-ac3f-291b23c5a503",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b4ae927c-d0b3-4fe3-898b-c0cefd7c7b09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ac813e9-fe09-4a96-94c4-3e223ea2e4b0",
"db_currency_id": "13b71264-3fa6-4b12-b90f-5280a44358a8",
"db_language_id": "665858e5-2139-45e0-8e13-03476d4038a9",
"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-05-06T20:23:03.7816504+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-06T20:23:03.7972716+00:00"
},
"job_status_id": "4d0caa59-1c29-4cad-b4b0-5daad275bae0",
"job_status_code": "sample string 11",
"db_address_id": "43d00cdf-f97b-4146-ad76-1c45bda460ad",
"contact_id": "c1f7ed44-f519-4af8-b392-3c5c4cddd5ac",
"requested_by_company_id": "ea7e569c-6ff4-4f3e-8ed7-df84265c70f2",
"requested_by_contact_id": "3a6b1a32-9546-4259-9cb4-a69a05c0f2e2",
"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-05-06T20:23:03.7972716+00:00",
"due_date": "2026-05-06T20:23:03.7972716+00:00",
"date_create": "2026-05-06T20:23:03.7972716+00:00",
"date_update": "2026-05-06T20:23:03.7972716+00:00",
"date_closed": "2026-05-06T20:23:03.7972716+00:00",
"suggested_user_id": "8ac7ca5a-4c1e-4fbd-a749-d49e79770d76",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7f5a7ab9-ad22-4134-acc7-89d167af1789",
"db_language_id": "4c3fb88b-e8c0-4571-979a-39650226c64a",
"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-05-06T20:23:03.7972716+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4da5585b-dd00-44ab-916f-5e033c3f9425",
"sales_organization": {
"id": "b4ae927c-d0b3-4fe3-898b-c0cefd7c7b09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ac813e9-fe09-4a96-94c4-3e223ea2e4b0",
"db_currency_id": "13b71264-3fa6-4b12-b90f-5280a44358a8",
"db_language_id": "665858e5-2139-45e0-8e13-03476d4038a9",
"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-05-06T20:23:03.7816504+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9560c41b-b288-4414-835a-f061b79586c6",
"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": "1973332e-56cb-402d-aa39-8efa2ded4a46",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-06T20:23:03.7972716+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cf3dbae7-9490-4a4f-b687-9221a190d635"
},
"suggested_date_start": "2026-05-06T20:23:03.7972716+00:00",
"skill_id": "3dfc54af-ffec-4cea-ba7a-c64649d7e6ce",
"skill_code": "sample string 32",
"skill": {
"id": "960f59f9-cca4-4e45-bb4a-2a0c9153a2d9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "40fd2dcd-9c15-4282-86dd-56e827e2388d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b4ae927c-d0b3-4fe3-898b-c0cefd7c7b09",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4ac813e9-fe09-4a96-94c4-3e223ea2e4b0",
"db_currency_id": "13b71264-3fa6-4b12-b90f-5280a44358a8",
"db_language_id": "665858e5-2139-45e0-8e13-03476d4038a9",
"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-05-06T20:23:03.7816504+00:00"
},
"modified_dateutc": "2026-05-06T20:23:03.7972716+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "52c3dc14-53f0-47c1-8c23-96734de48ad9",
"date_reported_by_company": "2026-05-06T20:23:03.7972716+00:00",
"id2": 36,
"company_id": "f32df98a-beaf-4ace-a4d4-b5addecc9594",
"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": "b255c2c5-ccf8-44a5-83e3-a76fa6856d72",
"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-05-06T20:23:03.7972716+00:00"
},
"work_instruction_details_id": "fd5c7bb9-8fe7-4b05-b6f3-2e24e695b7c2",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ad3e3ecc-91f9-433a-8217-681a791176e1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8f2cf046-d76f-47c1-9844-51f55f4dc50e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-06T20:23:03.7972716+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": "430a77a5-0b39-4e46-9068-ed5e02871896",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-06T20:23:03.7972716+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.