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": "119aabde-1721-4e43-b866-e617bc68dbe1",
"jobs_id": "2053a170-ff6e-4c34-9935-4624b1386065",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "726e32fb-7766-44d1-ab79-2f041715d8a5",
"_parent_id": "6d3e41b0-bf75-40c7-8fbc-e47d2cfc14b3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e365ef55-5e9b-4b37-b569-1973f3ebe824",
"project_reference_back_office": "sample string 5",
"project": {
"id": "03a8c798-9615-48f7-95c0-3c0ae8125fcc",
"_parent_id": "8057a05a-3440-4edb-b53d-6a1a1cf0fec3",
"root_parent_id": "d07061ea-337e-4bcb-8074-05d3e9cb27f9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4c18cb31-9f94-4dc8-9ae2-6774093de540",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e556917f-bdd2-4f97-8375-67b85c16980d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5451f012-0dd2-4c8e-a1b8-6c5452d656e5",
"_parent_code": "sample string 6",
"sales_organization_id": "5451c493-b3c0-4d50-b423-7d015e57ba74",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f00e8507-8268-4e20-9a2a-f590840b6feb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8839fd8c-e8df-4ae8-aeda-1e05cb825396",
"db_currency_id": "350c0c48-197a-438c-a6e0-3f6711fa410c",
"db_language_id": "406a7e4d-5c43-4586-a207-67a67ec0a1fc",
"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-10-08T22:04:37.1678864+00:00"
},
"modified_dateutc": "2026-10-08T22:04:37.1678864+00:00"
},
"equipment_model_id": "1d4f2529-9bf4-4523-b192-cd86788ecee0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b4b79bc0-3443-4200-8563-635da4f8fc35",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f5a715ef-ed63-4874-967b-d40d073152fb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a61de389-abb6-42cd-a83f-9228f31dc1a3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "74aeed9f-7eb9-443b-adcb-d969f09acddf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f00e8507-8268-4e20-9a2a-f590840b6feb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8839fd8c-e8df-4ae8-aeda-1e05cb825396",
"db_currency_id": "350c0c48-197a-438c-a6e0-3f6711fa410c",
"db_language_id": "406a7e4d-5c43-4586-a207-67a67ec0a1fc",
"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-10-08T22:04:37.1678864+00:00"
},
"modified_dateutc": "2026-10-08T22:04:37.1678864+00:00"
},
"equipment_family_id": "d952e3d5-d067-4ce9-8bce-b96759b9f79d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e556917f-bdd2-4f97-8375-67b85c16980d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5451f012-0dd2-4c8e-a1b8-6c5452d656e5",
"_parent_code": "sample string 6",
"sales_organization_id": "5451c493-b3c0-4d50-b423-7d015e57ba74",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f00e8507-8268-4e20-9a2a-f590840b6feb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8839fd8c-e8df-4ae8-aeda-1e05cb825396",
"db_currency_id": "350c0c48-197a-438c-a6e0-3f6711fa410c",
"db_language_id": "406a7e4d-5c43-4586-a207-67a67ec0a1fc",
"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-10-08T22:04:37.1678864+00:00"
},
"modified_dateutc": "2026-10-08T22:04:37.1678864+00:00"
},
"date_in_production_since": "2026-10-08T22:04:37.1678864+00:00",
"date_out_of_production_since": "2026-10-08T22:04:37.1678864+00:00",
"date_end_support": "2026-10-08T22:04:37.1678864+00:00",
"sales_organization_id": "a7b34800-66dc-4a6c-8ee5-057de7d2bd8d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f00e8507-8268-4e20-9a2a-f590840b6feb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8839fd8c-e8df-4ae8-aeda-1e05cb825396",
"db_currency_id": "350c0c48-197a-438c-a6e0-3f6711fa410c",
"db_language_id": "406a7e4d-5c43-4586-a207-67a67ec0a1fc",
"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-10-08T22:04:37.1678864+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-10-08T22:04:37.1678864+00:00"
},
"project_status_id": "3fde84c2-2f49-4b86-af5a-93c724c10968",
"project_status_code": "sample string 10",
"project_status": {
"id": "d0dbbb2e-ad0e-4f5c-9ef4-14eb1dae21c0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "aaa49ee4-29e7-47fd-8ec3-bd947b57eb65",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f00e8507-8268-4e20-9a2a-f590840b6feb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8839fd8c-e8df-4ae8-aeda-1e05cb825396",
"db_currency_id": "350c0c48-197a-438c-a6e0-3f6711fa410c",
"db_language_id": "406a7e4d-5c43-4586-a207-67a67ec0a1fc",
"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-10-08T22:04:37.1678864+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T22:04:37.1834458+00:00"
},
"company_id": "9743cc2c-15ad-4847-95c8-eeea7e29278c",
"company_code": "sample string 12",
"db_address_id": "985c9d46-3d7e-4ae4-8a3b-3ccd6ca47c90",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "75cdee04-0dca-4deb-80cd-b662b0ff172b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "66fe0ab6-e6bc-4769-81d1-4b30b714291e",
"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-10-08T22:04:37.1834458+00:00",
"date_create": "2026-10-08T22:04:37.1834458+00:00",
"date_update": "2026-10-08T22:04:37.1834458+00:00",
"updated_by_user_id": "5cdc785d-409c-4e60-b108-146647ff419e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-08T22:04:37.1834458+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-10-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-08T22:04:37.1834458+00:00",
"date_last_job": "2026-10-08T22:04:37.1834458+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-08T22:04:37.1834458+00:00",
"modified_dateutc": "2026-10-08T22:04:37.1834458+00:00",
"is_mobile_installation": true
},
"job_type_id": "37ed3be0-684e-435c-b9c0-284595bcb243",
"job_type_code": "sample string 7",
"job_type": {
"id": "833e469b-b357-427c-8e86-096368e6dc63",
"name": "sample string 2",
"sales_organization_id": "ccde013a-f8e5-476a-8873-e0b5a7d39a4f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-08T22:04:37.1834458+00:00",
"code": "sample string 7"
},
"job_priority_id": "7c26d6b1-bf32-409f-adce-e252d74a8b43",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6681ace4-50ed-4a17-9382-254678ed3ce3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "62389079-77fc-47e4-9eac-140e630857bc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f00e8507-8268-4e20-9a2a-f590840b6feb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8839fd8c-e8df-4ae8-aeda-1e05cb825396",
"db_currency_id": "350c0c48-197a-438c-a6e0-3f6711fa410c",
"db_language_id": "406a7e4d-5c43-4586-a207-67a67ec0a1fc",
"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-10-08T22:04:37.1678864+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T22:04:37.1834458+00:00"
},
"job_status_id": "1e53454b-94c7-4b72-a10a-c205e85adc3d",
"job_status_code": "sample string 11",
"db_address_id": "1b709caa-b4c1-4a67-96ae-f38bd3901df2",
"contact_id": "16c8ae58-c776-4f72-85bf-4eca78c4e1fc",
"requested_by_company_id": "cd87af8a-92ca-46f7-a1ca-e3b4309f2f14",
"requested_by_contact_id": "95b59cdb-ae25-4295-8831-26933981754a",
"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-10-08T22:04:37.1834458+00:00",
"due_date": "2026-10-08T22:04:37.1834458+00:00",
"date_create": "2026-10-08T22:04:37.1834458+00:00",
"date_update": "2026-10-08T22:04:37.1834458+00:00",
"date_closed": "2026-10-08T22:04:37.1834458+00:00",
"suggested_user_id": "c74238f4-ccb9-41a1-869d-7759be5c438d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2327b325-2076-4a0a-bd77-02b4c2b47e73",
"db_language_id": "4de76fa2-be55-421c-9a5f-4ea999019184",
"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-10-08T22:04:37.1834458+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "281ce3d7-ea9a-44f0-a7ba-c930793461e8",
"sales_organization": {
"id": "f00e8507-8268-4e20-9a2a-f590840b6feb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8839fd8c-e8df-4ae8-aeda-1e05cb825396",
"db_currency_id": "350c0c48-197a-438c-a6e0-3f6711fa410c",
"db_language_id": "406a7e4d-5c43-4586-a207-67a67ec0a1fc",
"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-10-08T22:04:37.1678864+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b48ee59b-ed0a-4ada-89b2-612460e98dd0",
"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": "a58bc4a8-7a33-4123-913e-014b665ef939",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-08T22:04:37.1834458+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b48d3b0a-a36d-46c5-ae6d-deac3c740cb7"
},
"suggested_date_start": "2026-10-08T22:04:37.1834458+00:00",
"skill_id": "d736a1f6-2161-4029-8290-2fa467e374a9",
"skill_code": "sample string 32",
"skill": {
"id": "3eee1d0e-19e4-4c85-840a-c5d185226464",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "551eeb97-99ab-4996-a024-96869a3bd621",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f00e8507-8268-4e20-9a2a-f590840b6feb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8839fd8c-e8df-4ae8-aeda-1e05cb825396",
"db_currency_id": "350c0c48-197a-438c-a6e0-3f6711fa410c",
"db_language_id": "406a7e4d-5c43-4586-a207-67a67ec0a1fc",
"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-10-08T22:04:37.1678864+00:00"
},
"modified_dateutc": "2026-10-08T22:04:37.1834458+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a2e7ede9-712a-4201-aecf-9d30344dace5",
"date_reported_by_company": "2026-10-08T22:04:37.1834458+00:00",
"id2": 36,
"company_id": "e4695d52-d0e1-4432-aa43-ae2384631a27",
"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": "d8e1f341-9a0b-4b49-9a2d-206102342fe7",
"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-10-08T22:04:37.1834458+00:00"
},
"work_instruction_details_id": "b12329ea-8908-403f-af1d-1a730f6ad009",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "973f0a22-52b1-4531-bf38-87a85802eb38",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3ce7af03-118f-439d-906d-d7d727caeb56",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-08T22:04:37.1834458+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": "653f89e5-0291-4ace-b513-76264bb4f648",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-08T22:04:37.1834458+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.