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": "f12dfe29-bdaf-4c1b-880b-f1a0620bb3db",
"jobs_id": "8084f3a1-de74-4935-99aa-4e21f371a06d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "51efba63-fff9-49d1-8012-6a9ef6a80c9f",
"_parent_id": "66de1585-41c7-46bb-8024-1437d61ef3d5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "21ba2705-9d5a-483d-88aa-b9ca44e433a4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ce72038e-9dbb-407e-8d8f-d1d2dd058953",
"_parent_id": "747068a1-6e37-44d4-bd4a-897ee08f1217",
"root_parent_id": "0c531cc3-bfb4-4208-8182-b13aa61c1670",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0a089620-aa18-4e0a-9518-01d9dce66d25",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9ae4385b-c729-45da-a869-edc3b04273db",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a22167de-8195-4949-a14c-b1e32afc725c",
"_parent_code": "sample string 6",
"sales_organization_id": "c9413ae7-3c16-4e10-9499-4571a5308ddd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5a14bd54-071a-4497-9ef0-b9d060ad64d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b6e7f1f-8d90-498f-9d15-f4909d1cd02f",
"db_currency_id": "3ffe6ab2-5517-4e61-a6f9-6c2d74e99227",
"db_language_id": "2ac78374-eff1-42b4-8e84-57f3c66d5874",
"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": "2025-03-28T13:20:38.0188719+00:00"
},
"modified_dateutc": "2025-03-28T13:20:38.0188719+00:00"
},
"equipment_model_id": "37ddeb0e-c7bd-4237-8cd8-79510bb74309",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6b19dd06-9dce-4f6f-a813-32b1741c0379",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "236efa8d-f702-4aef-8c98-7e7a3a67dffd",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2e580ca2-f139-47ef-8ee5-0fff4c029d9f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a909a45b-9fe1-4a99-84dc-0d4b209d2259",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5a14bd54-071a-4497-9ef0-b9d060ad64d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b6e7f1f-8d90-498f-9d15-f4909d1cd02f",
"db_currency_id": "3ffe6ab2-5517-4e61-a6f9-6c2d74e99227",
"db_language_id": "2ac78374-eff1-42b4-8e84-57f3c66d5874",
"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": "2025-03-28T13:20:38.0188719+00:00"
},
"modified_dateutc": "2025-03-28T13:20:38.0345432+00:00"
},
"equipment_family_id": "266fb808-0b90-4f25-8568-c8382f6b2e8a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9ae4385b-c729-45da-a869-edc3b04273db",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a22167de-8195-4949-a14c-b1e32afc725c",
"_parent_code": "sample string 6",
"sales_organization_id": "c9413ae7-3c16-4e10-9499-4571a5308ddd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5a14bd54-071a-4497-9ef0-b9d060ad64d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b6e7f1f-8d90-498f-9d15-f4909d1cd02f",
"db_currency_id": "3ffe6ab2-5517-4e61-a6f9-6c2d74e99227",
"db_language_id": "2ac78374-eff1-42b4-8e84-57f3c66d5874",
"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": "2025-03-28T13:20:38.0188719+00:00"
},
"modified_dateutc": "2025-03-28T13:20:38.0188719+00:00"
},
"date_in_production_since": "2025-03-28T13:20:38.0345432+00:00",
"date_out_of_production_since": "2025-03-28T13:20:38.0345432+00:00",
"date_end_support": "2025-03-28T13:20:38.0345432+00:00",
"sales_organization_id": "fbc3580f-b225-4a7f-9aa7-2d4d52c9393e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5a14bd54-071a-4497-9ef0-b9d060ad64d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b6e7f1f-8d90-498f-9d15-f4909d1cd02f",
"db_currency_id": "3ffe6ab2-5517-4e61-a6f9-6c2d74e99227",
"db_language_id": "2ac78374-eff1-42b4-8e84-57f3c66d5874",
"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": "2025-03-28T13:20:38.0188719+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": "2025-03-28T13:20:38.0345432+00:00"
},
"project_status_id": "23a1bed1-5a48-4425-bae4-76c4fa71243b",
"project_status_code": "sample string 10",
"project_status": {
"id": "d40cd188-234f-4c3f-bf3d-38c153b28c7a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9442e907-7aa6-4308-a3a8-2573c0c5c04f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5a14bd54-071a-4497-9ef0-b9d060ad64d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b6e7f1f-8d90-498f-9d15-f4909d1cd02f",
"db_currency_id": "3ffe6ab2-5517-4e61-a6f9-6c2d74e99227",
"db_language_id": "2ac78374-eff1-42b4-8e84-57f3c66d5874",
"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": "2025-03-28T13:20:38.0188719+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-03-28T13:20:38.0345432+00:00"
},
"company_id": "dcd7a68e-c70f-444e-9d52-1517687008bc",
"company_code": "sample string 12",
"db_address_id": "6a2f9583-e83d-42b1-bb9d-53b876358601",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3caeb3eb-6707-4bc7-b37c-4e7f5651de94",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b3b1c4b4-d68b-4782-89bc-74c3ae110501",
"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": "2025-03-28T13:20:38.0345432+00:00",
"date_create": "2025-03-28T13:20:38.0345432+00:00",
"date_update": "2025-03-28T13:20:38.0345432+00:00",
"updated_by_user_id": "b52c1460-22c3-4962-bf14-f0730ea17971",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-03-28T13:20:38.0345432+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": "2025-03-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-03-28T13:20:38.0345432+00:00",
"date_last_job": "2025-03-28T13:20:38.0345432+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-03-28T13:20:38.0345432+00:00",
"modified_dateutc": "2025-03-28T13:20:38.0345432+00:00",
"is_mobile_installation": true
},
"job_type_id": "338c630e-2fc4-47d2-bf0a-045071ad79df",
"job_type_code": "sample string 7",
"job_type": {
"id": "117176cf-f0f2-4dd7-bebe-822791c898b5",
"name": "sample string 2",
"sales_organization_id": "d4f61cef-3e2c-4b97-80b2-354c6ad8de28",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-03-28T13:20:38.0345432+00:00",
"code": "sample string 7"
},
"job_priority_id": "4f3472f7-4f76-41ba-bde1-4601a87f526b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ca146a82-6148-42d9-837b-99e7d0324a60",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "601c8a5b-e85e-4f81-888a-39d9bfacd648",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5a14bd54-071a-4497-9ef0-b9d060ad64d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b6e7f1f-8d90-498f-9d15-f4909d1cd02f",
"db_currency_id": "3ffe6ab2-5517-4e61-a6f9-6c2d74e99227",
"db_language_id": "2ac78374-eff1-42b4-8e84-57f3c66d5874",
"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": "2025-03-28T13:20:38.0188719+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-03-28T13:20:38.0345432+00:00"
},
"job_status_id": "96ac07d8-278a-4e26-a88f-50480097bf43",
"job_status_code": "sample string 11",
"db_address_id": "b1ad2c9b-c7ef-4c17-8bac-79ec24fd4edf",
"contact_id": "7f144bf6-c786-4239-af1f-c2fedd9c9bfb",
"requested_by_company_id": "eecc67c8-d140-40b0-a124-397ba41e57f3",
"requested_by_contact_id": "508066fc-da46-4ce1-8c0e-bb665a6686b9",
"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": "2025-03-28T13:20:38.0345432+00:00",
"due_date": "2025-03-28T13:20:38.0345432+00:00",
"date_create": "2025-03-28T13:20:38.0345432+00:00",
"date_update": "2025-03-28T13:20:38.0345432+00:00",
"date_closed": "2025-03-28T13:20:38.0345432+00:00",
"suggested_user_id": "5be4e3a3-b76b-427d-87ad-ac282f12a69c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f47dbfed-f41b-4f30-984d-5caac1904ca7",
"db_language_id": "07a95d87-ee68-4ed6-9cbb-322d3e99c749",
"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": "2025-03-28T13:20:38.0345432+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3f201f98-7cc9-4503-b05e-0a1fa08f84d4",
"sales_organization": {
"id": "5a14bd54-071a-4497-9ef0-b9d060ad64d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b6e7f1f-8d90-498f-9d15-f4909d1cd02f",
"db_currency_id": "3ffe6ab2-5517-4e61-a6f9-6c2d74e99227",
"db_language_id": "2ac78374-eff1-42b4-8e84-57f3c66d5874",
"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": "2025-03-28T13:20:38.0188719+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "27ad468f-e474-410e-b7c8-931f2776d07f",
"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": "7d5f0b86-fd3e-4687-9708-0948714d3af3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-03-28T13:20:38.0345432+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ec95e642-48ef-4e1f-aef3-5e351188051b"
},
"suggested_date_start": "2025-03-28T13:20:38.0345432+00:00",
"skill_id": "e25e5394-c57d-4536-a2f2-1a82b5185544",
"skill_code": "sample string 32",
"skill": {
"id": "d940d94b-0230-47e6-9297-f23cb9e485be",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "976b491d-35b8-400f-918f-a8e9c483407e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5a14bd54-071a-4497-9ef0-b9d060ad64d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b6e7f1f-8d90-498f-9d15-f4909d1cd02f",
"db_currency_id": "3ffe6ab2-5517-4e61-a6f9-6c2d74e99227",
"db_language_id": "2ac78374-eff1-42b4-8e84-57f3c66d5874",
"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": "2025-03-28T13:20:38.0188719+00:00"
},
"modified_dateutc": "2025-03-28T13:20:38.0345432+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "33d2f097-13e1-4134-ad19-e2ac830d883e",
"date_reported_by_company": "2025-03-28T13:20:38.0345432+00:00",
"id2": 36,
"company_id": "81b79342-a004-4e52-80b8-5df347c98857",
"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": "700082b0-1411-4d84-bd1a-5bbc281005f5",
"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": "2025-03-28T13:20:38.0345432+00:00"
},
"work_instruction_details_id": "ed348df3-7484-46a8-ba04-a70d4e8d6688",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "71614820-d9a5-4d4e-b1c9-e93caf86316f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cd31df55-ddd3-44f8-adaf-556769ab6e4d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-03-28T13:20:38.0345432+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": "9ad532e7-42d7-453b-8e9f-a16360a6dfd4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-03-28T13:20:38.0345432+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.