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": "fce3b8ce-1125-40fc-9c4b-a6ea5a3e711f",
"jobs_id": "4f4ee8c3-5472-48a6-a171-9e15c38b9d9a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "73b881cf-3e43-4480-9f9d-0a69f748bab9",
"_parent_id": "a649f0e4-a8d6-40b5-a229-1407939be4b6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ffe090a7-dc62-4199-8965-3c66f7f9e760",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a718b6ac-1c3e-4ffb-b7ba-59bd962184e5",
"_parent_id": "7e008fb6-c074-4497-9da0-fe5a08236c1b",
"root_parent_id": "561a6a3e-0493-43ec-bd93-380d2b5e21de",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5d5415cb-7140-480e-bd7c-907cef8a54bc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "039b867a-8650-4387-925c-5649a1e2e80c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f8c885db-90e6-484e-a53c-d9c21eda98f5",
"_parent_code": "sample string 6",
"sales_organization_id": "2d1c5df3-912a-48a3-bcc6-f77a987fc5ad",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4afae747-d205-407f-a475-91faffac33c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b78a211c-f529-4725-a168-7d5ba9c37cb1",
"db_currency_id": "db23e1b7-3faf-4838-91b1-4c4fcb1eb9ee",
"db_language_id": "30a29709-5481-4c84-9ef3-72d4fe9e9158",
"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-12-10T10:05:03.9404407+00:00"
},
"modified_dateutc": "2025-12-10T10:05:03.9404407+00:00"
},
"equipment_model_id": "e2ed32de-1e9e-4430-a5b4-b8222938d663",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8bf44f61-c9d9-4e96-9f59-deb07d2dd6c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "541bf9c3-487d-48ad-bc46-feba04a20bfd",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d3b3e369-7607-486a-b908-da04367337b8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "32fa3632-3081-4681-a53b-c2e883cdae53",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4afae747-d205-407f-a475-91faffac33c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b78a211c-f529-4725-a168-7d5ba9c37cb1",
"db_currency_id": "db23e1b7-3faf-4838-91b1-4c4fcb1eb9ee",
"db_language_id": "30a29709-5481-4c84-9ef3-72d4fe9e9158",
"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-12-10T10:05:03.9404407+00:00"
},
"modified_dateutc": "2025-12-10T10:05:03.9404407+00:00"
},
"equipment_family_id": "dbf8d9e3-639b-4505-9a42-6ab1a07f9a49",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "039b867a-8650-4387-925c-5649a1e2e80c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f8c885db-90e6-484e-a53c-d9c21eda98f5",
"_parent_code": "sample string 6",
"sales_organization_id": "2d1c5df3-912a-48a3-bcc6-f77a987fc5ad",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4afae747-d205-407f-a475-91faffac33c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b78a211c-f529-4725-a168-7d5ba9c37cb1",
"db_currency_id": "db23e1b7-3faf-4838-91b1-4c4fcb1eb9ee",
"db_language_id": "30a29709-5481-4c84-9ef3-72d4fe9e9158",
"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-12-10T10:05:03.9404407+00:00"
},
"modified_dateutc": "2025-12-10T10:05:03.9404407+00:00"
},
"date_in_production_since": "2025-12-10T10:05:03.9404407+00:00",
"date_out_of_production_since": "2025-12-10T10:05:03.9404407+00:00",
"date_end_support": "2025-12-10T10:05:03.9404407+00:00",
"sales_organization_id": "51c4582e-75ea-4448-9f6c-c8449e9da80c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4afae747-d205-407f-a475-91faffac33c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b78a211c-f529-4725-a168-7d5ba9c37cb1",
"db_currency_id": "db23e1b7-3faf-4838-91b1-4c4fcb1eb9ee",
"db_language_id": "30a29709-5481-4c84-9ef3-72d4fe9e9158",
"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-12-10T10:05:03.9404407+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-12-10T10:05:03.9404407+00:00"
},
"project_status_id": "31a431ad-6450-41a0-a8db-43d83460f238",
"project_status_code": "sample string 10",
"project_status": {
"id": "2addf623-5789-423b-a4aa-0365515076fa",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f4219a2f-7201-4273-9ff0-78b5a1573ac5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4afae747-d205-407f-a475-91faffac33c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b78a211c-f529-4725-a168-7d5ba9c37cb1",
"db_currency_id": "db23e1b7-3faf-4838-91b1-4c4fcb1eb9ee",
"db_language_id": "30a29709-5481-4c84-9ef3-72d4fe9e9158",
"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-12-10T10:05:03.9404407+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-10T10:05:03.9404407+00:00"
},
"company_id": "d33d3b5f-f3a9-4c9a-8a6f-38e61f04ea60",
"company_code": "sample string 12",
"db_address_id": "f274c163-f5cb-4c1a-8fd1-2293660af456",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "89af4415-3de8-4217-afdf-1eeedc820d0f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f6fe89e5-2667-4b2e-9806-eaa213b02157",
"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-12-10T10:05:03.9404407+00:00",
"date_create": "2025-12-10T10:05:03.9404407+00:00",
"date_update": "2025-12-10T10:05:03.9404407+00:00",
"updated_by_user_id": "01918681-82c7-47ee-b7e4-9378b6e711fa",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-10T10:05:03.9404407+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-12-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-10T10:05:03.9404407+00:00",
"date_last_job": "2025-12-10T10:05:03.9404407+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-10T10:05:03.9404407+00:00",
"modified_dateutc": "2025-12-10T10:05:03.9404407+00:00",
"is_mobile_installation": true
},
"job_type_id": "e3eea738-055f-4d18-a3b2-3e9fa5bfd10a",
"job_type_code": "sample string 7",
"job_type": {
"id": "95b51beb-b680-4513-9507-62618a7166ea",
"name": "sample string 2",
"sales_organization_id": "82c8d03e-1fad-41f0-937d-cfcb26c764c7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-10T10:05:03.9404407+00:00",
"code": "sample string 7"
},
"job_priority_id": "50cf0093-400c-4a7f-8a46-04e9e0c7525a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d6b7f269-73a8-45b6-b2b9-d01521525a64",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d778e05b-7393-4f65-b8c0-776c5901cc83",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4afae747-d205-407f-a475-91faffac33c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b78a211c-f529-4725-a168-7d5ba9c37cb1",
"db_currency_id": "db23e1b7-3faf-4838-91b1-4c4fcb1eb9ee",
"db_language_id": "30a29709-5481-4c84-9ef3-72d4fe9e9158",
"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-12-10T10:05:03.9404407+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-10T10:05:03.9404407+00:00"
},
"job_status_id": "94519ff1-46d9-43a9-a394-4869c339cb0f",
"job_status_code": "sample string 11",
"db_address_id": "00a1d485-119d-4665-8750-9b5222928103",
"contact_id": "d506e00c-4874-43ab-bd35-a7a430397902",
"requested_by_company_id": "f67c320b-f90a-4797-8d5f-bfbf0a73b948",
"requested_by_contact_id": "e7afd63d-5f05-414a-ad2a-794f5a33e094",
"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-12-10T10:05:03.9404407+00:00",
"due_date": "2025-12-10T10:05:03.9404407+00:00",
"date_create": "2025-12-10T10:05:03.9404407+00:00",
"date_update": "2025-12-10T10:05:03.9404407+00:00",
"date_closed": "2025-12-10T10:05:03.9404407+00:00",
"suggested_user_id": "0b85fd88-6a5c-4325-8e00-cb56a0aa9f96",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "21fa1259-e458-4775-a948-53afcd463495",
"db_language_id": "24a6cebf-8ed1-481a-a882-432b4e4aa541",
"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-12-10T10:05:03.9560676+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "203793d0-41a5-4f69-a4dc-336dfec593cb",
"sales_organization": {
"id": "4afae747-d205-407f-a475-91faffac33c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b78a211c-f529-4725-a168-7d5ba9c37cb1",
"db_currency_id": "db23e1b7-3faf-4838-91b1-4c4fcb1eb9ee",
"db_language_id": "30a29709-5481-4c84-9ef3-72d4fe9e9158",
"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-12-10T10:05:03.9404407+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "121c866c-f777-4c04-a5b8-809579d25032",
"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": "33c72d27-0e54-415c-bebf-d7cf7d3cf888",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-10T10:05:03.9560676+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "01ab33ae-a4c2-4c76-80e8-254706265174"
},
"suggested_date_start": "2025-12-10T10:05:03.9560676+00:00",
"skill_id": "87bbcb60-9dcd-4f61-87d4-c22194134050",
"skill_code": "sample string 32",
"skill": {
"id": "656be53b-5404-4214-bb54-66d80f08ff17",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "56d0fa80-f349-4dcf-ae6e-5f2bca579e3a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4afae747-d205-407f-a475-91faffac33c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b78a211c-f529-4725-a168-7d5ba9c37cb1",
"db_currency_id": "db23e1b7-3faf-4838-91b1-4c4fcb1eb9ee",
"db_language_id": "30a29709-5481-4c84-9ef3-72d4fe9e9158",
"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-12-10T10:05:03.9404407+00:00"
},
"modified_dateutc": "2025-12-10T10:05:03.9560676+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f5b4de3f-e0e3-4e19-b0b8-2b1788ca908f",
"date_reported_by_company": "2025-12-10T10:05:03.9560676+00:00",
"id2": 36,
"company_id": "d6d27cda-c896-4c75-b308-21dfb672d69e",
"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": "2b36af88-b779-4dc5-b10a-9cd2d57375bc",
"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-12-10T10:05:03.9560676+00:00"
},
"work_instruction_details_id": "7d86d649-cd5d-4cdb-a204-26b0ae4b167a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8644b823-4798-436e-9a0a-c5f75bdfc480",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "299a4166-126f-4207-a054-bea52e9ae261",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-10T10:05:03.9560676+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": "767f2667-e63f-446d-9152-e10a3684643d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-10T10:05:03.9560676+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.