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": "2aa9ce09-c5e6-4afc-a15d-052a781a4ea4",
"jobs_id": "e30d59fb-5b62-4949-b3a7-0a17063b1475",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ddcc3a0a-5e94-4e5b-81f4-c7792033a06e",
"_parent_id": "e410238f-62bb-42b9-b659-67d61e18e5f1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fb135377-208f-484e-a3dd-9ca9707a535d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "41c334cb-948c-4f45-a2a3-ccc751f0be9d",
"_parent_id": "ba913923-2d57-4f8c-8e46-3ac5718b8206",
"root_parent_id": "e205b927-c9e4-4cf4-8df8-23d5e8946bd8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "18e3cd55-8267-432e-93af-2b0995bf2a1d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c40dad40-24f9-4918-b88f-a0ac618a5a90",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ab936a98-7939-4ae8-ba53-ff8c34b4ce34",
"_parent_code": "sample string 6",
"sales_organization_id": "d003c6f0-b172-4cf8-8197-bf402b961e0d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "df92331c-5abc-47b3-9fcb-16786115c416",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d668575f-2222-42d0-99a5-2c783f9eed92",
"db_currency_id": "1320d64b-0866-4bc2-bb7a-7a1bd4066071",
"db_language_id": "4363260e-439f-4103-8de5-837bf3fe9b7a",
"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-08T10:31:17.2503134+00:00"
},
"modified_dateutc": "2026-10-08T10:31:17.2503134+00:00"
},
"equipment_model_id": "0912393f-91c5-4f22-994d-ac0c8423dec1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3aafd9a8-476c-4f99-961a-1592fcb29a71",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "065c0651-6cf8-471c-a233-ef369e745bd4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3b007ec1-515f-4d3d-b032-f02419e361d1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1c3fd87c-3e96-4f10-83b2-68848480c99e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "df92331c-5abc-47b3-9fcb-16786115c416",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d668575f-2222-42d0-99a5-2c783f9eed92",
"db_currency_id": "1320d64b-0866-4bc2-bb7a-7a1bd4066071",
"db_language_id": "4363260e-439f-4103-8de5-837bf3fe9b7a",
"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-08T10:31:17.2503134+00:00"
},
"modified_dateutc": "2026-10-08T10:31:17.2503134+00:00"
},
"equipment_family_id": "15b75e28-8aa6-446b-a31f-5d9f82ab49d6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c40dad40-24f9-4918-b88f-a0ac618a5a90",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ab936a98-7939-4ae8-ba53-ff8c34b4ce34",
"_parent_code": "sample string 6",
"sales_organization_id": "d003c6f0-b172-4cf8-8197-bf402b961e0d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "df92331c-5abc-47b3-9fcb-16786115c416",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d668575f-2222-42d0-99a5-2c783f9eed92",
"db_currency_id": "1320d64b-0866-4bc2-bb7a-7a1bd4066071",
"db_language_id": "4363260e-439f-4103-8de5-837bf3fe9b7a",
"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-08T10:31:17.2503134+00:00"
},
"modified_dateutc": "2026-10-08T10:31:17.2503134+00:00"
},
"date_in_production_since": "2026-10-08T10:31:17.2503134+00:00",
"date_out_of_production_since": "2026-10-08T10:31:17.2503134+00:00",
"date_end_support": "2026-10-08T10:31:17.2503134+00:00",
"sales_organization_id": "33a3efa3-d88d-45ef-b806-4155158bd793",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "df92331c-5abc-47b3-9fcb-16786115c416",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d668575f-2222-42d0-99a5-2c783f9eed92",
"db_currency_id": "1320d64b-0866-4bc2-bb7a-7a1bd4066071",
"db_language_id": "4363260e-439f-4103-8de5-837bf3fe9b7a",
"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-08T10:31:17.2503134+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-08T10:31:17.2503134+00:00"
},
"project_status_id": "6b46cbe3-6e34-41e2-8d3e-15443ca4dbac",
"project_status_code": "sample string 10",
"project_status": {
"id": "6d0ff420-fe8c-4a71-9627-a88b1e03284f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6d9f2dfe-b475-4ea3-bc47-8e754401f375",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "df92331c-5abc-47b3-9fcb-16786115c416",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d668575f-2222-42d0-99a5-2c783f9eed92",
"db_currency_id": "1320d64b-0866-4bc2-bb7a-7a1bd4066071",
"db_language_id": "4363260e-439f-4103-8de5-837bf3fe9b7a",
"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-08T10:31:17.2503134+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T10:31:17.2503134+00:00"
},
"company_id": "01357953-7d51-436c-bd05-580fabc9d6d1",
"company_code": "sample string 12",
"db_address_id": "595d7d5d-d95b-4590-8ac1-e7d226401399",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "38ef3bb3-ee51-4908-95a3-8efc87ed078b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "98b4ae72-b8e7-4bbe-b9ab-a50adad9d535",
"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-08T10:31:17.2503134+00:00",
"date_create": "2026-10-08T10:31:17.2503134+00:00",
"date_update": "2026-10-08T10:31:17.2503134+00:00",
"updated_by_user_id": "9ca16a9d-fecd-43db-9b82-13732882c205",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-08T10:31:17.2503134+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-08T10:31:17.2503134+00:00",
"date_last_job": "2026-10-08T10:31:17.2503134+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-08T10:31:17.2503134+00:00",
"modified_dateutc": "2026-10-08T10:31:17.2503134+00:00",
"is_mobile_installation": true
},
"job_type_id": "fec2ebb6-1bef-4811-9962-97172a70731a",
"job_type_code": "sample string 7",
"job_type": {
"id": "761ccd1a-53aa-4083-9e6f-56c31530ceac",
"name": "sample string 2",
"sales_organization_id": "f2c7acb5-3568-4c6e-8a26-89e8021c9ee3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-08T10:31:17.2503134+00:00",
"code": "sample string 7"
},
"job_priority_id": "99b1545f-4fcb-4419-bcb9-54ce62f25268",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f257122d-8336-4f04-896b-5dc81002dd88",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0142b28d-2118-4d2e-a348-4f585b3c4a0c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "df92331c-5abc-47b3-9fcb-16786115c416",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d668575f-2222-42d0-99a5-2c783f9eed92",
"db_currency_id": "1320d64b-0866-4bc2-bb7a-7a1bd4066071",
"db_language_id": "4363260e-439f-4103-8de5-837bf3fe9b7a",
"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-08T10:31:17.2503134+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T10:31:17.2503134+00:00"
},
"job_status_id": "56e19de1-2af6-4469-b05b-39d4a87b483b",
"job_status_code": "sample string 11",
"db_address_id": "342f262b-f7b2-4344-adf2-4a9cbcb5e430",
"contact_id": "608c9513-bb05-44ca-a845-8600c4a9d5a7",
"requested_by_company_id": "0b50636d-9ae5-4d94-aa87-ccfe165ab83c",
"requested_by_contact_id": "1d2d458f-4058-4cc6-af15-e0adb633e232",
"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-08T10:31:17.2503134+00:00",
"due_date": "2026-10-08T10:31:17.2503134+00:00",
"date_create": "2026-10-08T10:31:17.2503134+00:00",
"date_update": "2026-10-08T10:31:17.2503134+00:00",
"date_closed": "2026-10-08T10:31:17.2503134+00:00",
"suggested_user_id": "62dd72ee-420a-4bbf-b4e9-2a8ff1c59e83",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d48afef2-7211-436a-87c2-67799f7ad8de",
"db_language_id": "e7f3fab3-8899-47ee-80d2-a9231a775b0a",
"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-08T10:31:17.2503134+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c5676276-2bbd-478e-b319-df979e3c1223",
"sales_organization": {
"id": "df92331c-5abc-47b3-9fcb-16786115c416",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d668575f-2222-42d0-99a5-2c783f9eed92",
"db_currency_id": "1320d64b-0866-4bc2-bb7a-7a1bd4066071",
"db_language_id": "4363260e-439f-4103-8de5-837bf3fe9b7a",
"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-08T10:31:17.2503134+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0f0e439d-467d-45f9-96e8-5c9727b1b426",
"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": "dab2cc07-640d-4fd1-9d09-3ebf81465565",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-08T10:31:17.2503134+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8cb1c9a3-d2f5-40bc-92c3-1137be82a1cc"
},
"suggested_date_start": "2026-10-08T10:31:17.2503134+00:00",
"skill_id": "3b3838b1-323e-409e-9cfd-da5d72f31c26",
"skill_code": "sample string 32",
"skill": {
"id": "afbedaff-84b2-4273-99ed-64cd82b9bad9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e5be59b7-5424-47e5-9bb8-0104ccbbe140",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "df92331c-5abc-47b3-9fcb-16786115c416",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d668575f-2222-42d0-99a5-2c783f9eed92",
"db_currency_id": "1320d64b-0866-4bc2-bb7a-7a1bd4066071",
"db_language_id": "4363260e-439f-4103-8de5-837bf3fe9b7a",
"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-08T10:31:17.2503134+00:00"
},
"modified_dateutc": "2026-10-08T10:31:17.2503134+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4b6eb31f-6c73-4cd0-bc5e-bbe90f3b3dc8",
"date_reported_by_company": "2026-10-08T10:31:17.2503134+00:00",
"id2": 36,
"company_id": "4ca93800-58d0-4944-a204-49aaed4a4c74",
"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": "4ee9598c-566f-4f42-8902-50865447b634",
"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-08T10:31:17.2503134+00:00"
},
"work_instruction_details_id": "f7a197f8-391d-4175-869e-cb387317d6d7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b0f35c19-dd7c-4286-9135-62a941c349f9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a3fff495-5344-4dc3-a6dd-235e63f5e06f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-08T10:31:17.2690069+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": "4f2812e5-529c-4f40-8217-fc4fb88df583",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-08T10:31:17.2690069+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.