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": "fa1c5f8c-42b2-4b35-8997-ce9738597027",
"jobs_id": "ab115956-3e64-45aa-8a83-2c6eb227d364",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6f9601fe-ab81-420f-becd-db9963c72fa1",
"_parent_id": "a890c26b-fe37-4a7c-b2ab-b24e484f53b4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "eb9ccb5f-945d-4d42-8ef9-ca42b9b6fe6f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "69c3dbb9-6383-424a-92a6-0eb458066cb2",
"_parent_id": "8fa42704-c7b8-404e-8b85-776f1fe86bfe",
"root_parent_id": "7b68baa0-a12a-46d7-97c7-35671d97316d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c900f352-33d4-423a-8868-1a476606cd7c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a20d0b90-b2ae-4ab4-8a5c-20498a45df87",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "df66ddaf-38cb-4938-b58a-b5a923118ed5",
"_parent_code": "sample string 6",
"sales_organization_id": "0dcf514c-704a-4cb0-92e6-36bccc01cc85",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "338ee3fb-60ab-49d1-a537-6cc53f5d2b0d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b982e4df-d492-467f-be6a-831d515971e6",
"db_currency_id": "45d611c7-99b7-467f-80f2-3ec3ba835b99",
"db_language_id": "60c631f5-aeca-4933-b46e-22c5f23d2917",
"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-20T05:55:24.7747506+00:00"
},
"modified_dateutc": "2026-10-20T05:55:24.7747506+00:00"
},
"equipment_model_id": "eae5f35f-55f4-4c7d-a067-c97109aa5027",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c2699b4c-2fd4-487e-a360-44cfe6958e1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7620ad43-5101-40ff-b591-2c4373323eb4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1482a1a5-0f27-4dbb-ac3a-fca7e15e736c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9c5be6d5-de84-48f3-b033-31ab54db188e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "338ee3fb-60ab-49d1-a537-6cc53f5d2b0d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b982e4df-d492-467f-be6a-831d515971e6",
"db_currency_id": "45d611c7-99b7-467f-80f2-3ec3ba835b99",
"db_language_id": "60c631f5-aeca-4933-b46e-22c5f23d2917",
"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-20T05:55:24.7747506+00:00"
},
"modified_dateutc": "2026-10-20T05:55:24.7747506+00:00"
},
"equipment_family_id": "8cdeca82-bb1d-4022-802e-13ca8d03604f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a20d0b90-b2ae-4ab4-8a5c-20498a45df87",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "df66ddaf-38cb-4938-b58a-b5a923118ed5",
"_parent_code": "sample string 6",
"sales_organization_id": "0dcf514c-704a-4cb0-92e6-36bccc01cc85",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "338ee3fb-60ab-49d1-a537-6cc53f5d2b0d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b982e4df-d492-467f-be6a-831d515971e6",
"db_currency_id": "45d611c7-99b7-467f-80f2-3ec3ba835b99",
"db_language_id": "60c631f5-aeca-4933-b46e-22c5f23d2917",
"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-20T05:55:24.7747506+00:00"
},
"modified_dateutc": "2026-10-20T05:55:24.7747506+00:00"
},
"date_in_production_since": "2026-10-20T05:55:24.7747506+00:00",
"date_out_of_production_since": "2026-10-20T05:55:24.7747506+00:00",
"date_end_support": "2026-10-20T05:55:24.7747506+00:00",
"sales_organization_id": "51f6ac6e-ef96-4b73-b9a0-d550e15d6695",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "338ee3fb-60ab-49d1-a537-6cc53f5d2b0d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b982e4df-d492-467f-be6a-831d515971e6",
"db_currency_id": "45d611c7-99b7-467f-80f2-3ec3ba835b99",
"db_language_id": "60c631f5-aeca-4933-b46e-22c5f23d2917",
"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-20T05:55:24.7747506+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-20T05:55:24.7747506+00:00"
},
"project_status_id": "46b35b98-ad0f-4ddd-87a2-3d2f3380b9d7",
"project_status_code": "sample string 10",
"project_status": {
"id": "4cf993d0-52c1-4bd4-89b6-581c0ec94948",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bb606e70-fc81-423c-93bc-b5f5a6685903",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "338ee3fb-60ab-49d1-a537-6cc53f5d2b0d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b982e4df-d492-467f-be6a-831d515971e6",
"db_currency_id": "45d611c7-99b7-467f-80f2-3ec3ba835b99",
"db_language_id": "60c631f5-aeca-4933-b46e-22c5f23d2917",
"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-20T05:55:24.7747506+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-20T05:55:24.7747506+00:00"
},
"company_id": "0b37b48a-8a30-45ba-a2a4-3b0230aba00e",
"company_code": "sample string 12",
"db_address_id": "b0babc1d-771a-4d5a-9a57-700acbef45c8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "38985a00-3c86-42fa-99a3-fa65f7ad145d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1b6a7668-47be-4cf5-a23c-1c2571e3617e",
"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-20T05:55:24.7747506+00:00",
"date_create": "2026-10-20T05:55:24.7747506+00:00",
"date_update": "2026-10-20T05:55:24.7747506+00:00",
"updated_by_user_id": "6f06848c-80a9-420a-a9cf-67950fb467bb",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-20T05:55:24.7747506+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-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-20T05:55:24.7747506+00:00",
"date_last_job": "2026-10-20T05:55:24.7747506+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-20T05:55:24.7747506+00:00",
"modified_dateutc": "2026-10-20T05:55:24.7747506+00:00",
"is_mobile_installation": true
},
"job_type_id": "59bf3c79-a8c0-4c5e-9f1a-6e7a718010ec",
"job_type_code": "sample string 7",
"job_type": {
"id": "b6dd1840-0d76-4310-ab47-c94513d34bfd",
"name": "sample string 2",
"sales_organization_id": "0d3e5679-43bd-4073-8014-67a49f851db0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-20T05:55:24.7747506+00:00",
"code": "sample string 7"
},
"job_priority_id": "8cbb616c-8d11-4d0e-9c95-3e296c2e4ce6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3c1061d1-eee5-4648-a80b-d0315f842dfa",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a7462361-4b3f-4c70-9e27-78e0b3a26d69",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "338ee3fb-60ab-49d1-a537-6cc53f5d2b0d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b982e4df-d492-467f-be6a-831d515971e6",
"db_currency_id": "45d611c7-99b7-467f-80f2-3ec3ba835b99",
"db_language_id": "60c631f5-aeca-4933-b46e-22c5f23d2917",
"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-20T05:55:24.7747506+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-20T05:55:24.7747506+00:00"
},
"job_status_id": "6d4859f1-d522-419c-9d6f-f2ff745e4993",
"job_status_code": "sample string 11",
"db_address_id": "5c3cfbeb-cb71-4d74-ae88-51e79087719c",
"contact_id": "d4149d31-74ac-4408-971d-09568748a99c",
"requested_by_company_id": "4221df62-9cf0-4394-a140-ec4dc2136e63",
"requested_by_contact_id": "5c958173-f3a6-4f17-ab11-6f75eb0991e0",
"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-20T05:55:24.7747506+00:00",
"due_date": "2026-10-20T05:55:24.7747506+00:00",
"date_create": "2026-10-20T05:55:24.7747506+00:00",
"date_update": "2026-10-20T05:55:24.7747506+00:00",
"date_closed": "2026-10-20T05:55:24.7747506+00:00",
"suggested_user_id": "8f0a14bf-2adf-43ae-828f-fa92cab1ff9f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0b2b81e6-bbea-44c9-88d7-3cb0548f5be4",
"db_language_id": "835a2711-938a-49c7-8331-158689174db3",
"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-20T05:55:24.7747506+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "665e4b5b-5bfc-4f8c-974c-6a596c86ef08",
"sales_organization": {
"id": "338ee3fb-60ab-49d1-a537-6cc53f5d2b0d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b982e4df-d492-467f-be6a-831d515971e6",
"db_currency_id": "45d611c7-99b7-467f-80f2-3ec3ba835b99",
"db_language_id": "60c631f5-aeca-4933-b46e-22c5f23d2917",
"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-20T05:55:24.7747506+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b8a96b31-1d10-4437-b0e8-614a67296b36",
"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": "ef32390f-5692-4d9d-83b2-8425de748157",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-20T05:55:24.7747506+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "223da0eb-1d75-44ca-b01f-ff096778834b"
},
"suggested_date_start": "2026-10-20T05:55:24.7747506+00:00",
"skill_id": "365782f7-87d9-4247-98d0-1b187372edc9",
"skill_code": "sample string 32",
"skill": {
"id": "3a1e5bd5-1b74-46f2-94b1-8e94ffa281fe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1b76bf7f-330d-4936-ad42-8c409b53f21a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "338ee3fb-60ab-49d1-a537-6cc53f5d2b0d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b982e4df-d492-467f-be6a-831d515971e6",
"db_currency_id": "45d611c7-99b7-467f-80f2-3ec3ba835b99",
"db_language_id": "60c631f5-aeca-4933-b46e-22c5f23d2917",
"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-20T05:55:24.7747506+00:00"
},
"modified_dateutc": "2026-10-20T05:55:24.7747506+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "45b3cba7-bc85-4d49-8f6c-08636ac09701",
"date_reported_by_company": "2026-10-20T05:55:24.7747506+00:00",
"id2": 36,
"company_id": "4858deee-92ea-44d1-bec9-58fa091f69ee",
"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": "c8c2ec11-47c0-4b9f-851c-4078f8e7b890",
"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-20T05:55:24.7747506+00:00"
},
"work_instruction_details_id": "53747ec9-2068-41ce-b8ff-02feb8eb31a4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "03b37e61-33c3-4a8f-a11f-7904b7f16135",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "00258b0e-cc70-490f-87a9-1d0e89ab58f3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-20T05:55:24.7747506+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": "36614246-c863-459b-ab48-ac9021997a29",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-20T05:55:24.7747506+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.