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": "06297473-17e7-4bb7-afe3-1af730e4d78c",
"jobs_id": "d4fa6593-ecb2-4762-80e4-84e8f00488d6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bc6eb5a0-edfe-414c-a13d-404db57b25f2",
"_parent_id": "d48d6550-ff73-4449-b14d-63ab38fa4e64",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e765fd19-a870-4d6e-8ce0-eb296ade5235",
"project_reference_back_office": "sample string 5",
"project": {
"id": "79c9b700-971f-46e7-a08b-c4af3ee057a0",
"_parent_id": "dae095bf-7a33-4ba4-b663-3587ccfaa645",
"root_parent_id": "daef72bd-0509-4abb-93c5-be28826aef8f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "19b9c486-d4c8-4ebf-8196-ca410be29f6e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "20154472-a42f-49ba-874b-31a9faed1c62",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "677367d4-f433-404f-aade-c42bde0b398a",
"_parent_code": "sample string 6",
"sales_organization_id": "f90a69e1-ac61-469f-89f3-76fb9af739db",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2d022ff4-cd33-48c8-a0e4-6a61b568f47c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b52b1d94-9ca2-4d7e-be58-6511e43948c3",
"db_currency_id": "d2d40491-51e5-417b-bfc8-939832c159ed",
"db_language_id": "5460a261-1598-4b08-b77b-2da4e86e4d92",
"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-11-14T07:33:10.5012574+00:00"
},
"modified_dateutc": "2025-11-14T07:33:10.5012574+00:00"
},
"equipment_model_id": "73968d6a-9106-4742-bd7b-6f1c3fec73d2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9427b2bf-4903-4d44-b9ed-a4fd3ed1dc29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "63ee749a-7c2e-42a2-b3bf-b824230da151",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2eaeab99-f409-4a85-8fef-7f6cfcf2f1ff",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2296a974-f5d0-43a8-9337-94e64db2c785",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2d022ff4-cd33-48c8-a0e4-6a61b568f47c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b52b1d94-9ca2-4d7e-be58-6511e43948c3",
"db_currency_id": "d2d40491-51e5-417b-bfc8-939832c159ed",
"db_language_id": "5460a261-1598-4b08-b77b-2da4e86e4d92",
"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-11-14T07:33:10.5012574+00:00"
},
"modified_dateutc": "2025-11-14T07:33:10.5012574+00:00"
},
"equipment_family_id": "030a3917-b802-46f0-bafa-6c20649d4236",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "20154472-a42f-49ba-874b-31a9faed1c62",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "677367d4-f433-404f-aade-c42bde0b398a",
"_parent_code": "sample string 6",
"sales_organization_id": "f90a69e1-ac61-469f-89f3-76fb9af739db",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2d022ff4-cd33-48c8-a0e4-6a61b568f47c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b52b1d94-9ca2-4d7e-be58-6511e43948c3",
"db_currency_id": "d2d40491-51e5-417b-bfc8-939832c159ed",
"db_language_id": "5460a261-1598-4b08-b77b-2da4e86e4d92",
"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-11-14T07:33:10.5012574+00:00"
},
"modified_dateutc": "2025-11-14T07:33:10.5012574+00:00"
},
"date_in_production_since": "2025-11-14T07:33:10.5012574+00:00",
"date_out_of_production_since": "2025-11-14T07:33:10.5012574+00:00",
"date_end_support": "2025-11-14T07:33:10.5012574+00:00",
"sales_organization_id": "309daeac-7653-4bd7-bd32-4e7402565c25",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2d022ff4-cd33-48c8-a0e4-6a61b568f47c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b52b1d94-9ca2-4d7e-be58-6511e43948c3",
"db_currency_id": "d2d40491-51e5-417b-bfc8-939832c159ed",
"db_language_id": "5460a261-1598-4b08-b77b-2da4e86e4d92",
"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-11-14T07:33:10.5012574+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-11-14T07:33:10.5012574+00:00"
},
"project_status_id": "06f911a4-04b2-4eef-b9fc-fd8aad01e9be",
"project_status_code": "sample string 10",
"project_status": {
"id": "b5d659a2-75aa-4437-b386-12966434aef5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e6c8ca70-2eba-4095-837b-e34ceea25a6c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2d022ff4-cd33-48c8-a0e4-6a61b568f47c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b52b1d94-9ca2-4d7e-be58-6511e43948c3",
"db_currency_id": "d2d40491-51e5-417b-bfc8-939832c159ed",
"db_language_id": "5460a261-1598-4b08-b77b-2da4e86e4d92",
"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-11-14T07:33:10.5012574+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-14T07:33:10.5012574+00:00"
},
"company_id": "6d8b79f0-7596-4a15-acc1-2b72717f3f25",
"company_code": "sample string 12",
"db_address_id": "adbc3af7-8531-4f96-a3ab-df0d3f768359",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "25972ee0-77d7-4462-a484-7412879104a8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2ef7d379-4de4-4af5-a159-47d0e752ca5b",
"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-11-14T07:33:10.5012574+00:00",
"date_create": "2025-11-14T07:33:10.5012574+00:00",
"date_update": "2025-11-14T07:33:10.5012574+00:00",
"updated_by_user_id": "cdab45f5-a203-4324-a6d0-ae548ebe1ccb",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-14T07:33:10.5012574+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-11-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-14T07:33:10.5012574+00:00",
"date_last_job": "2025-11-14T07:33:10.5012574+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-14T07:33:10.5012574+00:00",
"modified_dateutc": "2025-11-14T07:33:10.5012574+00:00",
"is_mobile_installation": true
},
"job_type_id": "22acfd9f-373c-4c24-80c7-ebe8ebd36d12",
"job_type_code": "sample string 7",
"job_type": {
"id": "c19ecf18-0fec-471e-b63d-f4f6612efeb4",
"name": "sample string 2",
"sales_organization_id": "3a119fb7-7bbc-43c6-979c-313e18f845ef",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-14T07:33:10.5012574+00:00",
"code": "sample string 7"
},
"job_priority_id": "2058a074-83e5-43a3-8ed0-0845637a12bc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b6fce9d6-f2ed-4d30-b53e-9aae8ed2d132",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "af04398a-32ee-4993-b531-46dca5da4720",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2d022ff4-cd33-48c8-a0e4-6a61b568f47c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b52b1d94-9ca2-4d7e-be58-6511e43948c3",
"db_currency_id": "d2d40491-51e5-417b-bfc8-939832c159ed",
"db_language_id": "5460a261-1598-4b08-b77b-2da4e86e4d92",
"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-11-14T07:33:10.5012574+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-14T07:33:10.5012574+00:00"
},
"job_status_id": "2985dfa7-94a1-4c99-9996-4ffa2e84647e",
"job_status_code": "sample string 11",
"db_address_id": "b4531022-22da-4057-88f6-0fa39d8b5b47",
"contact_id": "3eecc0d4-c2ec-43be-99b4-51509eccea04",
"requested_by_company_id": "4fa330fc-96dd-48ed-a52b-bcc4efbd4025",
"requested_by_contact_id": "70f6fb47-90eb-439b-99e8-0407ff56251d",
"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-11-14T07:33:10.5012574+00:00",
"due_date": "2025-11-14T07:33:10.5012574+00:00",
"date_create": "2025-11-14T07:33:10.5012574+00:00",
"date_update": "2025-11-14T07:33:10.5012574+00:00",
"date_closed": "2025-11-14T07:33:10.5012574+00:00",
"suggested_user_id": "bfd88dc0-11a8-4de2-98c5-9a7d47bc966d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "31d0f29a-ffb2-4d0a-9caf-3bab4feca3cb",
"db_language_id": "97c6437a-35d3-4a93-86bf-19f03515186e",
"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-11-14T07:33:10.5012574+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a79135bd-7b27-4575-acbb-50724500445b",
"sales_organization": {
"id": "2d022ff4-cd33-48c8-a0e4-6a61b568f47c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b52b1d94-9ca2-4d7e-be58-6511e43948c3",
"db_currency_id": "d2d40491-51e5-417b-bfc8-939832c159ed",
"db_language_id": "5460a261-1598-4b08-b77b-2da4e86e4d92",
"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-11-14T07:33:10.5012574+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ff60a9c4-1eae-47ca-a005-f7588bf6506e",
"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": "05b5c162-87b8-437c-a4d9-e62548a4d860",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-14T07:33:10.5012574+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fefc70ef-c104-42c3-9cdb-9b88a121ba27"
},
"suggested_date_start": "2025-11-14T07:33:10.5012574+00:00",
"skill_id": "2b82646f-2774-4e2c-a82f-f96c5ef7656a",
"skill_code": "sample string 32",
"skill": {
"id": "fa453474-b16c-4d1b-8b52-5362ebcb550b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7f9b34ce-a70c-4ef5-8730-b15b99eea5d3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2d022ff4-cd33-48c8-a0e4-6a61b568f47c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b52b1d94-9ca2-4d7e-be58-6511e43948c3",
"db_currency_id": "d2d40491-51e5-417b-bfc8-939832c159ed",
"db_language_id": "5460a261-1598-4b08-b77b-2da4e86e4d92",
"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-11-14T07:33:10.5012574+00:00"
},
"modified_dateutc": "2025-11-14T07:33:10.5012574+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0da1a182-59d1-48de-b08c-7f092278dfc5",
"date_reported_by_company": "2025-11-14T07:33:10.5012574+00:00",
"id2": 36,
"company_id": "20c7f3fc-438f-4f62-963b-70a67682b2b0",
"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": "399272c4-9200-4ef5-8b30-463c63fbb4ac",
"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-11-14T07:33:10.5012574+00:00"
},
"work_instruction_details_id": "6b6e2c51-306f-402b-81d2-61c407b7597d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5f138983-f2d4-4f86-8820-8d35f0175be8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c36f2c20-5b6a-4de9-9dd7-e559020abca2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-14T07:33:10.5012574+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": "6ea3c4c5-3072-49dd-8bc2-25b0b2db9097",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-14T07:33:10.5012574+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.