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": "a6560e10-d5c8-4e84-91cf-417742b7211a",
"jobs_id": "b0ce4fbd-c51a-4160-b5d9-afb9e6db9c50",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "98fc1923-f9e1-4ee5-a6d7-8894ee9fdd3c",
"_parent_id": "1d6424bc-8314-4480-bec8-8c1acae0f77b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8869a325-c540-4d29-b906-0a6652872768",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7a7b8795-7db2-4d91-ba3a-8d338a4a5985",
"_parent_id": "b8154bf4-64d2-4667-b13e-c65336e69280",
"root_parent_id": "921a7bca-05d1-48f8-97ea-fcef8f8003a6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bf706d77-6df3-43ce-ba84-77dd4b760150",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d2fc8325-29ec-4337-8936-853a1a52126f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "febe4531-b3d5-47cb-a9c0-4c1af5d40e04",
"_parent_code": "sample string 6",
"sales_organization_id": "ab65c0d5-2b72-485a-bb98-eb79f48237c7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "27ba9751-a3f0-4d64-9895-35c25e3ac4f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73038abf-f821-48b7-be83-fb969ddb2295",
"db_currency_id": "aa270aba-ae5d-49cb-b1f6-3fbdb3fab33b",
"db_language_id": "f67347da-87dc-49bb-8330-c31e81bb23f7",
"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-29T00:00:23.5843462+00:00"
},
"modified_dateutc": "2026-09-29T00:00:23.5843462+00:00"
},
"equipment_model_id": "ab0e1b48-abbc-4456-bf00-3f8e5eca59d4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "11d42866-a066-41dc-9317-b213356ce953",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b393bf23-d463-41b2-9b15-cf7f01b02b02",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a246e96d-75e7-4e23-a740-8c73f106dc21",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "525d527a-58c4-4444-b051-3e1c06c9fafe",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "27ba9751-a3f0-4d64-9895-35c25e3ac4f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73038abf-f821-48b7-be83-fb969ddb2295",
"db_currency_id": "aa270aba-ae5d-49cb-b1f6-3fbdb3fab33b",
"db_language_id": "f67347da-87dc-49bb-8330-c31e81bb23f7",
"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-29T00:00:23.5843462+00:00"
},
"modified_dateutc": "2026-09-29T00:00:23.5843462+00:00"
},
"equipment_family_id": "c9602ae1-92f9-47f7-ae5e-53a5ea7fedcc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d2fc8325-29ec-4337-8936-853a1a52126f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "febe4531-b3d5-47cb-a9c0-4c1af5d40e04",
"_parent_code": "sample string 6",
"sales_organization_id": "ab65c0d5-2b72-485a-bb98-eb79f48237c7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "27ba9751-a3f0-4d64-9895-35c25e3ac4f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73038abf-f821-48b7-be83-fb969ddb2295",
"db_currency_id": "aa270aba-ae5d-49cb-b1f6-3fbdb3fab33b",
"db_language_id": "f67347da-87dc-49bb-8330-c31e81bb23f7",
"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-29T00:00:23.5843462+00:00"
},
"modified_dateutc": "2026-09-29T00:00:23.5843462+00:00"
},
"date_in_production_since": "2026-09-29T00:00:23.5843462+00:00",
"date_out_of_production_since": "2026-09-29T00:00:23.5843462+00:00",
"date_end_support": "2026-09-29T00:00:23.5843462+00:00",
"sales_organization_id": "b200207b-277b-4819-870d-06302493e66a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "27ba9751-a3f0-4d64-9895-35c25e3ac4f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73038abf-f821-48b7-be83-fb969ddb2295",
"db_currency_id": "aa270aba-ae5d-49cb-b1f6-3fbdb3fab33b",
"db_language_id": "f67347da-87dc-49bb-8330-c31e81bb23f7",
"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-29T00:00:23.5843462+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-29T00:00:23.5843462+00:00"
},
"project_status_id": "32b6e5f2-a84b-478e-a4dc-d7a7d205f235",
"project_status_code": "sample string 10",
"project_status": {
"id": "587ece91-72d7-4599-9582-a50669bb57a9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1decc02c-791a-4496-b7b1-fbb69a5cc0b6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "27ba9751-a3f0-4d64-9895-35c25e3ac4f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73038abf-f821-48b7-be83-fb969ddb2295",
"db_currency_id": "aa270aba-ae5d-49cb-b1f6-3fbdb3fab33b",
"db_language_id": "f67347da-87dc-49bb-8330-c31e81bb23f7",
"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-29T00:00:23.5843462+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-29T00:00:23.5843462+00:00"
},
"company_id": "410c48ae-5c6b-41d7-ad1b-30da195adf79",
"company_code": "sample string 12",
"db_address_id": "69facfa4-a907-4b37-b918-5d98850c3a35",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c7c93cc3-51f3-446e-b6f0-a343ec19e0a9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "90edafbe-51d2-47d1-8920-a46eb1d3e881",
"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-29T00:00:23.5843462+00:00",
"date_create": "2026-09-29T00:00:23.5843462+00:00",
"date_update": "2026-09-29T00:00:23.5843462+00:00",
"updated_by_user_id": "6b607010-02ed-4307-ab4a-ed18791ea10c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-29T00:00:23.5843462+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-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-29T00:00:23.5843462+00:00",
"date_last_job": "2026-09-29T00:00:23.5843462+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-29T00:00:23.5843462+00:00",
"modified_dateutc": "2026-09-29T00:00:23.5843462+00:00",
"is_mobile_installation": true
},
"job_type_id": "f0d08e1b-d794-4460-9d83-35369a10efb7",
"job_type_code": "sample string 7",
"job_type": {
"id": "a5e2146c-1bb3-41b4-819e-1f0379dbdcbc",
"name": "sample string 2",
"sales_organization_id": "0e0b40cd-c91f-4d0e-a537-8021eda5cbfb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-29T00:00:23.5843462+00:00",
"code": "sample string 7"
},
"job_priority_id": "be3d09d7-35b7-45e8-8a61-1f484f8f9fd0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e2b1bfb9-3c92-4982-9696-fec0b8404eda",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5e852e40-c4c9-4b15-bd7f-a16d14f6ed2a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "27ba9751-a3f0-4d64-9895-35c25e3ac4f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73038abf-f821-48b7-be83-fb969ddb2295",
"db_currency_id": "aa270aba-ae5d-49cb-b1f6-3fbdb3fab33b",
"db_language_id": "f67347da-87dc-49bb-8330-c31e81bb23f7",
"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-29T00:00:23.5843462+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-29T00:00:23.5843462+00:00"
},
"job_status_id": "9594b4d2-3ad0-42d7-bbf6-b270ddbd5131",
"job_status_code": "sample string 11",
"db_address_id": "2129e8dd-f743-430a-a1e9-4a97dcd7885c",
"contact_id": "fb991f05-97c9-4cb7-b716-f28a253b3b9d",
"requested_by_company_id": "a92e292f-9813-4581-ad4d-1267ce9471b0",
"requested_by_contact_id": "65da0a12-d5d9-4c22-b8fe-eb2c9059d94a",
"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-29T00:00:23.5843462+00:00",
"due_date": "2026-09-29T00:00:23.5843462+00:00",
"date_create": "2026-09-29T00:00:23.5843462+00:00",
"date_update": "2026-09-29T00:00:23.5843462+00:00",
"date_closed": "2026-09-29T00:00:23.5843462+00:00",
"suggested_user_id": "32c8254c-5ef9-409d-bc6b-0018290c83e0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a551fe62-1a43-4b8f-abe8-814d0632a054",
"db_language_id": "062c480e-2a6c-469d-b1b4-e45ef3b3e193",
"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-29T00:00:23.5843462+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f664f1a9-a6be-446b-863d-e86c01415684",
"sales_organization": {
"id": "27ba9751-a3f0-4d64-9895-35c25e3ac4f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73038abf-f821-48b7-be83-fb969ddb2295",
"db_currency_id": "aa270aba-ae5d-49cb-b1f6-3fbdb3fab33b",
"db_language_id": "f67347da-87dc-49bb-8330-c31e81bb23f7",
"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-29T00:00:23.5843462+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "122bea71-0167-41e7-aff5-65b633217236",
"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": "ddd5e603-1ed1-42ea-8ab0-b7ad33ef0807",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-29T00:00:23.5843462+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "49336b05-ced1-4a0e-bc57-afc493063474"
},
"suggested_date_start": "2026-09-29T00:00:23.5843462+00:00",
"skill_id": "8707cbd3-2b12-4f17-90be-72717a3c0d2a",
"skill_code": "sample string 32",
"skill": {
"id": "6c466e72-663a-4136-87d9-276b43f3a50a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f5c79478-1ae3-4587-8438-162e61c534c3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "27ba9751-a3f0-4d64-9895-35c25e3ac4f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73038abf-f821-48b7-be83-fb969ddb2295",
"db_currency_id": "aa270aba-ae5d-49cb-b1f6-3fbdb3fab33b",
"db_language_id": "f67347da-87dc-49bb-8330-c31e81bb23f7",
"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-29T00:00:23.5843462+00:00"
},
"modified_dateutc": "2026-09-29T00:00:23.5843462+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f05fb635-581d-4b74-b84e-9761d4348f76",
"date_reported_by_company": "2026-09-29T00:00:23.5843462+00:00",
"id2": 36,
"company_id": "2c320526-62de-41fa-85e5-8efc7d01f0fe",
"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": "fde62aa7-9127-4c75-8b6b-7a0b2069cc5a",
"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-29T00:00:23.5843462+00:00"
},
"work_instruction_details_id": "631a9e00-9c84-48c8-a91c-216402df8fc9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "92c56f44-053a-4984-8883-36f22d835aa6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "81728f4c-f1a3-4c27-882e-59ef0ac4fcab",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-29T00:00:23.5843462+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": "c82fb152-9423-41fc-aca4-3ca3698d6401",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-29T00:00:23.5843462+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.