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": "cd33e551-3972-4949-b7e7-83718c7b7a81",
"jobs_id": "3eec4a11-882e-4419-8cb1-633af4a254ca",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bfa2d1fa-4428-4707-8601-ebbb1ee28491",
"_parent_id": "3d6ca761-3600-4059-9fab-a35610775c93",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bdf530fd-4bce-4f0c-82d5-38b486f768c5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e181418a-cab4-4dd8-9294-3785d0a65168",
"_parent_id": "9c94aaa5-2b63-48de-9ab6-8cb747cdd683",
"root_parent_id": "6651188e-09d9-47c9-9d49-e0a81d6a98e7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b9e70aaa-d871-4a52-9e1f-f71dc994cd31",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "dae0f7ab-2ddb-41a5-83df-43a899e6f685",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "191f6f11-aedb-4cc1-b7d6-d5822ac9b895",
"_parent_code": "sample string 6",
"sales_organization_id": "522aeb0c-cc33-40e3-88ec-9f29912c1048",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fa8eee52-6c61-4186-b869-43e87669d295",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "294e38cb-b447-45d8-8c83-17ca97255779",
"db_currency_id": "2f52ebda-7b40-497e-bbde-f067045cd16c",
"db_language_id": "224f811f-1061-4316-991d-424718a94103",
"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-02-26T10:00:48.9333413+00:00"
},
"modified_dateutc": "2026-02-26T10:00:48.9333413+00:00"
},
"equipment_model_id": "4ad114c3-70e5-4cc7-8fee-99ac42238561",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a91ff11c-461b-4c76-bdf4-dd8b10c8a7bb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2a01ea4f-fa8d-443d-9df1-44983ac2977d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c00e084e-d974-49ac-9a68-0fb7fbb21042",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f2b19a61-771f-4624-9ebc-90a5f361979f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fa8eee52-6c61-4186-b869-43e87669d295",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "294e38cb-b447-45d8-8c83-17ca97255779",
"db_currency_id": "2f52ebda-7b40-497e-bbde-f067045cd16c",
"db_language_id": "224f811f-1061-4316-991d-424718a94103",
"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-02-26T10:00:48.9333413+00:00"
},
"modified_dateutc": "2026-02-26T10:00:48.9333413+00:00"
},
"equipment_family_id": "f016dad8-01f3-466c-becc-29d2122f45ea",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "dae0f7ab-2ddb-41a5-83df-43a899e6f685",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "191f6f11-aedb-4cc1-b7d6-d5822ac9b895",
"_parent_code": "sample string 6",
"sales_organization_id": "522aeb0c-cc33-40e3-88ec-9f29912c1048",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fa8eee52-6c61-4186-b869-43e87669d295",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "294e38cb-b447-45d8-8c83-17ca97255779",
"db_currency_id": "2f52ebda-7b40-497e-bbde-f067045cd16c",
"db_language_id": "224f811f-1061-4316-991d-424718a94103",
"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-02-26T10:00:48.9333413+00:00"
},
"modified_dateutc": "2026-02-26T10:00:48.9333413+00:00"
},
"date_in_production_since": "2026-02-26T10:00:48.9333413+00:00",
"date_out_of_production_since": "2026-02-26T10:00:48.9333413+00:00",
"date_end_support": "2026-02-26T10:00:48.9333413+00:00",
"sales_organization_id": "6f62b0e8-c64f-4e86-aeaf-1a1e8a98ec29",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fa8eee52-6c61-4186-b869-43e87669d295",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "294e38cb-b447-45d8-8c83-17ca97255779",
"db_currency_id": "2f52ebda-7b40-497e-bbde-f067045cd16c",
"db_language_id": "224f811f-1061-4316-991d-424718a94103",
"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-02-26T10:00:48.9333413+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-02-26T10:00:48.9333413+00:00"
},
"project_status_id": "4658dfc8-8c31-4ea5-b04d-4b497be2d62e",
"project_status_code": "sample string 10",
"project_status": {
"id": "d0d0d53b-781b-4306-9074-bfc1ed8a2441",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d4d5e755-a8e0-4a38-9ee5-15cf9094f4aa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fa8eee52-6c61-4186-b869-43e87669d295",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "294e38cb-b447-45d8-8c83-17ca97255779",
"db_currency_id": "2f52ebda-7b40-497e-bbde-f067045cd16c",
"db_language_id": "224f811f-1061-4316-991d-424718a94103",
"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-02-26T10:00:48.9333413+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-26T10:00:48.9333413+00:00"
},
"company_id": "becca5ef-f398-4d90-9ce7-3cc7e4b36da8",
"company_code": "sample string 12",
"db_address_id": "2d8463ca-b411-481e-8ce6-ee9523ce7472",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "54224939-37e8-4b52-8f20-debf9656ac2b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "538cd7d9-8a0b-4a8c-82f7-7e5d9b4880f4",
"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-02-26T10:00:48.9333413+00:00",
"date_create": "2026-02-26T10:00:48.9333413+00:00",
"date_update": "2026-02-26T10:00:48.9333413+00:00",
"updated_by_user_id": "5b2f3be2-eb11-4f35-b502-b289ef2906fb",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-26T10:00:48.9333413+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-02-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-26T10:00:48.9333413+00:00",
"date_last_job": "2026-02-26T10:00:48.9333413+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-26T10:00:48.9333413+00:00",
"modified_dateutc": "2026-02-26T10:00:48.9333413+00:00",
"is_mobile_installation": true
},
"job_type_id": "b338a116-83c8-4352-9e5b-450521722f12",
"job_type_code": "sample string 7",
"job_type": {
"id": "165a7a14-7448-4f22-aab3-e71212c790fb",
"name": "sample string 2",
"sales_organization_id": "0e17bd32-4605-4197-9f34-cff1a613ba3e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-26T10:00:48.9333413+00:00",
"code": "sample string 7"
},
"job_priority_id": "a3621b57-44de-4001-8032-257bf5b4de56",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "269dd7e9-90f4-4c33-b490-1d50c2770198",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1720c5d1-e74f-47c8-94c0-a93a1367dc5b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fa8eee52-6c61-4186-b869-43e87669d295",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "294e38cb-b447-45d8-8c83-17ca97255779",
"db_currency_id": "2f52ebda-7b40-497e-bbde-f067045cd16c",
"db_language_id": "224f811f-1061-4316-991d-424718a94103",
"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-02-26T10:00:48.9333413+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-26T10:00:48.9333413+00:00"
},
"job_status_id": "3b2557bc-c019-4ee8-b8e3-7d58003742bd",
"job_status_code": "sample string 11",
"db_address_id": "95cb14fb-c1ed-4ecd-80f6-5c2e251d702b",
"contact_id": "dd244066-b112-469d-a494-8f4389201e14",
"requested_by_company_id": "f61d9378-126a-4f6a-bc1c-6e9c96b12776",
"requested_by_contact_id": "d5e56fee-9f06-46c7-bf79-30a77f84f578",
"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-02-26T10:00:48.9333413+00:00",
"due_date": "2026-02-26T10:00:48.9333413+00:00",
"date_create": "2026-02-26T10:00:48.9333413+00:00",
"date_update": "2026-02-26T10:00:48.9333413+00:00",
"date_closed": "2026-02-26T10:00:48.9333413+00:00",
"suggested_user_id": "b306c136-01e6-4d67-ac09-8efaf311c6bf",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d53ae28e-ef0f-48d2-a4d5-6ff46b9e787b",
"db_language_id": "0213f51a-a219-4079-ae37-4578fa75e955",
"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-02-26T10:00:48.9333413+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "703c3d2e-2f66-4523-9aa7-cd84d14913a2",
"sales_organization": {
"id": "fa8eee52-6c61-4186-b869-43e87669d295",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "294e38cb-b447-45d8-8c83-17ca97255779",
"db_currency_id": "2f52ebda-7b40-497e-bbde-f067045cd16c",
"db_language_id": "224f811f-1061-4316-991d-424718a94103",
"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-02-26T10:00:48.9333413+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6c783901-8075-41ab-90c4-0c282944e5d7",
"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": "4b2a78e5-7b8f-4920-807d-5fa00264b3ff",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-26T10:00:48.9333413+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "08e2a9cf-07cf-43ae-9128-dc90b1c2195d"
},
"suggested_date_start": "2026-02-26T10:00:48.9333413+00:00",
"skill_id": "2a32586e-3a12-450b-9366-70e0c2e00c4b",
"skill_code": "sample string 32",
"skill": {
"id": "a5b2b275-f479-4741-a72c-e506f5b522dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2ec28182-d1aa-4d7e-9198-d219283842b4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fa8eee52-6c61-4186-b869-43e87669d295",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "294e38cb-b447-45d8-8c83-17ca97255779",
"db_currency_id": "2f52ebda-7b40-497e-bbde-f067045cd16c",
"db_language_id": "224f811f-1061-4316-991d-424718a94103",
"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-02-26T10:00:48.9333413+00:00"
},
"modified_dateutc": "2026-02-26T10:00:48.9333413+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7a475135-91d3-4561-8c86-374fab2b1c06",
"date_reported_by_company": "2026-02-26T10:00:48.9333413+00:00",
"id2": 36,
"company_id": "8118d143-6029-4c63-be63-54bde532804f",
"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": "28ba17f0-7518-4f57-b10c-5e4e0cdf180b",
"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-02-26T10:00:48.9333413+00:00"
},
"work_instruction_details_id": "0b7e473a-17b9-4687-b55a-261a24b733e8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9bfd907d-01cf-4834-9dde-6f01278ae6cb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dfe4b843-f3bc-4732-ae43-c65d2aec5600",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-26T10:00:48.9333413+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": "2ef2bf4a-4335-4985-b62c-b9ba1591095b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-26T10:00:48.9333413+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.