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": "262d8ddd-0c10-4fa4-8556-42de27111005",
"jobs_id": "71024fc3-7537-48fe-a7df-1e3f34fe74d1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "767009f0-057a-431b-a727-0ba2a259264d",
"_parent_id": "ac3141da-5318-471b-8a5b-dc4c2292396d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cb3d47d7-315f-4e69-8e25-2dca292704fc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d0adebe7-9a1a-4358-96ec-d758f7c3d442",
"_parent_id": "bc4c4961-c120-4529-9dd0-574d873597d9",
"root_parent_id": "7ec7a4c4-d6a6-4731-a5ca-e2a5005b0035",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cab27314-3ba6-4235-8ac1-533d16cdfe78",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "69cba911-b49a-4f24-a527-96bfb2d166d7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6910961e-535c-4e06-b816-a3ba33a036a4",
"_parent_code": "sample string 6",
"sales_organization_id": "2e348b1b-5f1f-45fa-a299-42163aa34e4c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c76a7742-b2fa-402e-b92a-6238ed0e00b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34023562-144c-48ad-a49d-ee1d10e2d281",
"db_currency_id": "9e9ba9a7-920f-4bef-8e00-ae6183baa71c",
"db_language_id": "e0170e99-b946-459f-91f5-129f4a5aba7a",
"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-01-11T16:23:23.9804129+00:00"
},
"modified_dateutc": "2026-01-11T16:23:23.9804129+00:00"
},
"equipment_model_id": "1280cf48-4376-4895-91d0-1d01c0b80c6c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "481f1909-6596-4bf5-a859-f4e1e996be67",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "31129008-b221-4ff2-aa3d-6e14b17147b3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e9ee9e33-7089-4cd4-9a7c-37bfa7af05cf",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "74f33053-cafe-4399-a21e-78e1a27dec08",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c76a7742-b2fa-402e-b92a-6238ed0e00b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34023562-144c-48ad-a49d-ee1d10e2d281",
"db_currency_id": "9e9ba9a7-920f-4bef-8e00-ae6183baa71c",
"db_language_id": "e0170e99-b946-459f-91f5-129f4a5aba7a",
"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-01-11T16:23:23.9804129+00:00"
},
"modified_dateutc": "2026-01-11T16:23:23.9804129+00:00"
},
"equipment_family_id": "36ea5333-8a62-4ea0-96de-c94b0b7d0ca6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "69cba911-b49a-4f24-a527-96bfb2d166d7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6910961e-535c-4e06-b816-a3ba33a036a4",
"_parent_code": "sample string 6",
"sales_organization_id": "2e348b1b-5f1f-45fa-a299-42163aa34e4c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c76a7742-b2fa-402e-b92a-6238ed0e00b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34023562-144c-48ad-a49d-ee1d10e2d281",
"db_currency_id": "9e9ba9a7-920f-4bef-8e00-ae6183baa71c",
"db_language_id": "e0170e99-b946-459f-91f5-129f4a5aba7a",
"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-01-11T16:23:23.9804129+00:00"
},
"modified_dateutc": "2026-01-11T16:23:23.9804129+00:00"
},
"date_in_production_since": "2026-01-11T16:23:23.9804129+00:00",
"date_out_of_production_since": "2026-01-11T16:23:23.9804129+00:00",
"date_end_support": "2026-01-11T16:23:23.9804129+00:00",
"sales_organization_id": "1813d73e-43c7-4372-9ec1-34421c5e1dae",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c76a7742-b2fa-402e-b92a-6238ed0e00b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34023562-144c-48ad-a49d-ee1d10e2d281",
"db_currency_id": "9e9ba9a7-920f-4bef-8e00-ae6183baa71c",
"db_language_id": "e0170e99-b946-459f-91f5-129f4a5aba7a",
"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-01-11T16:23:23.9804129+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-01-11T16:23:23.9804129+00:00"
},
"project_status_id": "ffcd9add-331b-4c04-9c38-e022f57cbf3b",
"project_status_code": "sample string 10",
"project_status": {
"id": "8ba5a8ca-f06a-4d0b-9be0-d684698eeeca",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9391ba79-36c4-4eb3-b80c-93a48200ccc9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c76a7742-b2fa-402e-b92a-6238ed0e00b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34023562-144c-48ad-a49d-ee1d10e2d281",
"db_currency_id": "9e9ba9a7-920f-4bef-8e00-ae6183baa71c",
"db_language_id": "e0170e99-b946-459f-91f5-129f4a5aba7a",
"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-01-11T16:23:23.9804129+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-11T16:23:23.9804129+00:00"
},
"company_id": "8bb7f191-576f-4b8c-8493-4057870455ed",
"company_code": "sample string 12",
"db_address_id": "89f2e2bd-ee99-4ce7-9a7b-78292bd84b97",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "56f14e8a-5693-45d7-930b-2ee90636901e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4db32968-1f1c-4dbe-a45d-b72dadfa319e",
"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-01-11T16:23:23.9804129+00:00",
"date_create": "2026-01-11T16:23:23.9804129+00:00",
"date_update": "2026-01-11T16:23:23.9804129+00:00",
"updated_by_user_id": "2fede730-6428-4dd7-8bf0-eb418cd4ae14",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-11T16:23:23.9804129+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-01-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-11T16:23:23.9804129+00:00",
"date_last_job": "2026-01-11T16:23:23.9804129+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-11T16:23:23.9804129+00:00",
"modified_dateutc": "2026-01-11T16:23:23.9804129+00:00",
"is_mobile_installation": true
},
"job_type_id": "2e59679a-b61d-48f6-bb0d-3791095cb9e4",
"job_type_code": "sample string 7",
"job_type": {
"id": "9f1156b5-7f3c-4c07-8ab3-fbc3a70ffe0e",
"name": "sample string 2",
"sales_organization_id": "aede58f8-13a4-454a-b686-5d18150240bc",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-11T16:23:23.9804129+00:00",
"code": "sample string 7"
},
"job_priority_id": "44e005af-88c1-4e4a-b5e4-88a68c2add27",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d1db7079-6d82-4895-9ffe-85ea7b85ae94",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "da84b55f-0e98-4293-9f17-e0e7a348dfbe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c76a7742-b2fa-402e-b92a-6238ed0e00b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34023562-144c-48ad-a49d-ee1d10e2d281",
"db_currency_id": "9e9ba9a7-920f-4bef-8e00-ae6183baa71c",
"db_language_id": "e0170e99-b946-459f-91f5-129f4a5aba7a",
"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-01-11T16:23:23.9804129+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-11T16:23:23.9804129+00:00"
},
"job_status_id": "df9b4ce9-de4b-4885-8f80-e02da8c02daf",
"job_status_code": "sample string 11",
"db_address_id": "0c5adcdf-9662-4250-833f-105a2ad4cd2b",
"contact_id": "ffbcb277-7df1-4f5b-a615-a720cbb25b29",
"requested_by_company_id": "79be46c6-37da-4098-863e-25a355bb3444",
"requested_by_contact_id": "97faa566-c9e1-4800-9de3-a3d72ebb6fe9",
"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-01-11T16:23:23.9804129+00:00",
"due_date": "2026-01-11T16:23:23.9804129+00:00",
"date_create": "2026-01-11T16:23:23.9804129+00:00",
"date_update": "2026-01-11T16:23:23.9804129+00:00",
"date_closed": "2026-01-11T16:23:23.9804129+00:00",
"suggested_user_id": "adf0f58b-95bb-43d1-afdd-98c9c9905b24",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fc45c5ba-cd1d-455b-8e03-601e46efc6a9",
"db_language_id": "c0b7c444-75f8-4fd0-ab2b-81db2614a6f8",
"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-01-11T16:23:23.9804129+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cd11ba5b-03e8-402c-abcd-6acfc8b39ef6",
"sales_organization": {
"id": "c76a7742-b2fa-402e-b92a-6238ed0e00b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34023562-144c-48ad-a49d-ee1d10e2d281",
"db_currency_id": "9e9ba9a7-920f-4bef-8e00-ae6183baa71c",
"db_language_id": "e0170e99-b946-459f-91f5-129f4a5aba7a",
"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-01-11T16:23:23.9804129+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "09d09955-b538-4377-9e45-ba60ef4aeb88",
"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": "37b166dd-fd87-494c-8d31-2a4597fc1ff1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-11T16:23:23.9804129+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "18285a14-466f-4a01-a409-735467d727b8"
},
"suggested_date_start": "2026-01-11T16:23:23.9804129+00:00",
"skill_id": "e06a1d37-b726-4083-8af0-2a8564a4ba6a",
"skill_code": "sample string 32",
"skill": {
"id": "ac096360-8ea1-42d9-bc2f-2eac1c41c8dc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "485d9e32-00f3-4844-81ed-70c0a6262b98",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c76a7742-b2fa-402e-b92a-6238ed0e00b1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "34023562-144c-48ad-a49d-ee1d10e2d281",
"db_currency_id": "9e9ba9a7-920f-4bef-8e00-ae6183baa71c",
"db_language_id": "e0170e99-b946-459f-91f5-129f4a5aba7a",
"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-01-11T16:23:23.9804129+00:00"
},
"modified_dateutc": "2026-01-11T16:23:23.9804129+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b4c655f5-78d6-4530-a2eb-753fa8e355ad",
"date_reported_by_company": "2026-01-11T16:23:23.9804129+00:00",
"id2": 36,
"company_id": "eba4e44b-0915-4d55-933a-b5881f859e6b",
"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": "482a646a-b8f8-4203-a698-3e3b99f698b4",
"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-01-11T16:23:23.9804129+00:00"
},
"work_instruction_details_id": "64f4e5c9-918c-4a04-bd9e-0994eb69903a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7b44e098-26f6-4bb3-bee6-f665a2c6a9cd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "509e526c-beb9-474f-ba45-12c4540ac958",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-11T16:23:23.9804129+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": "40fd3d85-5af9-43ce-8be5-82ecd572af7c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-11T16:23:23.9804129+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.